diff --git a/readme/default-extensions.md b/readme/default-extensions.md index 616c0a4..d4811c2 100644 --- a/readme/default-extensions.md +++ b/readme/default-extensions.md @@ -6,7 +6,7 @@ - [SpawnItems](extensions/modules/spawn-items.md) - Выдача предметов при спавне - [WeaponMenu](extensions/modules/weapon-menu.md) - Оружейное меню - [VipInTab](extensions/modules/vip-in-tab.md) - Надпись VIP в таблице счёта игроков -- Vampire - Вампиризм +- [Vampire](extensions/modules/vampire.md) - Вампиризм ## Ограничения diff --git a/readme/extensions/modules/spawn-health.md b/readme/extensions/modules/spawn-health.md index 2272dfc..648dfa9 100644 --- a/readme/extensions/modules/spawn-health.md +++ b/readme/extensions/modules/spawn-health.md @@ -1,44 +1,41 @@ # SpawnHealth -Модуль, выдающий игроку при спавне дополнительные хп и/или броню. +Выдача игроку при спавне здоровья и/или брони. + +## Параметры + +| Название | Тип | По умолчанию\* | Описание | +| :-------- | :------------- | :------------- | :------------------------------------------------------------------------------------------- | +| SetHealth | `true`/`false` | `false` | Если `true` - здоровье будет установлено в указанное значение, а если `false` - добавлено | +| Health | Ц.Число | 0 | Количество здоровья, которое будет установлено/добавлено | +| MaxHealth | Ц.Число | Нет | Максимальное количество здоровья, выше которого оно не будет добавлено при `SetHealth: true` | +| | | | | +| SetArmor | `true`/`false` | `false` | Если `true` - брони будет установлена в указанное значение, а если `false` - добавлена | +| Armor | Ц.Число | 0 | Количество брони, которое будет установлена/добавлена | +| Helmet | `true`/`false` | `false` | Выдавать ли шлем вместе с бронёй | +| MaxArmor | Ц.Число | Нет | Максимальное количество брони, выше которого она не будет добавлена при `SetArmor: true` | +| | | | | +| Limits | Массив лимитов | Нет | Условия, при выполнении которых здоровье и броня будут выданы | ## Пример ```json { - "Module": "SpawnHealth", + "Module": "SpawnHealth", - "Limits": { - "Limit": "Round", - "Min": 2 - }, + "Limits": { + "Limit": "Round", + "Min": 2 + }, - "SetHealth": true, - "Health": 110, + "SetHealth": true, + "Health": 110, - "SetArmor": false, - "Armor": 50, - "MaxArmor": 100, - "Helmet": true + "SetArmor": false, + "Armor": 50, + "MaxArmor": 100, + "Helmet": true } ``` -## Параметры - -- `SetHealth` - Способ выдачи очков здоровья: - - `true` - сравнять с указанным; - - `false` - добавить к текущему. -- `Health` - Кол-во очков здоровья -- `MaxHealth` - Максимальное кол-во очков брони при добавлении - - Игнорируется, если `SetHealth: true`. - -- `SetArmor` - Способ выдачи брони: - - `true` - сравнять с указанным; - - `false` - добавить к текущему. -- `Armor` - Кол-во брони -- `MaxArmor` - Максимальное кол-во очков брони при добавлении - - Игнорируется, если `SetArmor: true`. -- `Helmet` - Выдавать ли шлем: - - `true` - выдавать; - - `false` - не выдавать. -- `Limits` - условия, при выполнении которых здоровье и броня будут установлены. \ No newline at end of file +Начиная со второго раунда игроку с этой привилегией в начале каждого раунда будет устанавливаться по 110 здоровья, а также добавляться шлем и 50 брони, но не более 100. diff --git a/readme/extensions/modules/spawn-items.md b/readme/extensions/modules/spawn-items.md index b72ba04..1115e08 100644 --- a/readme/extensions/modules/spawn-items.md +++ b/readme/extensions/modules/spawn-items.md @@ -4,37 +4,40 @@ _Данный модуль использует контроллер предметов (`VipM-ItemsController`), поставляемый в комплекте с системой привилегий._ +## Параметры + +| Название | Тип | По умолчанию\* | Описание | +| :------- | :------------------- | :------------- | :---------------------------------------------------- | +| Items | Массив предметов\*\* | - | Предметы, который будут выдаваться | +| Limits | Массив лимитов | Нет | Условия, при выполнении которых предметы будут выданы | + +_\* - если указано "-", то параметр является обязательным._ +_\*\* - предметы, зарегистрированные в [контроллере предметов](/readme/items.md)_ + ## Пример ```json { - "Module": "SpawnItems", - - "Limits": { - "Limit": "Round", - "Min": 2 + "Module": "SpawnItems", + + "Limits": { + "Limit": "Round", + "Min": 2 + }, + + "Items": [ + { + "Type": "Weapon", + "Name": "weapon_deagle", + "GiveType": "Replace" }, - - "Items": [ - { - "Type": "Weapon", - "Name": "weapon_deagle", - "GiveType": "Replace" - }, - { - "Type": "Weapon", - "Name": "weapon_hegrenade" - }, - "File:Items/DefuseKit" - ] + { + "Type": "Weapon", + "Name": "weapon_hegrenade", + "GiveType": "Add" + } + ] } ``` -## Параметры - -- `Limits` - условия, при выполнении которых предметы будут выданы. -- `Items` - список выдаваемых предметов. - -## Примечание - -За доступные типы предметов и за их параметры отвечают плагины-расширения для контроллера предемтов. \ No newline at end of file +Начиная со второго раунда игроку с такой привилегией будут выдаваться дигл и осколочная граната. diff --git a/readme/extensions/modules/vampire.md b/readme/extensions/modules/vampire.md new file mode 100644 index 0000000..029ddc8 --- /dev/null +++ b/readme/extensions/modules/vampire.md @@ -0,0 +1,36 @@ +# SpawnHealth + +Выдача очков здоровья за убийство игрока. + +## Параметры + +| Название | Тип | По умолчанию\* | Описание | +| :-------- | :------------- | :------------- | :------------------------------------------------------------------ | +| MaxHealth | Ц.Число | Нет | Максимальное кол-во здоровья, выше которого оно не будет выдаваться | +| ByKill | Ц.Число | 0 | Сколько очков здоровья будет выдаваться за обычное убийство | +| ByHead | Ц.Число | = ByKill | Сколько очков здоровья будет выдаваться за убийство в голову | +| ByKnife | Ц.Число | = ByKill | Сколько очков здоровья будет выдаваться за убийство ножом | +| ByGrenade | Ц.Число | = ByKill | Сколько очков здоровья будет выдаваться за убийство гранатой | +| Limits | Массив лимитов | Нет | Условия, при которых очки здоровья будут выданы | + +## Пример + +```json +{ + "Module": "Vampire", + + "ByKill": 5, + "ByHead": 7, + "ByKnife": 10, + + "MaxHealth": 100 +} +``` + +Игрок с данной привилегией получит: + +- 7 ХП за убийство в голову; +- 10 ХП за убийство ножом; +- 5 ХП за любое другое убийство. + +Также, игрок не будет получать очки здоровья выше 100 единиц. diff --git a/readme/extensions/modules/vip-in-tab.md b/readme/extensions/modules/vip-in-tab.md index 922cdc1..798f68c 100644 --- a/readme/extensions/modules/vip-in-tab.md +++ b/readme/extensions/modules/vip-in-tab.md @@ -1,20 +1,23 @@ # VipInTab +Модуль позволяет выводить для игрока статус VIP в TAB-таблице. + +## Параметры + +| Название | Тип | По умолчанию\* | Описание | +| :------- | :------------- | :------------- | :------------------------------------------------------------------------------ | +| Enabled | `true`/`false` | - | Нужно ли отображать VIP статус | +| Override | `true`/`false` | `false` | Должен ли VIP статус перекрывать дргие статусы, такие как `Bomb`, `Dead` и т.д. | + +_\* - если указано "-", то параметр является обязательным._ + ## Пример ```json { - "Module": "VipInTab", + "Module": "VipInTab", - "Enabled": true, - "Override": true + "Enabled": true, + "Override": false } ``` - -## Параметры - -- `Enabled` - будет ли отображаться статус VIP в таблице счёта. - - _Если честно, хз зачем этот параметр нужен :)_ -- `Override` - будет ли статус VIP перекрывать остальные статусы типа `Bomb`, `Dead` и т.д. - - `true` - будет; - - `false` - не будет. \ No newline at end of file diff --git a/readme/extensions/modules/weapon-menu.md b/readme/extensions/modules/weapon-menu.md index 7482f20..4ca1a8a 100644 --- a/readme/extensions/modules/weapon-menu.md +++ b/readme/extensions/modules/weapon-menu.md @@ -1,8 +1,6 @@ # WeaponMenu -## Пример - -Примеры можно посмотреть в стандартных настройках. +Меню с различными предметами. ## Параметры @@ -55,3 +53,7 @@ Если параметр `Title` не указан, пункт будет работать как пропуск строки. Если параметр `UseCounter` не указан, по умолчанию счётчик будет учитываться. + +## Пример + +Примеры можно посмотреть в стандартных настройках. diff --git a/readme/items.md b/readme/items.md index c8f8a00..81a4be7 100644 --- a/readme/items.md +++ b/readme/items.md @@ -7,17 +7,18 @@ ```jsonc { "Type": "", - "Name": "", - "": "", - /* ... */ - "": [] + "": "", + // ... + "": "" } ``` -- `` - название типа предмета. Определяется плагином-расширением, регистрирующим тип предмета. -- `` - какой-либо параметр предмета. Названия и типы параметров определяются плагином-расширением, добавляющим тип предмета. -- Поле `Name` необязательно, зависит от типа предмета. +- `` - название типа предмета, зарегистрированного в контроллере предметов. +- `` - ключ параметра предмета. Список доступных параметров ищите в описании к соответствующему типу предметов. +- `` - значение параметра. Значение должно соответствовать типу параметра\*. + +*\* - JSON поддерживает следующие типы данных:* ## Для авторов расширений предметов diff --git a/readme/json.md b/readme/json.md new file mode 100644 index 0000000..18a0a2b --- /dev/null +++ b/readme/json.md @@ -0,0 +1,96 @@ +# Памятка по формату JSON + +Ниже приведена некоторая информация про JSON, которая поможет при настройке системы привилегий и не только. + +## Типы данных + +JSON поддерживает следующие типы данных: + +- Числа (целые и дробные) - `123` или `1.23`; +- Строки - `"qwe"`; +- Булевые - `true`/`false`; +- Массивы - `[1, 2]`, могут содержать в себе значения любого типа разделённые запятой; +- Обьекты - `{"k1": "v1", "k2": 2}`, могут содержать в себе пары типа ключ:значение, где ключ - строка, а значение может быть любого типа. + +Примеры: + +```jsonc +{ + "Строка": "qwe", + "Целое число": 123, + "Дробное число": 1.23, + "Булево значение": false, + "Массив": [ + "ewq", + 321, + { + "Булево значение 2": true + } + ], + "Обьект": { + "Строка 2": "rty", + "Целое число 2": 456 + } +} +``` + +_Примечание: периодически возникают ошибки из-за лишних или недостающих скобок у обьектов и массивов, следите за тем, чтобы все открытые скобки были закрыты._ + +_Примечание: Значения типа `123` и `"123"` не являются взаимозаменяемыми, то есть, если ожидается числовое значение, то при указании второго варианта может возникнуть непредвиденная ошибка. Подобные ситуации могут обрабатываться на уровне кода, но в любом случае лучше использовать типы правильно._ + +## Запятые + +**Очень важно!** + +Формат JSON очень чувствителен к запятым. Их не должно быть там, где они не нужны, и они обязательно должны быть там, где они нужны. + +Где запятые **нужны**: + +- Между элементами массивов `[1, 2]` +- Между парами ключ:значение в обьектах `{"k1": 1, "k2": "v2"}` + +Где запятые **не нужны**: + +- После последнего элемента массива `[1, 2,]` +- После последней пары ключ:значение в обьекте `{"k1": 1, "k2": "v2",}` + +## Отступы и пробелы + +Формат JSON абсолютно не чувствителен к отступам, пробелам и пустым строкам. + +```jsonc +// Пример 1: +{ + "key1": "value 1", + "Key2": true, + + "key3": 321 +} + +// Пример 2: +{"key1":"value 1","Key2":true,"key3":321} +``` + +Оба примера спарсятся абсолютно одинаково. Разница лишь в том, что первый пример более удобен для восприятия человеком. + +Хоть сам формат JSON не чувствителен к отсупам, но очень желательно соблюдать отступы для вложенных значений, так как это + +Единственное место, где JSON учитывает пробелы - внутри строковых значений. + +## Инструменты + +Ниже приведены некоторые инструменты, которые позволят найти или не допустить ошибок при работе с JSON. + +### Visual Studio Code + +[Скачать](https://code.visualstudio.com/) + +Бесплатный мощный текстовый редактор, предназначенный для редактирования кода. Из коробки имеет поддержку многих языков, в том числе JSON. + +В ходе редактирования JSON-файла будет подсвечивать допущенные синтаксические ошибки, а также, при нажатии сочетания Shift+Alt+F может отформатировать файл, исправив в нём отступы. + +### JSONLint + +[Открыть](https://jsonlint.com/) + +Если нет желания скачивать VSCode, можно проверять JSON-файл на наличие синтаксических ошибок при помощи этого сайта. Также, сайт может помочь исправить отступы. diff --git a/readme/thirdparty-extensions.md b/readme/thirdparty-extensions.md index afa5f6f..219929d 100644 --- a/readme/thirdparty-extensions.md +++ b/readme/thirdparty-extensions.md @@ -1,23 +1,33 @@ # Сторонние расширения +Ниже приведены ссылки на сторонние расширения для компонентов VipModular. В том числе интеграции с различными плагинами. + ## Модули -- [MultiJump](https://github.com/ArKaNeMaN/VipM-M-MultiJump) - Даёт игрокам возможность совершать два или более прыжка -- [KillItems](https://github.com/ArKaNeMaN/VipM-M-KillItems) - Выдаёт предметы игроку после убийства другого игрока -- [WelcomeMessage](https://github.com/ArKaNeMaN/VipM-M-WelcomeMessage) - Приветственные сообщения +- [MultiJump](https://github.com/AmxxModularEcosystem/VipM-M-MultiJump) - Даёт игрокам возможность совершать два или более прыжка. +- [KillItems](https://github.com/AmxxModularEcosystem/VipM-M-KillItems) - Выдаёт предметы игроку после убийства другого игрока. +- [WelcomeMessage](https://github.com/AmxxModularEcosystem/VipM-M-WelcomeMessage) - Приветственные сообщения. ## Ограничения -- [ToD-DayTime](https://github.com/ArKaNeMaN/VipM-L-TimeOfDay) - Добавляет условие `ToD-DayTime`, которое срабатывает в указанное время суток из [Time Of Day](https://arkanaplugins.ru/plugin/11). -- [VipTest](https://github.com/ArKaNeMaN/VipM-L-VipTest) - Позволяет игрокам временно получить доступ к привилегиям -- [RWW-InProgress](https://github.com/ArKaNeMaN/VipM-L-RandomWeaponsWarmUP) - Добавляет условие, которое верно во время разминки из плагина [[fork] Random Weapons WarmUP](https://dev-cs.ru/resources/384/) -- [SnipersRBS-CanTakeAwp](https://github.com/ArKaNeMaN/VipM-L-SnipersRBS) - Интеграция с [Snipers RBS](https://fungun.net/shop/?p=show&id=48). Добавляет условие, которое верно только тогда, когда игрок может взять АВП. -- [GCMS-Service & GCMS-Member](https://github.com/ArKaNeMaN/VipM-L-GameCMS) - Интеграция с [GameCMS API](https://cs-games.club/index.php?resources/gamecms-api.4/). +- [VipTest](https://github.com/AmxxModularEcosystem/VipM-L-VipTest) - Позволяет игрокам временно получить доступ к привилегиям. +- [RWW-InProgress](https://github.com/AmxxModularEcosystem/VipM-L-RandomWeaponsWarmUP) - Добавляет условие, которое верно во время разминки из плагина [Random Weapons WarmUP](https://github.com/ArKaNeMaN/amxx-RandomWeaponsWarmUP). +- [SnipersRBS-CanTakeAwp](https://github.com/AmxxModularEcosystem/VipM-L-SnipersRBS) - Интеграция с [Snipers RBS](https://fungun.net/shop/?p=show&id=48) от SKAJIbnEJIb. Добавляет условие, которое верно только тогда, когда игрок может взять АВП. +- [GCMS-Service & GCMS-Member](https://github.com/AmxxModularEcosystem/VipM-L-GameCMS) - Интеграция с [GameCMS API](https://cs-games.club/index.php?resources/gamecms-api.4/) от [zhorzh78](https://dev-cs.ru/members/326/). +- [AWMLimiter-CanTakeAwp](https://gist.github.com/ArKaNeMaN/db60225785d7e5bac1a73bf7a8466ab2) - Интеграция с [AWP Limiter](https://github.com/Nord1cWarr1or/AWP-Limiter) от [Nordic Warrior](https://dev-cs.ru/members/3093/). +- [MMM-VoteStarted](https://gist.github.com/ArKaNeMaN/a5607b74e991646fb0754e7dd8ba3a0c) - Интеграция с [MapManager Modular](https://github.com/Mistrick/MapManagerModular) от [Mistrick](https://dev-cs.ru/members/76/). +- [AwpOFF-Restricted](https://gist.github.com/ArKaNeMaN/f3c53992b0f041a647068d74b63aeb54) - Интеграция с [Awp OFF](https://dev-cs.ru/resources/225/) от [paffgame](https://dev-cs.ru/members/124/). +- [Radius-AwpRestricted](https://gist.github.com/ArKaNeMaN/42c7201e1bb19e2d2e3a72782c695f7b) - Интеграция с [AWP Restrictions](https://goldsrc.ru/resources/137/) от Radius. ## Типы предметов -- [Cwapi](https://github.com/ArKaNeMaN/VipM-I-Cwapi) - Кастомное оружие из плагина [Custom Weapons API](https://github.com/ArKaNeMaN/amxx-CustomWeaponsAPI). -- [AUW-Weapon](https://github.com/ArKaNeMaN/VipM-I-AdvancedUltimateWeapons) - Позволяет выдавать кастомное оружие из плагина [Advanced Ultimate Weapons](https://dev-cs.ru/resources/945/) -- [HealthNade](https://github.com/ArKaNeMaN/VipM-I-HealthNade) - Позволяет выдавать лечащую гранату из плагина [[fork] Healthnade](https://dev-cs.ru/resources/1271/) -- [BlackSignature-Molotov](https://github.com/ArKaNeMaN/VipM-I-BlackSignature-Molotov) - Позволяет выдавать [коктейль молотова от BlackSignature](https://shorturl.at/jtzGZ). -- [DecoyGrenade & HolyGrenade](https://github.com/ArKaNeMaN/VipM-I-Chel74Nades) - Позволяет выдавать [ложную](https://c-s.net.ua/forum/topic91919.html) и [святую](https://c-s.net.ua/forum/topic92517.html) гранаты от CHEL74. +- [Cwapi](https://github.com/AmxxModularEcosystem/VipM-I-Cwapi) - Кастомное оружие из плагина [Custom Weapons API](https://github.com/ArKaNeMaN/amxx-CustomWeaponsAPI). +- [AUW-Weapon](https://github.com/AmxxModularEcosystem/VipM-I-AdvancedUltimateWeapons) - Позволяет выдавать кастомное оружие из плагина [Advanced Ultimate Weapons](https://dev-cs.ru/resources/945/) от [steelzzz](https://dev-cs.ru/members/19/). +- [HealthNade](https://github.com/AmxxModularEcosystem/VipM-I-HealthNade) - Позволяет выдавать лечащую гранату из плагина [[fork] Healthnade](https://dev-cs.ru/resources/1271/) от [BlackSignature](https://dev-cs.ru/members/1111/). +- [BlackSignature-Molotov](https://github.com/ArKaNeMaN/VipM-I-BlackSignature-Molotov) - Позволяет выдавать [коктейль молотова](https://shorturl.at/jtzGZ) от [BlackSignature](https://dev-cs.ru/members/1111/). +- [DecoyGrenade & HolyGrenade](https://github.com/AmxxModularEcosystem/VipM-I-Chel74Nades) - Позволяет выдавать [ложную](https://c-s.net.ua/forum/topic91919.html) и [святую](https://c-s.net.ua/forum/topic92517.html) гранаты от [CHEL74](https://dev-cs.ru/members/3489/). +- [ACS-Injection](https://gist.github.com/ArKaNeMaN/14d46548bbdbc7dacec5425e20315abd) - Интеграция с [[ACS] INJECTION](https://dev-cs.ru/resources/1582/) от [Refresh](https://dev-cs.ru/members/10396/). +- [BananaBomb](https://gist.github.com/ArKaNeMaN/5c8ecf410b1574ccdbba6da39a0bb654) - Интеграция с [Banana Bomb](https://dev-cs.ru/threads/30559/) от [CHEL74](https://dev-cs.ru/members/3489/). +- [Medusa-Molotov](https://gist.github.com/ArKaNeMaN/13bdfa31b2262c61b3adce9845c9e893) - Интеграция с [[GRENADE] Molotov](https://dev-cs.ru/resources/1160/) От [medusa](https://dev-cs.ru/members/65/). +- [UW-Weapon](https://gist.github.com/ArKaNeMaN/8720ae20f87245c0fe00d28c387065e0) - Интеграция с [Ultimate Weapons](https://fungun.net/shop/?p=show&id=82) от SKAJIbnEJIb. +- [WellAsGood-Molotov](https://gist.github.com/ArKaNeMaN/970685239663cb1b7a7791c0d2c55c6e) - Интеграция с [[Reapi] Molotov](https://dev-cs.ru/resources/1166/) От [wellasgood](https://dev-cs.ru/members/1657/).