Docs upd1

docs/Customizing/commands.md

@@ -0,0 +1,38 @@
+## Admin commands
+| Name | Access level | Description | Plugin |
+| ------------ | --------------- | ------ | -------- |
+| redm_status          | f   | Notifies the console about the status of the mod                                | ReDeathmatch |
+| redm_disable         | f   | Disables the Deathmatch system                                                  | ReDeathmatch |
+| redm_enable          | f   | Enables the Deathmatch system                                                   | ReDeathmatch |
+| redm_reload          | f   | Restarts the Deathmatch system                                                  | ReDeathmatch |
+| redm_dump_cvars      | f   | Displays a list of the CVars loaded by the system                               | ReDeathmatch |
+| redm_dump_equip      | f   | Displays a list of loaded ammunition, currently available to players            | ReDeathmatch |
+| redm_convert_spawns  | f   | Converts old spawn files for the new system                                     | redm_spawns |
+| redm_edit_spawns     | f   | Toggles the spawn editing mode                                                  | redm_spawns |
+
+## Public commands
+| Name | Description | Plugin |
+| ------------ | -------- | ------ |
+| redm               | Outputs basic information about the mod used | ReDeathmatch |
+| !guns, /guns, drop | Switches the equipment selection menu        | ReDeathmatch |
+
+---
+
+### Using `redm_reload`
+Arguments:
+ - <file_name> - the name of the config file (optional)
+
+The system reads the [[config file|Configuration]], resets the current round mode (if enabled), and notifies the console of a successful reboot.
+> If the command argument is used, it will search for this file in the `amxmodx/configs/redm/<file_name>` folder.
+
+Example: `redm_reload custom_config.json`
+
+### Using `redm_convert_spawns`
+When using the command, the system searches for files with mask `*.spawns.cfg` in directory `amxmodx/configs/csdm/spawns/`.
+When recursively traversing the folder, each found file corresponding to the mask will be read and converted to the new architecture (JSON).
+New, converted files will be located in the `amxmodx/data/redm/converted/` folder and will have a mask of the form: `*.spawns.json`.
+
+After a successful conversion, the system will let you know that the conversion was successful:
+`Editor_ConvertSpawns: Succefully convert N old spawn files.`
+
+In case of any errors during the work of the converter, the system will inform in the server console (as well as in the logs) the reasons of operability.

docs/Customizing/configuration.md

@@ -0,0 +1,54 @@
+## Main configuration 
+Found in `amxmodx/configs/redm/gamemode_deathmatch.json` file.
+
+❗❗❗ Everything that relates to Deathmatch mode **must** be configured only in this file.
+
+## Additional configuration:
+There is support for additional configuration, by loading the configuration for:
+- Defined map (`configs/redm/extraconfigs/<map_name>.json` file);
+- Map prefix (`configs/redm/extraconfigs/prefix_<prefix_map>.json` file);
+
+The order of finding a config file to load:
+1) The map config is searched for;
+2) The config file for the map prefix is searched;
+3) The main config file is searched (`configs/redm/gamemode_deathmatch.json`).
+
+Found and used config is accompanied by an information message in the server console:
+```js
+[1.00][INFO] FindConfigFile: Config ``gamemode_deathmatch.json`` loaded.
+```
+
+If none of the configuration files are found, the plugin will give an error:
+```json
+FindConfigFile: Can't find any config file!
+```
+
+Every config file to be loaded **must** have a valid JSON schema!
+
+## Config file structure
+The config file consists of sections:
+ - equip
+   - primary - Primary weapons (assault rifles, snipers);
+   - secondary - Secondary weapons (guns);
+ - cvars - CVars to be changed when turning on Deathmatch mode;
+ - modes - The list of rounds modes.
+
+## Section `equip`
+### Primary.
+The list of weapons which are used to equip the player in the Primary slots (assault rifles, sniper rifles, SMG, etc.).
+
+### Secondary
+The list of weapons, to equip the player in the Secondary (pistols) slot.
+
+## Section `cvars`.
+A list of the CVars of the server for changing the gameplay when turning on Deathmatch mode. Each CVar in this list restores its original value when Deathmatch mode is turned off (the system remembers the original CVar value before changing it).
+
+## Section `modes`.
+It is an optional section.
+Contains a list of mode configurations for rounds (Multi-CFG), contains in fact a complete structure for the configuration described above.
+The exceptions are the parameters:
+ - `name` - Name of the mode.
+
+    Displayed to players when reviving, switching modes.
+
+    Can contain LANG-key defined in `amxmodx\data\lang\redm\modes.txt`, if LANG-key will be found in provided dictionary.

