Added the configuration commands to the wiki.

That_One_Nerd 2023-04-18 09:56:41 -04:00
parent 04e2f8a0d6
commit 100316039d
2 changed files with 73 additions and 2 deletions

@ -371,6 +371,78 @@ Parameters:
--- ---
### `config`
#### `config add`, `config append`
Appends an item to a configuration variable. The variable in question must be a list.
Parameters:
- name: `string`
- The name of the configuration variable.
- Possible Values:
- "GameDirectories"
- value: `string`
- The value to append to the configuration variable.
---
#### `config delete`, `config remove`
Removes a single item from a configuration variable. The variable in question must be a list.
Parameters:
- name: `string`
- The name of the configuration variable.
- Possible Values:
- "GameDirectories"
- value: `string`
- The value to remove from the configuration variable.
---
#### `config display`, `config list`
Displays the configuration information on the console. Depending on the value of the parameter `mode`, the shell may display a single configuration option or multiple configuration options.
Parameters:
- mode: `ConfigDisplayMode`
- The type of information to display.
- Default Value: `All`
- Possible Values:
- `Raw`
- Displays all configuration info in raw format.
- `All`
- Displays all configuration info in a styled format.
- `GameDirectories`
- Displays the list of accepted Steam game directories to search in.
- `RunUnsafeCommands`
- Displays whether or not the shell executes unsafe commands without prompting the user.
---
#### `config reset`
Resets a single or multiple configuration variables to their default values.
Parameters:
- name: `string`
- The name of the configuration variable.
- Possible Values:
- "All"
- "GameDirectories"
- "RunUnsafeCommands"
#### `config set`
Changes the value of a single configuration variable. The variable in question must be a single value.
Parameters:
- name: `string`
- The name of the configuration variable to set.
- Possible Values:
- "GameDirectories"
- "RunUnsafeCommands"
- value: `string`
- The value to set to the variable.
---
### `extract` ### `extract`
#### `extract gz`, `extract gzip` #### `extract gz`, `extract gzip`

@ -34,8 +34,6 @@ Inside the class will be the commands in that module.
--- ---
**Note: When using the `srcmod.dll` to add additional custom modules, the new modules will not be recognized due to a reflection bug. This will be fixed in the near future (see issue #2).**
# Default Modules # Default Modules
These are the name, prefix, and brief descriptions of each module implemented by default in SrcMod. These are the name, prefix, and brief descriptions of each module implemented by default in SrcMod.
@ -44,4 +42,5 @@ These are the name, prefix, and brief descriptions of each module implemented by
| `BaseModule` | `base` (not prefixed) | A module with most system commands. Does not contain any modding functionality. | | `BaseModule` | `base` (not prefixed) | A module with most system commands. Does not contain any modding functionality. |
| `ClipboardModule` | `clipboard` | A module that handles commands related to the system clipboard. | | `ClipboardModule` | `clipboard` | A module that handles commands related to the system clipboard. |
| `CompressionModule` | `compress` | A module that handles compression to certain formats. | | `CompressionModule` | `compress` | A module that handles compression to certain formats. |
| `ConfigModule` | `config` | A module that handles configuration of the shell. |
| `ExtractionModule` | `extract` | A module that handles extraction from certain compression formats. | | `ExtractionModule` | `extract` | A module that handles extraction from certain compression formats. |