You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,10 +12,25 @@ This program was designed to assist the GM by quickly creating a random star sys
12
12
13
13
## How do I use this?
14
14
15
+
### CLI Version
15
16
Basically, download the code and put it in a folder. Currently installing as a Python module onto the system is not supported, but will come in the future. Some day.
16
17
17
18
After that have a look at the `example.py` file and modify it to suit your needs. Currently not many options are available, but there will be more!
18
19
20
+
### Web Version
21
+
In v0.3 we introduced a web interface which is self-hosting, meaning that all the work is done locally on your machine. Navigate to the `web-gui` directory and start the server with the command
22
+
23
+
python3 server.py
24
+
25
+
If they are not already on your system, you need to install the 3<sup>rd</sup> party modules `cherrypy` and `jinja2`.
26
+
An easy way to do that is with pip3:
27
+
28
+
pip3 install cherrypy jinja2
29
+
30
+
31
+
When the server is up and running, open your favorite browser and navigate to `localhost:8080` where you can interact with the software.
32
+
33
+
19
34
## I found a bug!
20
35
21
36
If you found something that is not working as it should, please report it in the *issues* section here: http://github.com/tschoppi/starsystem-gen/issues
0 commit comments