https://github.com/pwalig/mini-rts-server
server for minimalistic RTS game
https://github.com/pwalig/mini-rts-server
bsd-sockets c-plus-plus college-assignment college-project cpp game game-server rts rts-game server tcp tcp-server
Last synced: 8 months ago
JSON representation
server for minimalistic RTS game
- Host: GitHub
- URL: https://github.com/pwalig/mini-rts-server
- Owner: pwalig
- Created: 2024-12-03T15:06:14.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2025-02-01T19:27:25.000Z (8 months ago)
- Last Synced: 2025-02-01T19:31:16.414Z (8 months ago)
- Topics: bsd-sockets, c-plus-plus, college-assignment, college-project, cpp, game, game-server, rts, rts-game, server, tcp, tcp-server
- Language: C++
- Homepage: https://p-walig.itch.io/mini-rts
- Size: 129 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 15
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mini-RTS-server
server for minimalistic RTS game
**server is linux only**, can only be compiled for linux and will only run on linux
# Building with CMake
Configure project:
```
mkdir build
cd build
cmake ..
```
Once configuration is successful build project with avaliable tool
for example
```
make
```
# Building with Zig
Project can also be built with [zig](https://ziglang.org/)
```
zig build
```
> zig c++ compiler produces much smaller executable
Command above will target the native system. If you are on other system than linux, then you can cross compile mini-RTS-server to linux (since server is **linux only**).
```
zig build -Dtarget=x86_64-linux
```
You can replace `x86_64` with your cpu architecture if you happen to have a different one.
You will find the executable in `zig-out/bin/` directory.
# Running server
`./mini-rts-server [config file]`
# Configuring server
`[config file]` can adjust game rules. `[config file]` consists of name value pairs.
### Available values:
* `millis` - duration of one game step [default: 200]
* `maxPlayers` - how many players can play at once [default: 16]
* `boardX` - x dimention of the board [default: 256]
* `boardY` - y dimention of the board[default: 256]
* `unitsToWin` - how many units player has to aquire to win the game [default: 50]
* `startResources` - how many resources to spawn at the start of the game [default: 25]
* `resourceHp` - starting hit points of every new resource [default: 100]
* `unitHp` - starting hit points of every new unit [default: 100]
* `unitDamage` - how much damage do units deal on every attack [default: 10]
* `allowedNameCharacters` - string of characters that can be used in player names [default: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ-_]
* `maxResourceSpawn` - amount of times server will try to spawn a resource in one game tick / maximum amount of resources that can spawn in one tick [default: 1]
* `resourceChance` - chance of resource spawning in one attempt [default: 0.1]
### Example:
``` config.txt
millis 3000
maxPlayers 2
unitsToWin 2
startResources 8
boardX 5
boardY 5
resourceHp 20
unitHp 20
unitDamage 5
maxResourceSpawn 2
resourceChance 0.2
```
Pair can appear in any order. If pair not listed default value will be used.
# Comunicating with server
Communication happens via TCP protocol. Messages are separated by `\n` character. Each message must start with one byte that designates the type of the message.
Some messages consist of only type character others contain more data.
## Message types
### From client
- `n` `` `\n` - set name or rename self
- `j` - request join (player will be sent to game room or queue)
- `q` - request quit (player will be removed from game room or queue, can still rejoin with `j`)
- `m` `` ` ` `` ` ` `` `\n` - request unit of id: `` to move to field of coordinates: ``
- `a` `` ` ` `` `\n` - request unit of id: `` to attack another unit (of id: ``) (possible to attack own units)
- `d` `` `\n` - request unit to mine the resource (`` is an id of the controlled unit) (unit can only mine resource that it is standing on)
### From server
- `c` `` ` ` `` ` ` `` ` ` `` ` ` `` ` ` `` ` ` `` ` ` `` ` ` `` ` ` `` `\n` - almost whole server configuration sent to newly joined clients
- `j` `` `\n` - new player has joined the game room
- `l` `` `\n` - player `` has either left or lost the game
- `m` `` ` ` `` ` ` `` `\n` - unit of id `` has moved to `;`
- `a` `` ` ` `` ` ` `` `\n` - unit of id `` attacked unit of id `` and target unit has now `` hp left
- `d` `` ` ` `` `\n` - unit of id `` mined a resource and resource has now `` hp left
- `u` `` ` ` `` ` ` `` ` ` `` - player `` has aquired unit of id `` on field `;`
- `f` `` ` ` `` ` ` `` `\n` - new resource spawned on field `;`
- `t` `\n` - sent to all players in game room in regular time intervals, marks the and of each tick and a start of the next one
- `q` `\n` - player was sent to queue (in response to: `j`)
- `y` `\n` - client request accepted (in response to: `n`)
- `n` `\n` - client request denied (in response to: `j` or `n`)
- `L` `` `\n` - client lost the game (and was moved out of game room), `` is the name of the player who won
- `W` `` `\n` - client won the game (and was moved out of game room), `` is the name of the player who won
### Board state message
Board state update is sent to every player that joins the game room
Structure as follows:
`p` `` `;`
`` ` ` `` `,`
`` ` ` `` ` ` `` ` ` `` `,`
...
`` ` ` `` ` ` `` ` ` `` `,` `;`
...
`` ` ` `` `,`
`` ` ` `` ` ` `` ` ` `` `,`
...
`` ` ` `` ` ` `` ` ` `` `,` `;` `\n`
...
...
`r` `` `;`
`` ` ` `` ` ` `` `;`
`` ` ` `` ` ` `` `;` `\n`
...
Numbers are represented as strings of characters (97 ---> "97" not 'a').
### Communication order (client's perspective)
**1:** server sends `c`
**2:** client sends `n`
**3:** if server responds `n` => go to step **2**
**3:** else server responds `y`
**4:** if client sends `n` => go to step **3**
**4:** else client sends `j`
**5:** if server responds `q` => wait until server sends `p`, then `r`
**5:** else server reponds `p`, then `r`
**6:** server can send multiple: `j` `l` `m` `a` `d` `u` `f` messages
**6:** client can send multiple: `m` `a` `d` messages
**6:** if client sends `q` => go to step **4**
**6:** if server sends `W` or `L` => go to step **4**
**6:** if server sends `l` with client's name => go to step **4**
**7:** server sends `t` => go to step **6**
# Available Clients:
- [Godot client](https://github.com/pwalig/mini-RTS-godot-client)
- [Zig Bot](https://github.com/pwalig/mini-RTS-zig-bot)
feel free to write your own clients