diff options
| author | Fuwn <[email protected]> | 2024-06-12 07:17:26 -0700 |
|---|---|---|
| committer | GitHub <[email protected]> | 2024-06-12 07:17:26 -0700 |
| commit | aace9b774131e735d960883734cd48d003b99e86 (patch) | |
| tree | 81a4c5ae8d28b04cbf0c0067ffc13b84b3a6d277 | |
| parent | refactor: move commands to command module (diff) | |
| download | worldserver-protobufs-aace9b774131e735d960883734cd48d003b99e86.tar.xz worldserver-protobufs-aace9b774131e735d960883734cd48d003b99e86.zip | |
docs: add readme
| -rw-r--r-- | README.md | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..4436d76 --- /dev/null +++ b/README.md @@ -0,0 +1,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>). |