At its heart, this program takes maps which may have zones and abilities which may have usages and stores a user’s progress towards a target. Commands are available to update progress and targets as well as to add new maps, zones, abilities and usages.
- How do I install this?
- How do I use this?
- What’s the motivation?
- Why does this exist?
- Author and License
The following steps are required.
- Install dependencies:
- Install Lua YAML:
luarocks install lyaml - Clone this repo and
cdinto its directory - Run
make, which will build the binary,lineup-tracker - Install. If you’re on:
- Linux or macos—run
sudo make install - Windows—copy the binary into somewhere in your path and pray because I haven’t tested this on Windows.
- Linux or macos—run
Once lineup-tracker is executed, it behaves like a shell.
It must be noted that this shell tracks a ‘query-state,’ which defines what data the user is currently modifying.
The current query state will appear in the shell’s prompt, and can also be checked by typing state.
Type exit, quit or EOF (Ctrl+D on Linux) to exit.
The program saves before exiting, but this can be invoked earlier by using the Save command.
Type help for more info on which commands are available.
More generally, any command or sub-command with help as its first argument will output a help message.
To make this program easier to use, it is possible to shorten commands and arguments.
Command (and sub-command) abbreviations are just the first few letters---the shell will try to match the rest of the command.
For example n m haven will expand to new map haven, which creates a new map called ‘haven.’
To abbreviate arguments, numeric indices may be used, to find the list of currently available indices, enter list.
Shortened abbreviations may be supported at some point in future.
Aim-training makes a good solo-player; util-training makes a good team-player. I enjoy playing the latter.
The first version of this used a spreadsheet. I wanted to make a command-line tool to track my progress instead so I made this.
This project was created by Ed Jones and is licensed under GPL3.