mirror of
https://github.com/kuitoi/kuitoi-Server.git
synced 2026-04-14 11:56:16 +00:00
Update docs
This commit is contained in:
33
docs/setup/readme.md
Normal file
33
docs/setup/readme.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# Hello from KuiToi Server
|
||||
|
||||
## Start
|
||||
|
||||
* Need **Python 3.10.x** to start!
|
||||
* After cloning use this:
|
||||
```bash
|
||||
$ python3 --version # Python 3.10.6
|
||||
$ python3 main.py --help # Show help message
|
||||
$ python3 main.py # Start server
|
||||
```
|
||||
|
||||
## Setup
|
||||
|
||||
* After starting server creating `kuitoi.yaml`; Default:
|
||||
```yaml
|
||||
!!python/object:modules.ConfigProvider.config_provider.Config
|
||||
Auth:
|
||||
key: null
|
||||
private: true
|
||||
Game:
|
||||
map: gridmap_v2
|
||||
max_cars: 1
|
||||
players: 8
|
||||
Server:
|
||||
debug: true
|
||||
description: This server uses KuiToi!
|
||||
name: KuiToi-Server
|
||||
server_ip: 0.0.0.0
|
||||
server_port: 30814
|
||||
```
|
||||
* Server can't start without BEAM Auth.key
|
||||
|
||||
Reference in New Issue
Block a user