Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/polm/shesha
Random generator toolkit
https://github.com/polm/shesha
Last synced: 3 days ago
JSON representation
Random generator toolkit
- Host: GitHub
- URL: https://github.com/polm/shesha
- Owner: polm
- Created: 2017-05-09T15:38:15.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-09-27T14:56:21.000Z (about 6 years ago)
- Last Synced: 2024-10-14T00:37:35.434Z (about 1 month ago)
- Language: JavaScript
- Homepage: https://polm.github.io/shesha/
- Size: 1.96 MB
- Stars: 3
- Watchers: 4
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Shesha
A tool for quickly building random generators. (Still pretty rough, but working.)
## Command Line Quickstart
For the command line interface, do this:
npm install -g shesha
shesha "Shesha is [!c /cool/nice/great/sssuper/]!"
If you're intrigued, read on...
## Web Version
Even if you want to use Shesha mainly on the command line, it's easier to play around with the commands at first in the web version.
To use the web version, go [here](https://polm.github.io/shesha/) or check out the git repo and start an HTTP server.
The left pane is code, and after every keypress the right pane is updated.
The code in the left pane is divided into blocks separated by blank lines. There are three kinds of blocks.
`deck` and `die` create random sources you can use in the generator. They both have this format, using `deck` as an example:
deck my deck name goes here
entry 1
entry 2
entry 3
A few things to note:
- no quotes are needed anywhere
- spaces in the name of the source are OK
- each possible random value goes on its own line
The difference between a `die` and a `deck` is that a `die` **can** repeat values in one run of the generator, while a `deck` **can not**.
`generator` is the command that builds the widget. There are a lot of commands you can use inside it.
- **new-row**: make a new row in the generator.
- **print**: make a new cell in the row, and put text inside it. Terms inside `[brackets]` are taken to be the names of sources (dice or decks set before). Brackets can be nested.
- **image**: like `print`, but it expects to get an image url. Any text after the url becomes a caption.
- **style**: set the CSS attribute of the current row. Ex: `style height 200px`
- **roll**: roll dice. Takes three values: number of dice to roll, sides per die, and bonus to apply. Ex: 2d6 + 1 → `roll 2 6 1`
- **col-widths**: set widths of elements in the current row by ratio (uses flexbox).
- **save**: saves the result of a template to a source with the given name. This is useful when you need to repeat the output of a template. This is a bit complicated, so here's an example:
```
deck people
Alice
Bob
generator
save first [people]
save second [people]
print [first] said to [second] "Hello [second]"
```
There are also embedded commands that can go in text passed to `print` and the like. They work by starting the label inside brackets with an exclamation point. Currently there are just two:
- **roll**: Roll dice in-line. Ex: `print HP: [!r 1]` (rolls 1d6) `print STR: [!r 3 6 2]` (rolls 3d6+2)
- **choose**: Choose from an in-line list. The first non-whitespace character is used as the delimiter. Ex: `print You see a [!c /wizard/fighter/thief/]`
## Command Line Features
You can pass in the path of json files like so:
shesha -d file.json -c file2.json -t file3.shesha "print this"
JSON files are assumed to be flat objects with keys that contain lists. To treat every key as a die use `-d` for Dice, to treat as a deck use `-c` for Cards, to read a template file using the same syntax as the web editor use `-t` (the generator function will be ignored). If you have the same key in multiple files, the contents of the key will be **appended**.
Arguments without a prefix are assumed to be templates for rendering and will be printed after interpolation.
## Related Work / Similar Projects
- [Tracery](https://github.com/galaxykate/tracery)
- [Perchance ⚄︎](https://perchance.org/welcome)
- [RiTa Context Free Grammars](http://www.rednoise.org/pdal/index.php?n=Main.Grammars)
- [The Seventh Order of the Random Generator](http://www.lastgaspgrimoire.com/generators/the-seventh-order-of-the-random-generator/)
- [Abulafia Random Generators](http://www.random-generator.com/index.php?title=Main_Page)
- [RandomGen](http://orteil.dashnet.org/randomgen/)
- [Ink](https://github.com/inkle/ink/blob/master/Documentation/WritingWithInk.md)
## License
WTFPL, do as you please.