docs/Customizing/convars.md

@@ -0,0 +1,24 @@
+The mod adds new CVar's, for easy configuration.
+The complete and up-to-date list can be seen with the command:
+```
+amxx cvars ReDeathmatch; amxx cvars redm_
+```
+---
+| Name | Description | Value | Plugin |
+| - | - | - | - |
+| redm_version | **System**, displays in Source Query information about the used mod | `<version_mod>` | ReDeathmatch |
+| redm_healer | HP amount given to the player (bonus) when killing an opponent | `0...maxHealth` | ReDeathmatch |
+| redm_healer_hs | Amount of HP given to the player (bonus) when killing an opponent in the head | `0...maxHealth` | ReDeathmatch |
+| redm_sounds_distance | Minimal distance (units) of the player from others, at which he will hear shots, steps, etc. Used to reduce noise, improve gameplay experience. | 0 - disabled or distance in `int` |ReDeathmatch |
+| redm_fade | illuminate the screen for players when killing an opponent | `boolean` | ReDeathmatch |
+| redm_refill_ammo | refill weapon ammunition when you kill an opponent | `boolean` | ReDeathmatch |
+| redm_hitsound | sound indication of a hit on an opponent | | boolean | ReDeathmatch |
+| mp_damage_headshot_only | Enable Only-headshot mode for all players | `boolean` | ReDeathmatch |
+| redm_hide_other_deathnotice | Hiding someone else's kill/deathnotice events for players | `boolean` | ReDeathmatch |
+| redm_spawn_preset | Selecting a preset for the spawn manager | `preset` - pre-installed; </br> `<preset_name>` - other implements | ReDeathmatch |
+| redm_modes_switch | Selecting the mode of operation of the round mode (Multi-CFG) | `sequentially` - selection one by one; </br> `random` - random mode every round | ReDeathmatch |
+| redm_keep_weapon_slot | When a player is respawn and equipped, the last used slot (weapon) is restored. | `boolean` | ReDeathmatch |
+| redm_active | Displaying the working status of the mod | `boolean` | ReDeathmatch |
+| mp_randomspawn | Random spawning for players | `0` - disabled; </br> `1` - all teams will spawn in random points; </br> `2` - only T; </br> `2` - only CT | redm_spawns |
+| mp_randomspawn_los | Whether to check the visibility of the revived player's opponents before spawning on a point | `boolean` | redm_spawns |
+| mp_randomspawn_dist | Minimum distance to enemies before spawning to a point | `int` | redm_spawns |

docs/Customizing/plugins.md

@@ -0,0 +1,12 @@
+The basic set of plugins necessary for Deathmatch mode is defined in the file `amxmodx\configs\plugins-redm.ini`:
+
+## Structure
+```ini
+; Main plugin
+ReDeathmatch.amxx debug ; Main mod
+
+; Addons
+redm_spawns.amxx debug ; System for working with spawn points (player revives, items (TODO))
+```
+
+The order of the plugins is important for loading, not recommended for modding!

docs/getting-started.md → docs/Getting-started/index.md

