readme: drop tooncher specifics

README.md

@@ -1,105 +1,35 @@
-# tooncher
-automates toontown rewritten's login process
+# rescriptoon
+TODO add description
 
 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
-[![Last Release](https://img.shields.io/pypi/v/tooncher.svg)](https://pypi.org/project/tooncher/#history)
-[![Python Version](https://img.shields.io/pypi/pyversions/tooncher.svg)](https://pypi.org/project/tooncher/)
+[![Last Release](https://img.shields.io/pypi/v/rescriptoon.svg)](https://pypi.org/project/rescriptoon/#history)
+[![Python Version](https://img.shields.io/pypi/pyversions/rescriptoon.svg)](https://pypi.org/project/rescriptoon/)
 
 ## Installation
 
-```sh
-$ pip3 install --user --upgrade tooncher
-```
-
-or:
-
-```sh
-$ pip3 install --user --upgrade git+https://github.com/fphammerle/tooncher@master
-```
-
-Optional: Install cpulimit to enable use of parameter `--cpu-limit`
-
-```sh
-$ sudo apt-get install cpulimit
-```
-
-Optional: Install xlib and psutil for python to enable extended controls:
-
-```sh
-$ sudo apt-get install python3-xlib python3-psutil
-```
-
-or
+Compatible with X Window System (X11)
 
 ```sh
-$ pip3 install --user xlib psutil
-```
-
-## Configuration
-
-```yaml
-# default path: $HOME/.tooncher
-accounts:
-- username: toon
-  password: secret
-- username: ceo
-  password: golf
-- username: cfo
-  password: train
-engine_path: '/opt/Toontown Rewritten/TTREngine'
+$ sudo apt-get install python3-xlib python3-psutil `# optional`
+$ pip3 install --user --upgrade rescriptoon
 ```
 
 ## Usage
 
 ```sh
-$ tooncher [username]
+$ rescriptoon TODO
 ```
 
-`tooncher --help` shows all available options.
-
-### Extended Controls
-
-To enable the use of WASD keys for walking,
-launch tooncher with the `--extended-controls` option:
-
-```sh
-$ tooncher --extended-controls username
-```
+`rescriptoon --help` shows all available options.
 
 While in the game press `` ` `` (grave) to enable extended controls.
 Press `` ` `` again to disable.
 
-The command line parameter `--extended-controls-toggle` may be used
-to change the toggling key:
-
-```sh
-$ tooncher --extended-controls --extended-controls-toggle slash username
-```
-
-Extended controls require the X Window System (X11).
-
-### Examples
-
 ```sh
-$ tooncher toon
-$ tooncher --extended-controls ceo
-$ tooncher --cpu-limit 70 cfo
-```
-
-### Python Interface
-
-```python
-import pathlib
-import tooncher
-
-tooncher.launch(
-    engine_path=pathlib.Path('/somewhere/toontown-rewritten/TTREngine'),
-    username='toon',
-    password='secret',
-)
+$ rescriptoon --toggle slash
 ```
 
-## Extended Controls Default Mappings
+## Mappings
 
 ![default mapping](docs/extended-controls/default-mapping.svg)