net.avdw.hangman

Simple ASCII hangman to be used from command line or discord.

Showcase

Getting started

$ git clone https://github.com/avanderw/hangman.git
$ cd hangman/
$ mvn verify
$ java -jar ./target/hangman-jar-with-dependencies.jar --help
Usage: hangman [-hV] [COMMAND]
Simple ASCII hangman to be used from command line or discord.
  -h, --help      Show this help message and exit.
  -V, --version   Print version information and exit.
Commands:

Usage

Configuration

Logging

./tinylog.properties

writer        = file
writer.file   = hangman.log
writer.level  = info
writer.format = [{level}] at .({class-name}.java:{line}) {message}

Further documentation can be found at tinylog.org

Support

Installing supporting software

It is recommended to make use of a package manager to simplify the setup of your environment

Java 11
Maven 3.3.9

Chocolatey (https://chocolatey.org/install)

$ choco install ojdkbuild
$ choco install maven

Changelog

All notable changes to this project will be documented in CHANGELOG. The format is based on Keep a Changelog and adheres to Semantic Versioning.

Roadmap

Refer to the file .todo/todo.txt for a list of potential future work. Here is a complete primer on the whys and hows of todo.txt.

Contributing

We love contributions! Please read CONTRIBUTING for details on how to contribute.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details