fiender

Crates.iofiender
lib.rsfiender
version0.2.0
sourcesrc
created_at2020-07-12 20:10:44.258218
updated_at2020-09-23 03:42:27.43644
descriptionA CLI tool to retreive DnD 5e spells and monsters stats
homepage
repositoryhttps://github.com/manghi/fiender
max_upload_size
id264469
size80,837
Manghi (Manghi)

documentation

README

Fiender

Crate

Fiender is a CLI tool written in Rust and can be used to retreive DnD5e spells and monsters stats. The only backend currently supported is https://open5e.com/.

Installation

Install fiender using cargo install fiender, or clone this repository and build it using cargo build.

Usage

Fiender will retrieve the specified spell/monster data and output it as formatted markdown.

To retrieve a spell or monster, use the -s or -m flags, respectively.

$ fiender -s "eldritch blast"
$ fiender -m kobold

Limitations

The spell/monster name must exactly match the entry in open5e.

Aspirations

  • Adding a fuzzy search/selection to eliminate the limitation described above.
  • Support other output formats.
  • Support more than just monsters and spells as Open5e is pretty cool!

Remark

I use this for my own purposes and decided to make it public. Hope you find it useful!

License

Fiender is distributed under the terms of the GPL (Version 3.0) license.

See LICENSE for details.

Commit count: 10

cargo fmt