|
1 | | -# ExampleMod |
| 1 | +# Numantics |
2 | 2 |
|
3 | | -A [ResoniteModLoader](https://github.com/resonite-modding-group/ResoniteModLoader) mod for [Resonite](https://resonite.com/) that does something. |
4 | | -<!-- Edit to describe what your mod does and what it may solve --> |
5 | | -<!-- If your mod solves an issue, you should link to any relevant issues on the resonite github --> |
| 3 | +A [ResoniteModLoader](https://github.com/resonite-modding-group/ResoniteModLoader) mod for [Resonite](https://resonite.com/) that adds math expression evaluation to input fields. |
6 | 4 |
|
| 5 | +Type math expressions directly into any numeric field and have them automatically calculated when you finish editing! |
7 | 6 |
|
8 | | -## Screenshots |
9 | | -<!-- If your mod has visible effects in the game, attach some images or video of it in-use here! Otherwise remove this section --> |
| 7 | +## Features |
| 8 | +- **Evaluate math expressions** in any numeric input field (e.g., `2+3` → `5`) |
| 9 | +- **Shorthand operators**: Use `x` for multiply, `d` for divide, `a` for add, `s` for subtract |
| 10 | +- **Standard operators**: Also supports `*`, `/`, `+`, `-` |
| 11 | +- **Proper operator precedence**: Multiplication and division before addition and subtraction |
| 12 | +- **Complex expressions**: Supports parentheses and more advanced calculations |
| 13 | +- **Optional string field support**: Enable math evaluation in string fields via config |
| 14 | + |
| 15 | +## Usage Examples |
| 16 | +- Type `100+50` in a position field → becomes `150` |
| 17 | +- Type `5x3` in a scale field → becomes `15` |
| 18 | +- Type `10d2` in any numeric field → becomes `5` |
| 19 | +- Type `(2+3)*4` → becomes `20` |
10 | 20 |
|
11 | 21 | ## Installation |
12 | 22 | 1. Install [ResoniteModLoader](https://github.com/resonite-modding-group/ResoniteModLoader). |
13 | | -1. Place [ExampleModName.dll](https://github.com/YourGithubUsername/YourModRepoName/releases/latest/download/ExampleModName.dll) into your `rml_mods` folder. This folder should be at `C:\Program Files (x86)\Steam\steamapps\common\Resonite\rml_mods` for a default install. You can create it if it's missing, or if you launch the game once with ResoniteModLoader installed it will create this folder for you. |
| 23 | +1. Place [Numantics.dll](https://github.com/nalathethird/R-Numantics/releases/latest/download/Numantics.dll) into your `rml_mods` folder. This folder should be at `C:\Program Files (x86)\Steam\steamapps\common\Resonite\rml_mods` for a default install. You can create it if it's missing, or if you launch the game once with ResoniteModLoader installed it will create this folder for you. |
14 | 24 | 1. Start the game. If you want to verify that the mod is working you can check your Resonite logs. |
| 25 | + |
| 26 | +## Configuration |
| 27 | +The mod creates a config file with the following options: |
| 28 | +- `enable_math`: Enable/disable math processing (default: `true`) |
| 29 | +- `include_strings`: Allow math in string fields (default: `false`) |
| 30 | +- `verbose_logging`: Enable detailed logging for debugging (default: `false`) |
| 31 | + |
| 32 | +## Links |
| 33 | +- [GitHub Repository](https://github.com/nalathethird/R-Numantics) |
| 34 | +- [Resonite Modding Group](https://github.com/resonite-modding-group) |
0 commit comments