Browse Source

ok github

SaltyMonkey 6 years ago
parent
commit
fd3ac93c08
3 changed files with 15 additions and 15 deletions
  1. 5 5
      docs/commands.md
  2. 4 4
      docs/presets.md
  3. 6 6
      docs/settings.md

+ 5 - 5
docs/commands.md

@@ -5,8 +5,8 @@ Full list for all in-game chat commands
 |  Command         | Alias        | Description                                        |
 |  Command         | Alias        | Description                                        |
 | --------------   | -------------| ---------------------------------------------------|
 | --------------   | -------------| ---------------------------------------------------|
 | `/8 fm help`     | `/8 fn h`    | Print compact command list in Toolbox chat |
 | `/8 fm help`     | `/8 fn h`    | Print compact command list in Toolbox chat |
-| `/8 fm auto`     | `/8 fn a`    | Enable/Disable automatic mode changes based on events. `Keeps current activated mode!` |
-| `/8 fm mode <name>` | `/8 fn m <name>`| Forcefully enable desired `mode` from active `preset`|
-| `/8 fm class <name>` | `/8 fn c <name>`| Enable/Disable per-class `presets`. Will need relog|
-| `/8 fm debug` | `/8 fn d`| Enable/Disable some inbuild debug features|
-| `/8 fm interactive` | `/8 fn i`| Enable/Disable interactive messages in chat when `modes` changes|
+| `/8 fm auto`     | `/8 fn a`    | Enable/Disable automatic mode changes based on events.|
+| `/8 fm mode <name>` | `/8 fn m <name>` | Forcefully enable desired `mode` from active `preset`|
+| `/8 fm class <name>` | `/8 fn c <name>` | Enable/Disable per-class `presets`. Will need relog|
+| `/8 fm debug` | `/8 fn d` | Enable/Disable some inbuild debug features|
+| `/8 fm interactive` | `/8 fn i` | Enable/Disable interactive messages in chat when `modes` changes|

+ 4 - 4
docs/presets.md

@@ -16,7 +16,7 @@ Preset structure MUST HAVE `directives` `object` and `modes` `object`.
 
 
 Simplified example below:
 Simplified example below:
 
 
-```json
+```JS
 {
 {
 	
 	
 	"directives": {
 	"directives": {
@@ -40,7 +40,7 @@ Value must be valid key from `modes` object.
 
 
 Simplified example with explanation (WARNING: you can't place comments as below in real file).
 Simplified example with explanation (WARNING: you can't place comments as below in real file).
 
 
-```json
+```JS
 {
 {
 	...
 	...
 	"directives": {
 	"directives": {
@@ -67,14 +67,14 @@ Every `modes` field explains `MODE NAME` and contains ` desired options` as obje
 Value must be valid key from `modes` object.
 Value must be valid key from `modes` object.
 Simplified example below: (WARNING: you can't place comments as below in real file)
 Simplified example below: (WARNING: you can't place comments as below in real file)
 
 
-```JSON
+```JS
 {	...
 {	...
 
 
 	"modes": {
 	"modes": {
 		"basicMode": { //mode name, can be applied in directives (look example above)
 		"basicMode": { //mode name, can be applied in directives (look example above)
 			...
 			...
 		},
 		},
-		"myCustomModeName" : { //custom user mode name, can be applied in directives (look example above) or called with commands (as example: /8 fm m myCustomModeName)
+		"myCustomModeName" : { //custom user mode name, called with commands as example: /8 fm m myCustomModeName)
 			...
 			...
 		}
 		}
 	}
 	}

+ 6 - 6
docs/settings.md

@@ -6,9 +6,9 @@ Settings file path: `<modfolder>/settings/settings.json`. Can be opened with any
 
 
 |  Setting             |  Type   | Description                      |
 |  Setting             |  Type   | Description                      |
 | ------------------   | -----   | ---------------------------------|
 | ------------------   | -----   | ---------------------------------|
-| `registerCommands`   | Boolean | Enable/Disable ingame commands   |
-| `customCommandsTag`  | String  | If not empty string adds additional custom tag for ingame commands   |
-| `interactive`        | Boolean | Enable/Disable additional ingame messages from mod   |
-| `classBasedPresets`  | Boolean | Enable/Disable per-class `presets` usage   |
-| `enableEvents`       | Boolean | Enable/Disable ingame commands   |
-| `enableEvents`       | Boolean | Enable/Disable realtime class presets changes monitoring and reloading  |
+| registerCommands   | Boolean | Enable/Disable ingame commands   |
+| customCommandsTag  | String  | If not empty string adds additional custom tag for ingame commands   |
+| interactive        | Boolean | Enable/Disable additional ingame messages from mod   |
+| classBasedPresets  | Boolean | Enable/Disable per-class `presets` usage   |
+| enableEvents       | Boolean | Enable/Disable ingame commands   |
+| enableEvents       | Boolean | Enable/Disable realtime class presets changes monitoring and reloading  |