aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 4436d762d6d1dca9f911efa4213afb1081cf5bf5 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
# WorldServer Protocol Buffers

[Protocol Buffers](https://protobuf.dev/) implemented for [Worlds](https://www.worlds.com/)'
[WorldServer](http://dev.worlds.net/private/GammaDocs/WorldServer.html) protocol.

## Testing

```shell
# Compile the protocol buffers for Python usage
tup

# Test an example serialization and deserialization scenario
python3 build/test.py
```

### Dependencies

- [`protoc`](https://grpc.io/docs/protoc-installation/) — Protocol buffer compiler
- [Python](https://www.python.org/) — Test adapter
- [Tup](https://gittup.org/tup/index.html) — Build system

# Licence

This project is licensed with the [GNU General Public License v3.0](./LICENSE>).