/quartermaster

A CLI application to help you find and use new magic items in your DND game.

Primary LanguageRubyMIT LicenseMIT

Quartermaster

Quartermaster is a Ruby CLI application that streamlines the process of finding and selecting magic items and treasure in the tabletop roleplaying classic, Dungeons and Dragons. This app specifically references every item in the 5th edition Dungeon Master's Guide.

Installation

Add this line to your application's Gemfile:

gem 'quartermaster'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install quartermaster

Video Demo: https://youtu.be/KqTyQPa4hIs

Usage

Execute the following in your terminal:

$ ruby ./bin/quartermaster

Then follow the instructions onscreen.

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/GoldenPavilion/quartermaster. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the Quartermaster project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.