Project

balm

0.0
The project is in a healthy, maintained state
"It has the ability to generate character types, romance tropes and settings."
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 3.2
 Project Readme

Balm

A simple to use gem that will generate random character types, tropes and/or settings. Most useful for writers in a rut if you need to jumpstart inspiration.

Called 'balm' to soothe the headaches of writer's block. Also great to generate random prompts for writing practice.

Installation

Add this line to your application's Gemfile:

gem 'balm'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install balm

Usage

require 'balm'

Balm::Plot.trope        #=> "Arranged Marriage"
Balm::Plot.archetype(4) #=> "Minor God, Curate, Bard, Ghost"
Balm::Plot.setting      #=> "The ruins of a Castle"
Balm::Plot.all(3)       #=> "Mage, Princess, Dandy
                        #=>  One is a Celebrity and the other is not
                        #=>  The city just before dawn "
    

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/balm. 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 Balm project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.