Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

way better, new, more human and native-like readme (russian and english one) #897

Open
wants to merge 6 commits into
base: 1.16.5
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 21 additions & 21 deletions docs/README_EN.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
![](https://img.shields.io/badge/Forge-36.2.39-brightgreen.svg?colorB=469C00)
![](https://img.shields.io/badge/Spigot-1.16.5-brightgreen.svg?colorB=469C00)

CatServer is a high-performance Forge+Bukkit+Spigot server<br>
The early 1.16.5 version was co-developed with the LoliServer project team. Currently supports most mods and plugins to run stably stably<br>
It will now continue to be maintained as a fork of LoliServer, providing better optimization and compatibility<br>
You can download the latest version from [Jenkins](https://jenkins.rbqcloud.cn:30011/job/CatServer-1.16.5/lastSuccessfulBuild/)<br>
CatServer is a high-performance Forge+Bukkit+Spigot server core.<br>
The early 1.16.5 version was co-developed with the LoliServer project team. Currently supports most mods and plugins to run stably stably.<br>
It will now continue to be maintained as a fork of LoliServer, providing better optimization and compatibility.<br>
You can download the latest version from [Jenkins](https://jenkins.rbqcloud.cn:30011/job/CatServer-1.16.5/lastSuccessfulBuild/).<br>

All versions of CatServer:
| Version | Status |
Expand All @@ -18,30 +18,30 @@ All versions of CatServer:
QQ Group: [591257](https://jq.qq.com/?_wv=1027&k=5B5aKkW) | Telegram: [@CatServer](https://t.me/CatServer) | Discord: [点击加入](https://discord.gg/wvBJN4d)

### Features
Use self-writing optimization and some Paper optimization to greatly improve performance<br>
Have a powerful Remap system to ensure good plugin compatibility<br>
Good compatibility with FakePlayer<br>
Fix most vanilla bug to safety<br>
Configuration provide user-friendly options<br>
Provide API to allow plugins to interact with mods easily<br>
Uses self-written optimization and some Paper optimization to greatly improve performance.<br>
Has a powerful Remap system to ensure good plugin compatibility.<br>
Has a good compatibility with FakePlayer.<br>
Fixes most vanilla bugs related to safety.<br>
Has very user-friendly configuration.<br>
Provides API allowing plugins to interact with mods easily.<br>

### Installation
1. Download or build the latest server
2. Create startup script and run (Sample script: java -Xmx2G -jar CatServer-1.16.5-xxxxxxx-server.jar)
3. Wait for the libraries file download complete on the first startup
1. Download or build the latest version.
2. Create startup script and run (Sample script: java -Xmx2G -jar CatServer-1.16.5-xxxxxxx-server.jar).
3. Wait for the libraries and assets to download on the first startup.

##### Recommended to run on Java8 or 11, although Java12-17 and later versions are supported, there may be compatibility issues with mods and plugins
##### Recommended to run on Java 8 or 11, although Java 12-17 and later versions are supported, although there may be compatibility issues with mods and plugins.

### Building
- 1.Clone 1.16.5 branch: `git clone -b 1.16.5 https://github.com/Luohuayu/CatServer.git`
- 2.Change directory: `cd CatServer`
- 3.Setup project: `gradlew setup`
- 4.Generate patch(If you modify the Minecraft code): `gradlew genPatches`
- 5.Build: `gradlew buildCatServer`
- 1.Clone 1.16.5 branch: `git clone -b 1.16.5 https://github.com/Luohuayu/CatServer.git`.
- 2.Open directory: `cd CatServer`.
- 3.Setup project: `gradlew setup`.
- 4.Generate patch(If you modify the Minecraft code): `gradlew genPatches`.
- 5.Build: `gradlew buildCatServer`.

### Generate dependency
1. Run the server, Wait for the libraries to be downloaded and generate the SRG
2. Import the following jar in order as dependencies (Add more libraries if you need to use):
1. Run the server, Wait for the libraries to download and generate the SRG.
2. Import the following jar in order as dependencies (Add more libraries if you need):
```
libraries/net/minecraftforge/forge/{MC_VERSION}-{FORGE_VERSION}/forge-{MC_VERSION}-{FORGE_VERSION}-universal.jar
libraries/net/minecraftforge/forge/{MC_VERSION}-{FORGE_VERSION}/forge-{MC_VERSION}-{FORGE_VERSION}-server.jar
Expand Down
40 changes: 26 additions & 14 deletions docs/README_RU.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@
![](https://img.shields.io/badge/Spigot-1.16.5-brightgreen.svg?colorB=469C00)

<b>The translation is not necessarily correct, it is recommended to view the English version.</b>
<b>Перевод может содержать ошибки и другие неточности для большей ясности смотрите Английскую версию.</b>
<b>Перевод может содержать ошибки и другие неточности. Мы рекомендуем осмотрить версию на английском языке.</b>

### CatServer — высокопроизводительный сервер для модов и плагинов на базе Forge+Bukkit+Spigot.
Ранняя версия 1.16.5 была разработана совместно с командой проекта LoliServer. В настоящее время поддерживает обширное количество модов и плагинов для стабильной работы
Теперь он будет по-прежнему поддерживаться как ответвление LoliServer, обеспечивая лучшую оптимизацию и совместимость.
### CatServer — высокопроизводительное серверное ядро, поддерживающее моды и плагины на базе Forge+Bukkit+Spigot.
Ранняя версия 1.16.5 была разработана в коллаборации с командой проекта LoliServer. В настоящее время стабильно поддерживает и запускает обширное количество модов и плагинов.
Теперь это ядро будет поддерживаться как ответвление LoliServer, обеспечивая улчушенную оптимизацию и совместимость.
Вы можете скачать последнюю версию с [Jenkins](https://jenkins.rbqcloud.cn:30011/job/CatServer-1.16.5/lastSuccessfulBuild/)

Все доступные версии CatServer:
Expand All @@ -22,23 +22,35 @@ QQ Группа: [591257](https://jq.qq.com/?_wv=1027&k=5B5aKkW) | Телегр
](https://discord.gg/wvBJN4d)

### Особенности
Используется самописная оптимизация и некоторая оптимизация Paper, чтобы значительно повысить производительность.
Используется самописная оптимизация + некоторая оптимизация Paper, чтобы значительно повысить производительность.
Имеется мощная Remap-система для обеспечения хорошей совместимости плагинов.
Хорошая совместимость с FakePlayer.
Исправлено большинство ванильных ошибок безопасности.
Конфигурация предоставляет удобные для пользователя опции.
Отличное API для лучшего взаимодейтсвия плагинов с модами.
Удобная конфигурация для любого человека.
API позволяющий плагинам взаимодействовать с модами.

### Установка
Загрузите или соберите последний сервер
Создайте скрипт запуска и запустите `(пример скрипта: java -Xmx2G -
jar CatServer-1.16.5-xxxxxxx-server.jar)`
jar CatServer-1.16.5-xxxxxxx-server.jar)`.
Дождитесь завершения загрузки файлов библиотек при первом запуске.
Рекомендуется запускать на Java 8 или 11, хотя поддерживаются Java12-17 и более поздние версии, **могут быть проблемы совместимости с модами и плагинами**.
Рекомендуется запускать на Java 8 или 11, хотя поддерживаются Java 12-17 и более поздние версии, **могут быть проблемы совместимости с модами и плагинами**.

### Сборка
1. Клонируем ветку 1.16.5: `git clone -b 1.16.5 https://github.com/Luohuayu/CatServer.git`
2. Переходим в каталог: `cd CatServer`
3. Запускаем настройку проекта: `gradlew setup`
4. Сгенерируем патчи (если вы изменяете код Minecraft): `gradlew genPatches`
5. Собираем проект: `gradlew buildCatServer`
1. Клонируйте ветку 1.16.5: `git clone -b 1.16.5 https://github.com/Luohuayu/CatServer.git`
2. Перейдите в директорию: `cd CatServer`
3. Запустите настройку проекта: `gradlew setup`
4. Сгенерируйте патчи (если вы изменяете код Minecraft): `gradlew genPatches`
5. Собирите проект: `gradlew buildCatServer`


### Сгенерируйте зависимость
1. Запустите сервер, подождите пока скачаются библиотеки и пока сгенерируется SRG
2. Проимпортиуйте .jar в порядке с зависимостями (Добавьте больше библиотек при желании):
```
libraries/net/minecraftforge/forge/{MC_VERSION}-{FORGE_VERSION}/forge-{MC_VERSION}-{FORGE_VERSION}-universal.jar
libraries/net/minecraftforge/forge/{MC_VERSION}-{FORGE_VERSION}/forge-{MC_VERSION}-{FORGE_VERSION}-server.jar
libraries/net/minecraft/server/{MC_VERSION}-{MCP_VERSION}/server-{MC_VERSION}-{MCP_VERSION}-srg.jar
libraries/net/minecraftforge/eventbus/{EVENTBUS_VERSION}/eventbus-{EVENTBUS_VERSION}.jar
libraries/net/minecraftforge/forgespi/{SPI_VERSION}/forgespi-{SPI_VERSION}.jar
```