From 163af74a0319fa08334bee4477c1042295a35ede Mon Sep 17 00:00:00 2001 From: That_One_Nerd Date: Thu, 16 Mar 2023 11:09:40 -0400 Subject: [PATCH] added some modules --- Modules.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/Modules.md b/Modules.md index 6a0af06..88b4794 100644 --- a/Modules.md +++ b/Modules.md @@ -1,5 +1,8 @@ -# SrcMod/Modules -Modules in SrcMod are how commands are grouped. A module can have an id which must be prefixed before the command name and parameters when parsed. Modules are declared by applying the `ModuleAttribute` attribute in the namespace `SrcMod.Shell.Modules.ObjectModels` to a class. The classes can be static. +# Overview +Modules in SrcMod are how commands are grouped. A module can have an id which must be prefixed before the command name and parameters when parsed. + +## How to Use +Modules are declared by applying the `ModuleAttribute` attribute in the namespace `SrcMod.Shell.Modules.ObjectModels` to a class. The classes can be static. Here is an example: ```csharp @@ -32,3 +35,10 @@ 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 +These are the name, prefix, and brief descriptions of each module implemented by default in SrcMod. + +| Class Name | Prefix | Description | +|-|-|-| +| `BaseModule` | None (not prefixed) | A module with most system commands. Does not contain any modding functionality. |