|
|
@@ -1,14 +1,23 @@
|
|
|
# README
|
|
|
|
|
|
+## How to play
|
|
|
+### Windows
|
|
|
+You can either
|
|
|
+- (Recommended) download a PowerShell-script that automatically installs and/or updates Orderer from
|
|
|
+http://koljastrohm-games.com/downloads/orderer_installer.zip
|
|
|
+- or download the files for the current client from
|
|
|
+http://koljastrohm-games.com/downloads/orderer.zip
|
|
|
+- clone this repository, install python (3.6 recommended) and follow the instructions below for python users.
|
|
|
+
|
|
|
+### Any machine capable of running python 3
|
|
|
+You can clone this repository and use python (3.6 recommended) to execute the client.
|
|
|
+Make sure you set the `debug` flag in `debug.py` to `False`, otherwise you will not connect to the server.
|
|
|
+
|
|
|
+If you know python and want to develop any cool features for you personal client, feel free to fork this repository and create a pull request.
|
|
|
+
|
|
|
## Compilation
|
|
|
+### Server
|
|
|
The server is intended to be run within a python 3.6 environment on the host specified in `connection.py`.
|
|
|
-The client is intended to be compiled with
|
|
|
-```
|
|
|
-echo debug = False > debug.py &&\
|
|
|
-python -OO -m PyInstaller run_client.py &&\
|
|
|
-echo debug = True > debug.py
|
|
|
-```
|
|
|
-where `pyinstaller` can be installed using pip.
|
|
|
|
|
|
On the server you can install the required packages using pip:
|
|
|
```
|
|
|
@@ -17,4 +26,13 @@ pip3 install bottle requests
|
|
|
and start the server using
|
|
|
```
|
|
|
python3 -OO run_server.py
|
|
|
-```
|
|
|
+```
|
|
|
+
|
|
|
+### Client
|
|
|
+The client is intended to be compiled with
|
|
|
+```
|
|
|
+echo debug = False > debug.py &&\
|
|
|
+python -OO -m PyInstaller run_client.py &&\
|
|
|
+echo debug = True > debug.py
|
|
|
+```
|
|
|
+where `pyinstaller` can be installed using pip.
|
