From 37dac2603265e821f93579cb9d21ddba55af311a Mon Sep 17 00:00:00 2001 From: MeexReay Date: Tue, 6 May 2025 16:24:03 +0300 Subject: [PATCH] add using as library to readme --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index bf73f10..6a8c75a 100644 --- a/README.md +++ b/README.md @@ -30,6 +30,28 @@ cargo run cargo build -r ``` +### Использовать как библиотеку + +Вы можете использовать проект как библиотеку для своих серверов + +Пример добавления в `Cargo.toml`: + +```toml +rust_mc_serv = { git = "https://github.com/GIKExe/rust_minecraft_server.git" } +``` + +Пример запуска сервера: + +```rust +let config = Arc::new(Config::default()); +let mut server = ServerContext::new(config); + +server.add_listener(Box::new(ExampleListener)); // Добавляем пример листенера +server.add_packet_handler(Box::new(ExamplePacketHandler)); // Добавляем пример пакет хандлера + +start_server(Arc::new(server)); +``` + ## Конфигурация По умолчанию, конфиг будет создан в файле `config.toml` в рабочей директории. Чтобы изменить этот путь, укажите его в первом аргументе к серверу, пример: `./rust_mc_serv /path/to/config.toml`