SantaSpeen/KuiToi-Server
1
0
Fork 0
mirror of https://github.com/kuitoi/kuitoi-Server.git synced 2026-04-22 16:18:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update en docs

Browse Source
This commit is contained in:
Maxim Khomutov
2023-07-15 16:32:07 +03:00
parent 50b479c396
commit 13ff3207b2
7 changed files with 219 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

70
docs/en/setup/readme.md
View File

@@ -1,18 +1,32 @@
# Hello from KuiToi Server
# Greetings from KuiToi Server
## Start
## Well, let's begin
* Need **Python 3.10.x** to start!
* After cloning use this:
###### _(Here are the commands for Linux)_
* **Python 3.10.x** is required to run the server! It won't work on Python 3.11...
* You can check the version of your Python installation with the following command:
```bash
$ python3 --version # Python 3.10.6
$ python3 main.py --help # Show help message
$ python3 main.py # Start server
python3 --version # Python 3.10.6
```
* Clone the repository and navigate to it.
* Install everything that's needed.
* Then, using my "script", remove all unnecessary files and move to the core source code.
```bash
git clone -b Stable https://github.com/kuitoi/KuiToi-Server.git && cd KuiToi-Server
pip install -r requirements.txt
mv ./src/ $HOME/ktsrc/ && rm -rf ./* && mv $HOME/ktsrc/* . && rm -rf $HOME/ktsrc
```
* Here's how to view information about the server and start it:
```bash
python3 main.py --help # Displays all available commands
python3 main.py # Starts the server
```
## Setup
## Configuration
* After starting server creating `kuitoi.yaml`; Default:
* After starting the server, a `kuitoi.yaml` file will be created.
* By default, it looks like this:
```yaml
!!python/object:modules.ConfigProvider.config_provider.Config
Auth:
@@ -23,11 +37,39 @@ Game:
max_cars: 1
players: 8
Server:
debug: true
description: This server uses KuiToi!
debug: false
description: Welcome to KuiToi Server!
language: en
name: KuiToi-Server
server_ip: 0.0.0.0
server_port: 30814
```
* Server can't start without BEAM Auth.key
server_port: 30813
WebAPI:
enabled: false
secret_key: <random_key>
server_ip: 127.0.0.1
server_port: 8433
```
### Auth
* If you set `private: false` and do not set a `key`, the server will request a BeamMP key and will not start without it.
* By entering a BeamMP key, the server will appear in the launcher list.
* You can get a key here: [https://beammp.com/k/keys ↗](https://beammp.com/k/keys)
### Game
* `map` specifies only the name of the map. That is, open the mod with the map in `map.zip/levels` - the name of the map will be there, and that's what you need to insert.
* `max_cars` - the maximum number of cars per player
* `players` - the maximum number of players
### Server
* `debug` - should debug messages be displayed (for experienced users only; slightly affects performance)
* `description` - server description for the BeamMP launcher
* `language` - the language in which the server will run (currently available: en, ru)
* `name` - server name for the BeamMP launcher
* `server_ip` - the IP address to be used by the server (for experienced users only; defaults to 0.0.0.0)
* `server_port` - the port on which the server will run
### WebAPI
##### _Docs are not ready yet_