aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorLizzy Fleckenstein <eliasfleckenstein@web.de>2023-01-06 21:20:09 +0100
committerLizzy Fleckenstein <eliasfleckenstein@web.de>2023-01-06 21:20:15 +0100
commit9ee7b7ddc5c3611bf515dbdee4134b6df9efed92 (patch)
tree09247c8cf80c19e1e005d3be8b03b97a30aaa6b4 /README.md
parent12bfebc06ed29fabbc4a4357e314b8fbde1b552d (diff)
downloadmt_rudp-9ee7b7ddc5c3611bf515dbdee4134b6df9efed92.tar.xz
cleanup; readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..d40c495
--- /dev/null
+++ b/README.md
@@ -0,0 +1,14 @@
+# mt_rudp
+
+A Rust library for the [Minetest](http://minetest.net) RUDP protocol.
+
+This project is inspired by the equivalent [Go library](https://github.com/anon55555/mt/tree/master/rudp) by anon5 and uses it as reference implementation.
+
+This library is the first piece in a ecosystem of Rust libraries for building servers, clients and proxies for Minetest.
+
+## TODO
+
+- implement sending split packets
+- implement server
+- implement reliable window
+- documentation