Module

2019-02-10 17:23:40 +01:00
parent 80e790d631
commit 3dc062cc23
6 changed files with 877 additions and 739 deletions
@@ -1,60 +1,24 @@
 # Terminis
-Another Tetris clone... again... but for terminal. Ideal for servers without GUI!
+Tetris clone for terminal. Ideal for servers without GUI!
+
+## Installation

-## Screenshot
 ```bash
-┌────────────HOLD───────────┐┌────────────────────┐┌────────────NEXT───────────┐
-│                           ││██                  ││                           │
-│          ██               ││██                  ││              ██           │
-│          ██████           ││██                  ││          ██████           │
-│                           ││██                  ││                           │
-└───────────────────────────┘│      ██            │└───────────────────────────┘
-┌────────────STATS──────────┐│      ██████        │┌──────────CONTROLS─────────┐
-│                           ││          ██        ││                           │
-│ SCORE 1017                ││          ████      ││ LEFT  MOVE LEFT           │
-│ HIGH  1017                ││          ████      ││ RIGHT MOVE RIGHT          │
-│ TIME  00:01:05            ││          ██████    ││ DOWN  SOFT DROP           │
-│ LEVEL 1                   ││        ████████    ││ SPACE HARD DROP           │
-│ GOAL  2                   ││  ████  ████████████││ UP    ROTATE COUNTER      │
-│ LINES 2                   ││  ██████████████████││ *     ROTATE CLOCKWISE    │
-│                           ││  ██████████████████││ H     HOLD                │
-│                           ││  ██████████████████││ P     PAUSE               │
-│                           ││  ██████████████████││ Q     QUIT                │
-│                           ││  ██████████████████││                           │
-│                           ││  ██████████████████││                           │
-│                           ││  ██████████████████││                           │
-│                           ││  ██████████████████││                           │
-└───────────────────────────┘└────────────────────┘└───────────────────────────┘
+pip install --user terminis
 ```

 ## Usage
 ```bash
-  python terminis.py [level]
+  terminis [level]
 ```
  level: integer between 1 and 15
-  
-## Dependency
-* Python
-* Python module curses (native on linux)
-
-Can be installed on windows with:
-```batch
-  pip install --user windows-curses
-```

 ## Controls edit
-Edit values of dictionary CONTROLS in the script:
-```python
-CONTROLS = {
-    "MOVE LEFT": "KEY_LEFT",
-    "MOVE RIGHT": "KEY_RIGHT",
-    "SOFT DROP": "KEY_DOWN",
-    "HARD DROP": " ",
-    "ROTATE COUNTER": "KEY_UP",
-    "ROTATE CLOCKWISE": "*",
-    "HOLD": "h",
-    "PAUSE": "p",
-    "QUIT": "q"
-}
-```
-Acceptable values are printable characters ('q', 'w'...) and curses's constants name starting with "KEY_" (see [Python documentation](https://docs.python.org/3/library/curses.html?highlight=curses#constants))
+
+You can change keys by editing:
+* `%appdata%\Terminis\config.cfg` on Windows
+* `~/.local/share/Terminis/config.cfg` on Linux
+
+Acceptable values:
+* printable characters ('q', '*', ' '...)
+* curses's constants name starting with "KEY_" (see [Python documentation](https://docs.python.org/3/library/curses.html?highlight=curses#constants))