https://github.com/thesignpainter98/lineup-tracker
A minimalist tracker for lineups
https://github.com/thesignpainter98/lineup-tracker
Last synced: 3 months ago
JSON representation
A minimalist tracker for lineups
- Host: GitHub
- URL: https://github.com/thesignpainter98/lineup-tracker
- Owner: TheSignPainter98
- License: gpl-3.0
- Created: 2022-04-24T00:14:44.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2022-05-03T14:36:24.000Z (about 3 years ago)
- Last Synced: 2025-01-27T22:16:51.926Z (5 months ago)
- Language: MoonScript
- Homepage:
- Size: 240 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# A simple lineup-tracker
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.
## Contents
* [How do I install this?](#how-do-i-install-this)
* [How do I use this?](#how-do-i-use-this)
* [Abbreviations](#abbreviations)
* [What’s the motivation?](#whats-the-motivation)
* [Why does this exist?](#why-does-this-exist)
* [Author and License](#author-and-license)
## How do I install this?
The following steps are required.
1. Install dependencies:
- [GNU Make][make]
- [Moonscript][moonscript]
- [Lua][lua]
2. Install [Lua YAML][lyaml]: `luarocks install lyaml`
3. Clone this repo and `cd` into its directory
4. Run `make`, which will build the binary, `lineup-tracker`
5. 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.
## How do I use this?
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.
### Abbreviations
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.
## What’s the motivation?
Aim-training makes a good solo-player; util-training makes a good team-player.
I enjoy playing the latter.
## Why does this exist?
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.
## Author and License
This project was created by Ed Jones and is licensed under GPL3.
[make]: https://www.gnu.org/software/make/
[moonscript]: https://moonscript.org
[lua]: https://www.lua.org
[lyaml]: https://luarocks.org/modules/gvvaughan/lyaml