Files
ArmageDec/README.md
T

34 lines
2.0 KiB
Markdown
Raw Normal View History

2024-10-12 13:08:55 +03:00
# ArmageDec: a free and cross-platform game scheme editor for Worms: Armageddon .wsc files
ArmageDec (short for Armageddon Decoder) is a GUI scheme editor (written in Tcl/Tk 8.6) for Worms: Armageddon game scheme file format from version 1 to version 3. It was developed based on [this format description page](https://worms2d.info/Game_scheme_file) and supports all fields readable as of W:A v3.8.1, including those not present in some other external scheme editors.
## Usage
ArmageDec is a fully GUI-based application, although you can pass the .wsc scheme file to open as the first command-line parameter to the script. You can modify all supported parameters, including the format version itself. If you supply an invalid version value, the program will assume and save version 3.
Note that you can't create a fully new scheme as of now. You need to open an existing .wsc file and start by editing it.
## Binary builds
It is possible (although absolutely unnecessary) to build ArmageDec as a stand-alone binary. For Windows users, binary builds will be provided along with the source code on the "Releases" tab of the repo.
To build a binary distribution of ArmageDec yourself, follow these steps:
1. Obtain the tclkits for your host and target platforms, e.g. build them [here](https://kitcreator.rkeene.org/kitcreator).
Make sure you're building the target tclkit with Metakit and Tk packages enabled.
If the host and target platform are the same, you still need two kit binaries (just make a copy).
2. Download `sdx.kit` from somewhere, e.g. from [here](https://codeberg.org/luxferre/StreamGoose/raw/branch/main/tcldep/sdx.kit)
3. Put the two binaries and `sdx.kit` into the same directory as `armagedec.tcl`, then run from this directory:
```
[/path/to/host/tclkit] sdx.kit qwrap armagedec.tcl -runtime [/path/to/target/tclkit]
```
A file just named `armagedec` should appear, this is your executable.
4. If building for Windows, rename `armagedec` to `armagedec.exe`.
## Credits
Created by Luxferre in 2024, released into public domain.