Skip to content

Commit c0c1a37

Browse files
authored
Enhance README for update 1.0.1
Expanded features and configuration options for math evaluation.
1 parent 585c32c commit c0c1a37

1 file changed

Lines changed: 29 additions & 10 deletions

File tree

README.md

Lines changed: 29 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,23 @@ A [ResoniteModLoader](https://github.com/resonite-modding-group/ResoniteModLoade
55
Type math expressions directly into any numeric field and have them automatically calculated when you finish editing!
66

77
## 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
8+
- Evaluate expressions in numeric fields (and optionally string fields).
9+
- Supports functions, percentages, powers, and shorthand operator letters.
10+
- Optional rounding mode (rounds final numeric results to nearest integer).
11+
- Evaluate math expressions in input fields:
12+
- Basic operators: `+`, `-`, `*`, `/`
13+
- Shorthand operators: `x``*`, `d``/`, `a``+`, `s``-`
14+
- PEMDAS Support: Standard Order of Operations
15+
- Power operator: `^` (e.g. `6^(2+3)`)
16+
- Percent support: `50%` is interpreted as `*0.5` (so `3200-50%``1600`)
17+
- Parentheses and precedence supported
18+
- Math functions (input in degrees for trig):
19+
`sqrt`, `sin`, `cos`, `tan`, `log`, `log10`, `ln`, `abs`, `floor`, `ceil`
20+
- `pi` constant is supported (case-insensitive)
21+
- Easter eggs (config-controlled):
22+
- Fun special-case behaviors
23+
- Rounding (config-controlled):
24+
- `round_results` option — when enabled rounds all calculated numeric results to the nearest integer
1425

1526
## Usage Examples
1627
- Type `100+50` in a position field → becomes `150`
@@ -22,12 +33,20 @@ Type math expressions directly into any numeric field and have them automaticall
2233
1. Install [ResoniteModLoader](https://github.com/resonite-modding-group/ResoniteModLoader).
2334
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.
2435
1. Start the game. If you want to verify that the mod is working you can check your Resonite logs.
36+
---
2537

2638
## 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`)
39+
The mod creates/uses a configuration file with the following options:
40+
- `enable_math` (bool, default: `true`)
41+
Enable/disable math processing in input fields.
42+
- `include_strings` (bool, default: `false`)
43+
Allow math evaluation inside fields whose type is `string`.
44+
- `round_results` (bool, default: `false`)
45+
When true, all numeric results are rounded to the nearest integer before being written back to fields.
46+
- `enable_easter_eggs` (bool, default: `false`)
47+
Toggle Easter eggs (fun special-cases).
48+
- `verbose_logging` (bool, default: `false`)
49+
Enables detailed logging — recommended while testing field detection and parsing.
3150

3251
**Star this repo if it helped you!** ⭐ It keeps me motivated to maintain and improve my mods.
3352

0 commit comments

Comments
 (0)