@@ -6,10 +6,4 @@ The mod is a completely rewritten implementation of [CSDM ReAPI](https://github.
 
 Mod made a look back on the successful experience [CSDM 2.1.2 by BAILOPAN](https://www.bailopan.net/csdm), but using modern features of the new [ReGameDLL_CS](https://github.com/s1lentq/ReGameDLL_CS).
 
-Many features have long been built and optimized to work directly in ReGameDLL_CS, mod now only switches the game settings and provides a comfortable way to control.
-
-## Installation
-
-```
-TODO
-```
+Many features have long been built and optimized to work directly in ReGameDLL_CS, mod now only switches the game settings and provides a comfortable way to control.

docs/Getting-started/installation.md

@@ -0,0 +1,15 @@
+- [Download the latest](https://github.com/wopox1337/ReDeathmatch/releases/latest) stable version from the release section;
+- Extract the `cstrike` folder to the root folder of the **HLDS** server;
+- Make sure that the plugins are working and that they are located correctly, using the `amxx list` command.
+
+The list of plugins should display properly working plugins, for example:
+```cpp
+] amxx list
+
+Currently loaded plugins:
+       id  name                    version     author            file         status
+...
+ [  2] 1   ReDeathmatch            1.0.0-beta  Sergey Shorokhov  ReDeathmatc  debug
+ [  3] 2   Spawns manager          1.0.0-beta  Sergey Shorokhov  redm_spawns  debug
+
+```

docs/Getting-started/requirements.md

@@ -0,0 +1,49 @@
+- Installed [HLDS server](https://developer.valvesoftware.com/wiki/Half-Life_Dedicated_Server);
+- Installed [ReGameDLL_CS](https://github.com/s1lentq/ReGameDLL_CS);
+- Installed AMXModX ([v1.9](https://www.amxmodx.org/downloads-new.php) or [v1.10](https://www.amxmodx.org/downloads-new.php?branch=master));
+- Installed [ReAPI](https://github.com/s1lentq/reapi) AMXX module.
+
+Check the installed components:
+- HLDS version using the command: `version`
+  ```javascript
+  ] version
+
+  Protocol version 48
+  Exe version 1.1.2.7/Stdio (cstrike)
+  ReHLDS version: 3.13.0.783-dev
+  Build date: 00:06:04 Feb 11 2023 (3227)
+  Build from: https://github.com/dreamstalker/rehlds/commit/1796459
+  ```
+- The version of the ReGameDLL using the command: `game version`
+  ```js
+  ] game version
+
+  ReGameDLL version: 5.22.0.594-dev
+  Build date: 22:19:38 Apr 03 2023
+  Build from: https://github.com/wopox1337/ReGameDLL_CS/commit/71e61e6
+  ```
+- The version of AMXModX by viewing the meta list of modules: `meta list`
+  ```js
+  ] meta list
+
+  Currently loaded plugins:
+        description   stat pend  file                  vers             src  load  unload
+   [ 1] AMX Mod X     RUN   -    amxmodx_mm.dll        v1.10.0.5467     ini  Start ANY
+   [ 2] Ham Sandwich  RUN   -    hamsandwich_amxx.dll  v1.10.0.5467     pl1  ANY   ANY
+   [ 3] FakeMeta      RUN   -    fakemeta_amxx.dll     v1.10.0.5467     pl1  ANY   ANY
+   [ 4] ReAPI         RUN   -    reapi_amxx.dll        v5.23.0.263-dev  pl1  ANY   Never
+  4 plugins, 4 running
+  ```
+- The version of the ReAPI by browsing the list of AMXX modules: `amxx modules`
+  ```js
+  ] amxx modules
+
+  Currently loaded modules:
+        name                    version     author               status
+   [ 1] Amxx Debuger            0.1b        Garey                running
+   [ 2] Ham Sandwich            1.10.0.546  AMX Mod X Dev Team   running
+   [ 3] FakeMeta                1.10.0.546  AMX Mod X Dev Team   running
+   [ 4] JSON                    1.10.0.546  AMX Mod X Dev Team   running
+   [ 5] ReAPI                   5.23.0.263  Asmodai & s1lent     running
+  5 modules, 5 correct
+```

mkdocs.yml

@@ -43,7 +43,7 @@ theme:
     - content.tooltips
     - navigation.sections
     - navigation.tabs
-    # - navigation.tabs.sticky
+    - navigation.tabs.sticky
     - navigation.expand
     - navigation.path
     - navigation.footer