Initial commit

svenar-nl · Sep 4, 2021 · 5b05307 · 5b05307
1 parent 115bcd2
commit 5b05307
Show file tree

Hide file tree

Showing 3 changed files with 492 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,2 +1,24 @@
 # MinecatServer
 Server for the game Minecat
+
+
+## Installation
+run `python -m pip -r requirements.txt` to install the server dependencies
+
+
+## Running
+Run `uvicorn server:app` to start the server
+
+The default server port is `8000`.
+
+Run `uvicorn server:app --host 0.0.0.0 --port 8069` to run the Minecat server on a different port.
+
+
+## Developing
+Run `uvicorn server:app --reload` (or with your custom port) to run the Minecat server in development mode.
+
+Every server file change the server automatically restarts to increase development speed.
+
+
+## License
+MIT
diff --git a/requirements.txt b/requirements.txt
@@ -0,0 +1,4 @@
+fastapi==0.68.0
+uvicorn==0.15.0
+websockets==9.1
+aiofiles==0.7.0