|
1 | 1 | # NOTE |
2 | | -WIP (work in progress). This tool isn't ready yet and not even in alpha, please come back later |
| 2 | +WIP (work in progress). This tool isn't ready yet to be announced to the public, but it |
| 3 | +reached the alpha stage. If you encounter bugs or experience crashes, please don't report them yet as this software |
| 4 | +has still a lot of loose ends. |
| 5 | + |
| 6 | +That beeing said, if you want to test it and create automapper rules, edit your `config.yml` and enter |
| 7 | +- `client_path`(optional): The absolute path to your ddnet client (On windows this is ddnet.exe) |
| 8 | +- `data_path`: The absolute path to your ddnet data (The `data` directory in your `ddnet` directory) |
3 | 9 |
|
4 | 10 | --- |
5 | 11 |
|
6 | 12 | # Simple DDNet Automapper App |
7 | | -A simple tool to create automapping files for ddnet with a graphical user interface |
| 13 | +A simple tool to create automapping files for ddnet with a graphical user interface |
| 14 | + |
| 15 | +## Installation |
| 16 | + |
| 17 | +This software comes bundled up, just download the version for your OS and start it. |
| 18 | +Note: You may want to put the software in it's own directory, since it may generate files. |
| 19 | + |
| 20 | +## Guide |
| 21 | + |
| 22 | +TODO: Do a proper guide, guide below is just for a minimal product |
| 23 | + |
| 24 | +1. Load mapres image, like `grass_main.png` by clicking `Select Image` |
| 25 | +2. Configure Tiles you want to use for your automapper |
| 26 | + - select FULL/EMPTY/ANY, TODO explain what this means |
| 27 | + - select rotation/hflip/vflip, don't use empty yet |
| 28 | +3. Name your rule (top right, `Name Mapping Rule`) |
| 29 | +4. Press `Generate`, this will test your mapping rules, press `Ok` and your mapping rules will automatically be saved |
| 30 | +in the data directory |
| 31 | + |
| 32 | +You can press `Generate` without being finished to check on your work, just press `Cancel` and continue |
| 33 | +editing your tiles |
0 commit comments