aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..8dbc379
--- /dev/null
+++ b/README.md
@@ -0,0 +1,30 @@
+<p align="center">
+ <img src="https://user-images.githubusercontent.com/46352972/120899842-f6b9c900-c631-11eb-86ae-ac8134e0a937.png" width="64px" /><br>
+ <big>ยป<b> Kartik Server </b>ยซ</big>
+ <br>developed with<br>
+ <img src="https://user-images.githubusercontent.com/46352972/116787437-47268f80-aaa4-11eb-99c9-a771eb7dadcc.png" width="48px">
+</p>
+
+----
+
+A low latency game proxy for Kartik. Note that it is **only** a proxy and does not control any packet sent between clients (e.g. it doesn't check for cheats)
+
+* **Status:** ๐Ÿ’ป Actively maintained
+<!-- * **Status:** ๐Ÿ•‘ Extended maintenance -->
+<!-- * **Status:** ๐Ÿ”ด Searching for mainteners -->
+<!-- * **Status:** ๐Ÿšซ Archived, **DO NOT USE IN PRODUCTION** -->
+
+## Summary
+* **Language:** JavaScript
+* **Started:** April 2021
+* **License:** GNU General Public License 3.0
+* **Website:** https://kartik.hopto.org
+
+## Setup
+* Clone the repository
+* Change the `ServerPort` in **index.js**
+* Start it: `node index.js`
+* In your copy of the Kartik game, put your connection settings to `/online/server.json`
+
+## Issues
+Issues are reported using GitHub issues. \ No newline at end of file