You are viewing a potentially older version of this package. View all versions.
WordPlay-CustomDictionaryLoader-1.1.0 icon

CustomDictionaryLoader

A library for adding new valid words by loading custom dictionaries.

Date uploaded a year ago
Version 1.1.0
Download link WordPlay-CustomDictionaryLoader-1.1.0.zip
Downloads 180
Dependency string WordPlay-CustomDictionaryLoader-1.1.0

This mod requires the following mods to function

BepInEx-BepInExPack-5.4.2100 icon
BepInEx-BepInExPack

BepInEx pack for Mono Unity games. Preconfigured and ready to use.

Preferred version: 5.4.2100

README

CustomDictionaryLoader

This mod is a library that loads custom dictionaries, which will add new words to the valid word list.

Configuration

After launching the game once with the mod installed, a config file will be generated. Config settings include:

  • Overwrite Vanilla Dictionary: If true, custom dictionaries will overwrite the vanilla dictionary instead of adding words to it.
  • Load Dictionary from AppData folder: If true, a customdictionary.txt file in Word Play's AppData folder will be loaded if it exists.
  • Manual Custom Words: Comma-separated list of words to add to the valid word list.

Creating a Custom Dictionary

Any .txt file in a folder named CustomDictionary in your BepInEx/plugins folder is loaded as a custom dictionary. Each line is considered a new word.

You can also add words via a comma-separated list in WordPlay.CustomDictionaryLoader.cfg's Manual Custom Words config setting.

If you plan on uploading your custom dictionary to Thunderstore, I recommend downloading and modifying this template, and make sure you change the README.md, manifest.json, and icon.png files!

Credits

Programming by 753.

https://753.network/

CHANGELOG

v1.1.0 Manual Custom Words Config

  • Add a config option to allow users to manually add custom words (which will be synced by profiles)

v1.0.1 Fixes

  • Add a link to a template in the README
  • Fix typos

v1.0.0 Release

  • Loads custom dictionaries
  • Config options for overwriting the original word list and loading a dictionary from the AppData path