Skip to content

Commit 2d23263

Browse files
committed
fix: add plugins ru translation
1 parent 5762b43 commit 2d23263

File tree

22 files changed

+789
-0
lines changed

22 files changed

+789
-0
lines changed

content/ru/6.plugins/0.plugins.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
title: Plugins
3+
navigation: false
4+
---
5+
Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
---
2+
title: Особенности
3+
description: Откройте для себя основные особенности и типичные сценарии использования плагина, включая реальные примеры, где он проявляет себя наилучшим образом.
4+
icon: lucide:star
5+
---
6+
7+
**Плагин Config System** — это универсальный и мощный инструмент, предназначенный для управления файлами конфигурации других плагинов в экосистеме Plugify. Он поддерживает несколько форматов файлов, включая **JSON**, **XML** и **KeyValues**, и может быть расширен с помощью подмодулей для поддержки дополнительных форматов. Плагин позволяет беспрепятственно читать, записывать и объединять файлы конфигурации, гарантируя сохранение пользовательских настроек даже во время обновлений плагинов.
8+
9+
## **Ключевые особенности**
10+
11+
### **1. Поддержка нескольких форматов**
12+
- Поддерживает популярные форматы файлов конфигурации, включая:
13+
- **JSON**
14+
- **XML**
15+
- **KeyValues3**
16+
- Расширяемая архитектура позволяет добавлять поддержку новых форматов через подмодули.
17+
18+
### **2. Чтение и запись конфигураций**
19+
- Легко читайте и записывайте файлы конфигурации из других плагинов.
20+
- Предоставляет простой и интуитивно понятный API для управления данными конфигурации.
21+
22+
### **3. Объединение конфигураций**
23+
- Автоматически объединяет пользовательские конфигурации с обновленными конфигурациями плагинов.
24+
- Гарантирует сохранение пользовательских настроек во время обновлений плагинов.
25+
26+
### **4. Двойное расположение конфигураций**
27+
- **Папка плагина**: Основные файлы конфигурации хранятся в папке плагина.
28+
- **Папка пользовательских конфигураций**: Пользовательские конфигурации хранятся в `res/configs`, что гарантирует, что они не будут перезаписаны во время обновлений.
29+
30+
### **5. Интеграция с системой обновлений**
31+
- Беспрепятственно работает с системой обновлений Plugify для объединения обновленных конфигураций с пользовательскими настройками.
32+
- Предотвращает потерю пользовательских настроек во время обновлений плагинов.
33+
34+
### **6. Легковесность и эффективность**
35+
- Минимальные накладные расходы для высокопроизводительных приложений.
36+
- Оптимизирован как по скорости, так и по использованию памяти.
37+
38+
## **Сценарии использования**
39+
40+
### **1. Управление конфигурацией плагинов**
41+
- Управляйте файлами конфигурации для других плагинов в экосистеме Plugify.
42+
- Предоставляйте последовательный и удобный способ обработки настроек плагинов.
43+
44+
### **2. Сохранение пользовательских настроек**
45+
- Гарантируйте сохранение пользовательских конфигураций во время обновлений плагинов.
46+
- Беспрепятственно объединяйте обновленные конфигурации с пользовательскими настройками.
47+
48+
### **3. Поддержка нескольких форматов**
49+
- Поддерживайте несколько форматов файлов конфигурации для гибкости и совместимости.
50+
- Расширяйте систему для поддержки пользовательских форматов по мере необходимости.
51+
52+
### **4. Динамические обновления конфигурации**
53+
- Динамически обновляйте файлы конфигурации во время выполнения.
54+
- Применяйте изменения без перезапуска приложения или плагина.
Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
---
2+
title: Как использовать
3+
description: Практические примеры того, как читать, записывать и управлять файлами конфигурации из разных плагинов.
4+
icon: lucide:book-open
5+
---
6+
7+
**Плагин Configs** предоставляет простой API для управления файлами конфигурации в экосистеме Plugify. Основные функции включают `ReadConfig`, `WriteConfig` и `MergeConfig`. Это руководство проведет вас через использование этих функций с практическими примерами.
8+
9+
## **Начало работы**
10+
11+
Чтобы использовать плагин Configs, сначала убедитесь, что он загружен. После загрузки вы можете получить доступ к его функциям через API Plugify. Имя плагина — `configs`.
12+
13+
## **Чтение конфигурации**
14+
15+
Функция `ReadConfig` используется для чтения файла конфигурации из каталога другого плагина. Она автоматически определяет формат файла и возвращает данные в виде строки.
16+
17+
### **Пример: Чтение файла JSON**
18+
19+
Предположим, у вас есть плагин с именем `my_plugin`, который имеет файл конфигурации `config.json`, и пользователь создал свой собственный файл `user.json` в папке `res/configs`.
20+
21+
**Код C++**
22+
```cpp
23+
#include <iostream>
24+
#include "configs.hpp" // Сгенерированный заголовочный файл
25+
26+
void ReadMyPluginConfig() {
27+
// Чтение файла конфигурации из 'my_plugin'
28+
const char* result = configs::ReadConfig("my_plugin", "config.json");
29+
if (result) {
30+
std::cout << result << std::endl;
31+
delete[] result; // Освободить память, выделенную плагином
32+
}
33+
}
34+
```
35+
36+
**Файл конфигурации (`my_plugin/config.json`)**
37+
```json
38+
{
39+
"setting1": "default_value",
40+
"setting2": 123
41+
}
42+
```
43+
44+
**Пользовательский файл конфигурации (`res/configs/my_plugin/user.json`)**
45+
```json
46+
{
47+
"setting1": "user_value"
48+
}
49+
```
50+
51+
**Ожидаемый вывод**
52+
Функция `ReadConfig` автоматически объединит пользовательскую конфигурацию с конфигурацией по умолчанию.
53+
```json
54+
{
55+
"setting1": "user_value",
56+
"setting2": 123
57+
}
58+
```
59+
60+
### **Важное примечание**
61+
Плагин Configs выделяет память для возвращаемой строки, которую необходимо освободить вручную с помощью `delete[] result;` после использования, чтобы избежать утечек памяти.
62+
63+
## **Запись конфигурации**
64+
65+
Функция `WriteConfig` используется для записи строки в файл конфигурации в папке `res/configs`.
66+
67+
### **Пример: Запись в файл конфигурации**
68+
Этот пример показывает, как записать новую конфигурацию в файл `user.json` для `my_plugin`.
69+
70+
**Код C++**
71+
```cpp
72+
#include "configs.hpp"
73+
74+
void WriteMyPluginConfig() {
75+
const char* newData = R"({ "setting1": "new_user_value", "setting3": true })";
76+
// Запись новой конфигурации в 'user.json' для 'my_plugin'
77+
configs::WriteConfig("my_plugin", "user.json", newData);
78+
}
79+
```
80+
81+
**Итоговый `user.json`**
82+
```json
83+
{
84+
"setting1": "new_user_value",
85+
"setting3": true
86+
}
87+
```
88+
89+
## **Объединение конфигураций**
90+
91+
Функция `MergeConfig` объединяет два файла конфигурации. Это полезно, когда вам нужно объединить конфигурацию по умолчанию с пользовательской конфигурацией вручную.
92+
93+
### **Пример: Объединение конфигурации по умолчанию с пользовательской конфигурацией**
94+
Этот пример показывает, как объединить `default.json` с `user.json`.
95+
96+
**Код C++**
97+
```cpp
98+
#include <iostream>
99+
#include "configs.hpp"
100+
101+
void MergeMyConfigs() {
102+
const char* defaultConfig = R"({ "setting1": "default", "setting2": 10 })";
103+
const char* userConfig = R"({ "setting1": "user" })";
104+
105+
const char* mergedResult = configs::MergeConfig(defaultConfig, userConfig, "json");
106+
if (mergedResult) {
107+
std::cout << mergedResult << std::endl;
108+
delete[] mergedResult;
109+
}
110+
}
111+
```
112+
113+
**Ожидаемый вывод**
114+
```json
115+
{
116+
"setting1": "user",
117+
"setting2": 10
118+
}
119+
```
120+
121+
## **Рекомендации**
122+
- **Всегда освобождайте память**: Не забывайте освобождать память, возвращаемую `ReadConfig` и `MergeConfig`, с помощью `delete[]`.
123+
- **Используйте правильные имена файлов**: Убедитесь, что вы используете правильные имена файлов конфигурации при чтении или записи.
124+
- **Обрабатывайте ошибки**: Проверяйте наличие нулевых указателей при чтении конфигураций, чтобы корректно обрабатывать ошибки.
125+
126+
## **Заключение**
127+
128+
Плагин Configs предоставляет простой, но мощный способ управления файлами конфигурации в Plugify. Следуя примерам и рекомендациям, изложенным в этом руководстве, вы можете эффективно читать, записывать и объединять конфигурации, обеспечивая при этом сохранение пользовательских настроек.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Руководство
3+
description: Подробное руководство по эффективному использованию плагина, которое поможет вам максимально использовать его возможности и функционал для ваших нужд.
4+
icon: lucide:book-open-text
5+
---
6+
7+
::alert{type="warning" icon="lucide:triangle-alert"}
8+
Этот раздел в настоящее время находится в разработке.
9+
::
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
title: Config System
2+
icon: lucide:settings-2
3+
navigation.redirect: /ru/plugins/config-system/features
4+
collapse: true
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Особенности
3+
description: Откройте для себя основные особенности и типичные сценарии использования плагина, включая реальные примеры, где он проявляет себя наилучшим образом.
4+
icon: lucide:star
5+
---
6+
7+
::alert{type="warning" icon="lucide:triangle-alert"}
8+
Плагин в настоящее время находится в разработке.
9+
::
Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
---
2+
title: Установка
3+
description: Подробное руководство по установке плагина, включая системные требования и зависимости.
4+
icon: lucide:download
5+
---
6+
7+
Плагин **Admins** можно установить двумя способами: вручную скачав релиз или используя менеджер пакетов Plugify. В этом руководстве описаны оба метода с пошаговыми инструкциями.
8+
9+
## **Метод 1: Ручная установка**
10+
11+
::steps
12+
### **Скачивание релиза**
13+
1. Перейдите в [репозиторий плагина Admins](https://github.com/untrustedmodders/plugify-admins).
14+
2. Откройте раздел **Releases**.
15+
3. Скачайте последний архив с релизом (например, `admins.zip`).
16+
17+
### **Распаковка архива**
18+
1. Распакуйте загруженный архив во временную папку.
19+
20+
### **Размещение плагина в папке Plugins**
21+
1. Найдите папку `plugins` в директории установки Plugify.
22+
2. Скопируйте распакованные файлы плагина в эту папку.
23+
24+
### **Проверка установки**
25+
1. Запустите Plugify.
26+
2. Плагин Admins должен быть доступен для использования.
27+
::
28+
29+
## **Метод 2: Установка через менеджер пакетов**
30+
31+
::steps
32+
### **Добавление репозитория (если требуется)**
33+
Если плагин Admins не найден в стандартном репозитории, необходимо добавить репозиторий вручную.
34+
35+
#### **Вариант A: Добавление через командную строку**
36+
1. Выполните следующую команду в терминале:
37+
```bash
38+
plg repo https://untrustedmodders.github.io/plugify-admins/admins.json
39+
```
40+
41+
#### **Вариант B: Добавление через `plugify.padmin`**
42+
1. Откройте файл `plugify.padmin` в директории установки Plugify.
43+
2. Добавьте следующую строку в раздел `repositories`:
44+
```json
45+
{
46+
"repositories": [
47+
"https://untrustedmodders.github.io/plugify-admins/admins.json"
48+
]
49+
}
50+
```
51+
52+
### **Установка плагина**
53+
1. Выполните следующую команду в терминале:
54+
```bash
55+
plg install admins
56+
```
57+
58+
### **Проверка установки**
59+
1. Запустите Plugify.
60+
2. Плагин Admins должен быть установлен и готов к использованию.
61+
::
62+
63+
## **Структура папок**
64+
65+
После установки плагин Admins должен иметь следующую структуру папок:
66+
67+
::file-tree
68+
---
69+
tree:
70+
- res/plugins:
71+
- admins:
72+
- bin:
73+
- admins.dll
74+
- libadmins.so
75+
- ^admins.pplugin^
76+
---
77+
::
78+
79+
### **Пояснение**
80+
- **`res/plugins/admins`**: Корневая папка плагина Admins.
81+
- **`bin`**: Содержит скомпилированные бинарные файлы плагина (`.dll` для Windows, `.so` для Linux/macOS).
82+
- **`admins.pplugin`**: Манифест-файл плагина, описывающий его и экспортируемые функции.
83+
84+
## **Устранение неполадок**
85+
86+
### **Плагин не найден**
87+
- Убедитесь, что URL репозитория указан правильно и доступен.
88+
- Проверьте, что репозиторий добавлен в `plugify.padmin` или через команду `plg repo <url>`.
89+
90+
### **Сбой установки**
91+
- Проверьте подключение к интернету.
92+
- Убедитесь, что у вас установлена последняя версия Plugify.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Руководство
3+
description: Подробное руководство по эффективному использованию плагина, чтобы максимально раскрыть его возможности и функциональность под ваши задачи.
4+
icon: lucide:book-open-text
5+
---
6+
7+
::alert{type="warning" icon="lucide:triangle-alert"}
8+
Раздел находится в разработке.
9+
::
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
title: Admin System
2+
icon: lucide:shield-check
3+
navigation.redirect: /ru/plugins/admin-system/features
4+
collapse: true

0 commit comments

Comments
 (0)