|
1 | | -Edit README.md in root, contents will be replaced. |
| 1 | +# Unity Simple Spell Check |
| 2 | + |
| 3 | +Unity simple spell check provides a fast and easy way to evaluate text in your game for basic spelling errors. It uses a [local dictionary](https://github.com/dwyl/english-words) and allows for advanced configuration. |
| 4 | + |
| 5 | +## Features |
| 6 | + |
| 7 | +### Usage with text area attributes |
| 8 | + |
| 9 | + |
| 10 | + |
| 11 | +This will create a simple spell check button that evaluates a custom text area. If you need some basic spell checking for items or large blocks of text this should help. |
| 12 | + |
| 13 | +```c# |
| 14 | +public class ExampleDialogue : ScriptableObject { |
| 15 | + [TextAreaSpellCheck] |
| 16 | + public string text; |
| 17 | +} |
| 18 | +``` |
| 19 | + |
| 20 | +### Usage with advanced project logging |
| 21 | + |
| 22 | + |
| 23 | + |
| 24 | +You can log text from anywhere in your game with this pattern. You'll need to do this if you have large amounts of dialogue and you want to evaluate it all at once. |
| 25 | + |
| 26 | +```c# |
| 27 | +public class SpellCheckAllDialogue { |
| 28 | + [MenuItem("Spell Check/All Dialogue")] |
| 29 | + public static void CheckAllDialogue () { |
| 30 | + var logList = new List<LogEntry>(); |
| 31 | + |
| 32 | + var guids = AssetDatabase.FindAssets($"t:{typeof(ExampleDialogue).Name}"); |
| 33 | + foreach (var guid in guids) { |
| 34 | + var path = AssetDatabase.GUIDToAssetPath(guid); |
| 35 | + var asset = AssetDatabase.LoadAssetAtPath<ExampleDialogue>(path); |
| 36 | + |
| 37 | + if (!SpellCheck.Instance.IsInvalid(asset.Title) && !SpellCheck.Instance.IsInvalid(asset.Text)) continue; |
| 38 | + |
| 39 | + var log = new LogEntry($"{asset.Title} {asset.Text}", () => { |
| 40 | + SpellCheck.Instance.ClearValidation(); |
| 41 | + SpellCheck.Instance.AddValidation("Title", asset.Title); |
| 42 | + SpellCheck.Instance.AddValidation("Text", asset.Text); |
| 43 | + Selection.activeObject = asset; |
| 44 | + }); |
| 45 | + |
| 46 | + logList.Add(log); |
| 47 | + } |
| 48 | + |
| 49 | + SpellCheck.Instance.ShowLogs("All Example Dialogue Errors", logList); |
| 50 | + } |
| 51 | +} |
| 52 | +``` |
| 53 | + |
| 54 | +## Installation |
| 55 | + |
| 56 | +Unity Simple Spellcheck is used through [Unity's Package Manager](https://docs.unity3d.com/Manual/CustomPackages.html). In order to use it you'll need to add the following lines to your `Packages/manifest.json` file. After that you'll be able to visually control what specific version of Unity Simple Spellcheck you're using from the package manager window in Unity. This has to be done so your Unity editor can connect to NPM's package registry. |
| 57 | + |
| 58 | +```json |
| 59 | +{ |
| 60 | + "scopedRegistries": [ |
| 61 | + { |
| 62 | + "name": "NPM", |
| 63 | + "url": "https://registry.npmjs.org", |
| 64 | + "scopes": [ |
| 65 | + "com.fluid" |
| 66 | + ] |
| 67 | + } |
| 68 | + ], |
| 69 | + "dependencies": { |
| 70 | + "com.fluid.simple-spellcheck": "1.0.0" |
| 71 | + } |
| 72 | +} |
| 73 | +``` |
| 74 | + |
| 75 | +## Releases |
| 76 | + |
| 77 | +Archives of specific versions and release notes are available on the [releases page](https://github.com/ashblue/unity-simple-spellcheck/releases). |
| 78 | + |
| 79 | +## Nightly Builds |
| 80 | + |
| 81 | +To access nightly builds of the `develop` branch that are package manager friendly, you'll need to manually edit your `Packages/manifest.json` as so. |
| 82 | + |
| 83 | +```json |
| 84 | +{ |
| 85 | + "dependencies": { |
| 86 | + "com.fluid.simple-spellcheck": "https://github.com/ashblue/unity-simple-spellcheck.git#nightly" |
| 87 | + } |
| 88 | +} |
| 89 | +``` |
| 90 | + |
| 91 | +Note that to get a newer nightly build you must delete this line and any related lock data in the manifest, let Unity rebuild, then add it back. As Unity locks the commit hash for Git urls as packages. |
| 92 | + |
| 93 | +## Development Environment |
| 94 | + |
| 95 | +If you wish to run to run the development environment you'll need to install the latest [node.js](https://nodejs.org/en/). Then run the following from the root once. |
| 96 | + |
| 97 | +`npm install` |
| 98 | + |
| 99 | +If you wish to create a build run `npm run build` from the root and it will populate the `dist` folder. |
| 100 | + |
| 101 | +### Making Commits |
| 102 | + |
| 103 | +All commits should be made using [Commitizen](https://github.com/commitizen/cz-cli) (which is automatically installed when running `npm install`). Commits are automatically compiled to version numbers on release so this is very important. PRs that don't have Commitizen based commits will be rejected. |
| 104 | + |
| 105 | +To make a commit type the following into a terminal from the root |
| 106 | + |
| 107 | +```bash |
| 108 | +npm run commit |
| 109 | +``` |
| 110 | + |
| 111 | +--- |
| 112 | + |
| 113 | +This project was generated with [Oyster Package Generator](https://github.com/ashblue/oyster-package-generator). |
0 commit comments