chore(docs): improve command descriptions and language in the documen…

…tation
ReDeathmatch · Jan 27, 2024 · 97894f2 · 97894f2
1 parent 8b1e9cd
commit 97894f2
Show file tree

Hide file tree

Showing 11 changed files with 40 additions and 36 deletions.
diff --git a/docs/en/Customizing/commands.md b/docs/en/Customizing/commands.md
@@ -1,12 +1,12 @@
 ## Admin commands
 | Name |  Description | Access level | Plugin |
 | ------------ | --------------- | ------ | -------- |
-| redm_status          | Notifies the console about the status of the mod                                | f   | ReDeathmatch |
+| redm_status          | Notifies in console about the status of the mod                                | f   | ReDeathmatch |
 | redm_disable         | Disables the Deathmatch system                                                  | f   | ReDeathmatch |
 | redm_enable          | Enables the Deathmatch system                                                   | f   | ReDeathmatch |
 | redm_reload          | Restarts the Deathmatch system                                                  | f   | ReDeathmatch |
-| redm_dump_cvars      | Displays a list of the CVars loaded by the system                               | f   | ReDeathmatch |
-| redm_dump_equip      | Displays a list of loaded ammunition, currently available to players            | f   | ReDeathmatch |
+| redm_dump_cvars      | Displays in console a list of the CVars loaded by the system                               | f   | ReDeathmatch |
+| redm_dump_equip      | Displays in console a list of loaded ammunition, currently available to players            | f   | ReDeathmatch |
 | redm_convert_spawns  | Converts old spawn files for the new system                                     | f   | redm_spawns |
 | redm_edit_spawns     | Toggles the spawn editing mode                                                  | f   | redm_spawns |
 
