Browse Source

usage, more words

pixelbath 3 years ago
parent
commit
d61681cb1f
1 changed files with 24 additions and 1 deletions
  1. 24 1
      README.md

+ 24 - 1
README.md

@@ -1,10 +1,33 @@
-All code and content in this repository is released into the public domain. Any code not written explicitly by me is already in the public domain. For more information, see https://gitlab.com/drummyfish/anarch.
+All code and content in this repository is released into the public domain. Any code not written explicitly by me is already in the public domain. For more information, see https://gitlab.com/drummyfish/anarch/-/blob/master/README.md.
+
+Note that this is not as "suckless" as drummyfish's code since it has external dependencies (specifically, Pyglet for OpenGL rendering).
 
 ## Usage
 This code uses a lot of drummyfish's `img2map.py` code as-is; I simply wrapped it in a class to access its sweet, creamy internals.
 
 The plan is to get this app to a point where you point it at an assets folder and either create a new map or edit an existing map image. From that point, it can export classes or images, whichever is preferred.
 
+### Requirements
+* Pyglet: `pip install pyglet`
+
+### Editor
+In `main.py`, the line: `assets_folder = '../anarch/assets/'` should be edited to point at a local clone of the Anarch repository. If you see white textures instead of the actual textures, then the assets were not located locally.
+
+To clone drummyfish's archive (by default I'm storing both projects in the same folder):
+```
+git clone https://gitlab.com/drummyfish/anarch
+```
+
+To run the editor: `python main.py`
+
+#### Controls
+* Horizontal movement: WASD
+* Camera aim: Mouse (mouse lock with E)
+* Up: Spacebar
+* Down: Shift
+* Esc: Exit
+
+### Other Usage
 To use the C generator by itself, you can use the following code:
 
 ```Python