@@ -21,9 +21,9 @@ The system reads the [[config file|Configuration]], resets the current round mod
 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`.
+When using the command, the system looks for files with the mask `<map_name>.spawns.cfg` in the directory `amxmodx/configs/csdm/spawns/`.
+During recursive traversal (checking) of the folder, every found file that matches the mask (format) will be read and transformed into a new architecture (JSON format).
+The new, converted files will be located in the folder `amxmodx/data/redm/converted/` and have a mask like: `<map_name>.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.`
@@ -35,5 +35,5 @@ In case of any errors during the work of the converter, the system will inform i
 ## Public commands
 | Name | Description | Plugin |
 | ------------ | -------- | ------ |
-| redm               | Outputs basic information about the mod used | ReDeathmatch |
+| redm               | Outputs in console basic information about the mod used | ReDeathmatch |
 | !guns, /guns, drop | Switches the equipment selection menu        | ReDeathmatch |
diff --git a/docs/en/Customizing/index.md b/docs/en/Customizing/index.md
@@ -32,8 +32,8 @@ Every config file to be loaded **must** have a valid JSON schema!
 The config file consists of sections:
 
  - equip
-    - primary - Primary weapons (assault rifles, snipers);
-    - secondary - Secondary weapons (guns);
+    - primary - Primary weapons (assault rifles, snipers, simi-pistols);
+    - secondary - Secondary weapons (pistols);
  - cvars - CVars to be changed when turning on Deathmatch mode;
  - modes - The list of rounds modes.
 

diff --git a/docs/en/Getting-started/alternatives.md b/docs/en/Getting-started/alternatives.md
@@ -14,7 +14,7 @@ The ReDeathmatch mod is a modern alternative that has active support from the cr
 - Git: [https://github.com/Arkshine/CSDM](https://github.com/Arkshine/CSDM)
 - Forum: [AlliedModders Forum](https://forums.alliedmods.net/forumdisplay.php?f=87)
 
-The original CSDM mod provides a stable and well-functioning foundation. Parts of the mod that consume a lot of CPU resources have been moved to a separate Metamod module (written in C++), which reduces the load. The necessary code for working with AMX Mod X has been extracted into an API. Most of the logic is implemented through AMX Mod X plugins.
+The original CSDM mod provides a stable and well-functioning foundation. Parts of the mod that consume a lot of CPU resources have been moved to a separate Metamod module (written in C++), which reduces the load. The necessary code for working with AMX Mod X has been extracted into an API[^1]. Most of the logic is implemented through AMX Mod X plugins.
 
 This mod is the only option for use with a regular HLDS server to date. It is not compatible with ReGameDLL.
 
@@ -46,4 +46,6 @@ It should be noted that the CSDM ReAPI mod by Vaqtincha does not support multili
 
 This is an enhanced version of CSDM ReAPI by Vaqtincha, adding multilingual support and partially fixing the respawn system and minor bugs. It brings new functionality and improves integration with ReGameDLL by utilizing its updated features.
 
-Development of this version has been discontinued by the author due to fundamental changes. Work on continuing the mod's concept is being done in ReDeathmatch.
+Development of this version has been discontinued by the author due to fundamental changes. Work on continuing the mod's concept is being done in ReDeathmatch.
+
+[^1]: API (Application Programming Interface) is a set of methods and rules by which different programs or parts of a program communicate with each other and exchange data. For example, AMXModX uses HLDS API through integration via Metamod API, which provides a multitude of methods to work with the game engine.
diff --git a/docs/en/Getting-started/index.md b/docs/en/Getting-started/index.md
@@ -6,4 +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.
+A variety of functions have long been built-in and optimized to work directly in ReGameDLL_CS. The ReDeathmatch system mostly just switches game settings and provides a convenient way to control most of the functionality.
diff --git a/docs/index.md b/docs/index.md
@@ -51,7 +51,7 @@ 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.
+A variety of functions have long been built-in and optimized to work directly in ReGameDLL_CS. The ReDeathmatch system mostly just switches game settings and provides a convenient way to control most of the functionality.
 
 ## Features
 - Store game settings (CVars);
@@ -62,7 +62,7 @@ Many features have long been built and optimized to work directly in ReGameDLL_C
 - Interactive spawn editor;
 - Configurable weapon menus;
 - Team Deathmatch as well as FFA (Free-for-all Deathmatch);
-- Large pieces are optimized in ReGameDLL_CS;
+- Performance-sensitive code is optimized in ReGameDLL_CS (without using AMXModX).
 - Multi-language support;
 - Extraconfigs support:
     - For an individual map (`redm/extraconfigs/de_dust2.json`);

diff --git a/docs/ru/Customizing/commands.md b/docs/ru/Customizing/commands.md
@@ -1,12 +1,12 @@
 ## Команды администратора
 | Имя | Описание | Уровень доступа | Плагин |
 | ------------ | --------------- | ------ | -------- |
-| redm_status          | Уведомляет консоль о состоянии мода                                 | f   | ReDeathmatch |
+| redm_status          | Уведомляет в консоль о состоянии мода                                 | f   | ReDeathmatch |
 | redm_disable         | Отключает систему Deathmatch                                             | f   | ReDeathmatch |
 | redm_enable          | Включает систему Deathmatch                                              | f   | ReDeathmatch |
 | redm_reload          | Перезапускает систему Deathmatch                                         | f   | ReDeathmatch |
-| redm_dump_cvars      | Выводит список загруженных CVars системой                               | f   | ReDeathmatch |
-| redm_dump_equip      | Выводит список загруженного снаряжения, доступного игрокам              | f   | ReDeathmatch |
+| redm_dump_cvars      | Выводит в консоль список загруженных CVars системой                               | f   | ReDeathmatch |
+| redm_dump_equip      | Выводит в консоль список загруженного снаряжения, доступного игрокам              | f   | ReDeathmatch |
 | redm_convert_spawns  | Преобразует старые файлы точек возрождения в новую систему                | f   | redm_spawns |
 | redm_edit_spawns     | Включает режим редактирования точек возрождения                           | f   | redm_spawns |
 
@@ -15,15 +15,15 @@
 
  - `<file_name>` - название файла конфигурации (опционально)
 
-Система считывает файл конфигурации, сбрасывает текущий режим раунда (если он включен) и уведомляет консоль о успешной перезагрузке.
+Система считывает файл конфигурации, сбрасывает текущий режим раунда (если он включен) и уведомляет в консоли о успешной перезагрузке.
 > Если используется аргумент команды, она будет искать этот файл в папке `amxmodx/configs/redm/<file_name>`.
 
 Пример: `redm_reload custom_config.json`
 
 ### Использование `redm_convert_spawns`
-При использовании команды, система ищет файлы с маской `*.spawns.cfg` в директории `amxmodx/configs/csdm/spawns/`.
-При рекурсивном обходе папки каждый найденный файл, соответствующий маске, будет считан и преобразован в новую архитектуру (JSON).
-Новые, преобразованные файлы будут располагаться в папке `amxmodx/data/redm/converted/` и иметь маску вида: `*.spawns.json`.
+При использовании команды, система ищет файлы с маской `<map_name>.spawns.cfg` в директории `amxmodx/configs/csdm/spawns/`.
+При рекурсивном обходе (проверке) папки каждый найденный файл, соответствующий маске (формату), будет считан и преобразован в новую архитектуру (формат JSON).
+Новые, преобразованные файлы будут располагаться в папке `amxmodx/data/redm/converted/` и иметь маску вида: `<map_name>.spawns.json`.
 
 После успешного преобразования система сообщит о том, что преобразование было успешным:
 `Editor_ConvertSpawns: Succefully convert N old spawn files.`
@@ -35,5 +35,5 @@
 ## Публичные команды
 | Имя | Описание | Плагин |
 | ------------ | -------- | ------ |
-| redm               | Выводит основную информацию о используемом моде | ReDeathmatch |
+| redm               | Выводит в консоль основную информацию о используемом моде | ReDeathmatch |
 | !guns, /guns, drop | Переключает меню выбора экипировки             | ReDeathmatch |
diff --git a/docs/ru/Customizing/convars.md b/docs/ru/Customizing/convars.md
@@ -7,18 +7,18 @@ amxx cvars ReDeathmatch; amxx cvars redm_
 | Имя | Описание | Значение | Плагин |
 | - | - | - | - |
 | redm_version | **Система**, отображает информацию о используемом моде в Source Query | `<версия_мода>` | ReDeathmatch |
-| redm_healer | Количество ниши дополнительного здоровья, получаемого игроком при убийстве оппонента | `0...maxHealth` | ReDeathmatch |
-| redm_healer_hs | Количество ниши дополнительного здоровья, получаемого игроком при убийстве оппонента в голову | `0...maxHealth` | ReDeathmatch |
+| redm_healer | Количество дополнительного здоровья, получаемого игроком при убийстве оппонента | `0...maxHealth` | ReDeathmatch |
+| redm_healer_hs | Количество дополнительного здоровья, получаемого игроком при убийстве оппонента в голову | `0...maxHealth` | ReDeathmatch |
 | redm_sounds_distance | Минимальное расстояние (единиц) от игрока до других, на котором он будет слышать выстрелы, шаги и т.д. Используется для уменьшения шума и повышения игрового опыта. | 0 - отключено или расстояние типа `int` |ReDeathmatch |
 | redm_fade | Подсветка экрана для игроков при убийстве оппонента | `boolean` | ReDeathmatch |
-| redm_refill_ammo | Перезарядка боеприпасов оружия при убийстве оппонента | `boolean` | ReDeathmatch |
+| redm_refill_ammo | Автоматическое пополнение (восстановление) боеприпасов оружия при убийстве оппонента | `boolean` | ReDeathmatch |
 | redm_hitsound | Звуковая индикация попадания по оппоненту | `boolean` | ReDeathmatch |
 | mp_damage_headshot_only | Включение режима "Только в голову" для всех игроков | `boolean` | ReDeathmatch |
-| redm_hide_other_deathnotice | Скрытие событий kill/deathnotice других игроков для игроков | `boolean` | ReDeathmatch |
+| redm_hide_other_deathnotice | Скрытие отображения событий убийства (фрагов) и смертей других игроков для игрока | `boolean` | ReDeathmatch |
 | redm_spawn_preset | Выбор пресета для менеджера точек возрождения | `preset` - предустановленный; </br> `<название_пресета>` - другие реализации | ReDeathmatch |
-| redm_modes_switch | Выбор режима работы раундового режима (Multi-CFG) | `sequentially` - выбор по очереди; </br> `random` - случайный режим каждый раунд | ReDeathmatch |
+| redm_modes_switch | Выбор режима раунда (Multi-CFG) | `sequentially` - выбор по очереди; </br> `random` - случайный режим каждый раунд | ReDeathmatch |
 | redm_keep_weapon_slot | При возрождении игрока с экипировкой восстанавливается последний использованный слот (оружие). | `boolean` | ReDeathmatch |
-| redm_active | Отображение статуса работы мода | `boolean` | ReDeathmatch |
+| redm_active | Отображение статуса работы мода, а так же переключение | `boolean` | ReDeathmatch |
 | mp_randomspawn | Случайное возрождение для игроков | `0` - отключено; </br> `1` - все команды возрождаются на случайных точках; </br> `2` - только T; </br> `3` - только CT | redm_spawns |
 | mp_randomspawn_los | Проверять ли видимость оппонентов воскрешенного игрока перед появлением на точке | `boolean` | redm_spawns |
 | mp_randomspawn_dist | Минимальное расстояние до врагов перед появлением на точке | `int` | redm_spawns |
diff --git a/docs/ru/Customizing/index.md b/docs/ru/Customizing/index.md
@@ -32,8 +32,8 @@ FindConfigFile: Can't find any config file!
 Файл конфигурации состоит из разделов:
 
  - equip
-    - primary - Основное оружие (штурмовые винтовки, снайперские винтовки);
-    - secondary - Вторичное оружие (пистолеты и пулеметы);
+    - primary - Основное оружие (штурмовые винтовки, снайперские винтовки, пистолеты-пулемёты);
+    - secondary - Вторичное оружие (пистолеты);
  - cvars - CVars для изменения игрового процесса при включении режима Deathmatch;
  - modes - Список режимов раундов.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -6,4 +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.
		A variety of functions have long been built-in and optimized to work directly in ReGameDLL_CS. The ReDeathmatch system mostly just switches game settings and provides a convenient way to control most of the functionality.