MakeMeA is a tool for GameMasters (GMs) of TableTopRPGs (TTRPGs) that allows for generating data from random tables. Markdown and github style tables are used to create and organize the tables. Since this README is a markdown file and contains tables, all of these examples can be used with the tool.
go get -u github.com/awwithro/makemea
MakeMeA supports several types of tables
A lookup table is the most simple of tables. The table has a name and every item on the table has the same probability of being selected.
Try it with makemea "makemea/tables/lookuptable/race"
| Race |
|---|
| Elf |
| Human |
| Dwarf |
| Orc |
| Gnome |
| Troll |
| Goblin |
A Dice table has different probabilities for each item on the table. The number and type of dice are given as part of the table and the results of the roll are used to select an item from the table. Note, the dice column does not need to be first
Try it with makemea "makemea/tables/dicetable/treasure
| 1d6 | Treasure |
|---|---|
| 1-3 | Copper |
| 4-5 | Silver |
| 6 | Gold |
In addition to using a table, you can also use a definition list when you want to pick an item where each item has an equal probability.
Try it with makemea "makemea/tables/lists/class
Class : Warrior : Wizard : Cleric : Thief
Every table has a name. This name is used to tell MakeMeA which table to roll on. When you have a lot of tables, organization is key. Makemea will search the current folder and sub-folders for markdown files and attempt to convert any markdown tables found into tables to roll on. MakeMeA uses headers to nest tables to allow for tables to be organized. When a table is placed under a header, that header is prefixed to the table name with a "/". When a table is nested under headers and sub-headers, all the headers are combined with the table name. This lets you group related tables under a header to make them easier to find. For instance the following table can be located with the name: makemea/organizing/weapons
| Weapons |
|---|
| Sword |
| Dagger |
| Longbow |
| Mace |
| Spear |
You can see all of the tables that MakeMeA has detected by using the list command. Try it with: makemea list
Sometimes, you'll have a bunch of sub-tables that are used by a parent table. If the sub-tables aren't meant to be used on their own, you can hide them from the listing view by italicizing the name of the table. Notice that while the below table doesn't show up under the list command, it is still accessible via makemea makemea/organizing/hidden
| hidden |
|---|
| Secret |
| Mystery |
| Illusion |
You can also use links to point to other tables. The name of the link becomes the name of the new table and the destination of the link will be used when selected. The same header rules apply to the link as well. Try it with makemea makemea/organizing/link. It will roll on the race table above.
There are a few template functions that can be used to allow for more complex table behavior. Under the hood, golang templates are used. The syntax will be familiar to go programmers but is easy enough for anyone to follow. It also allows for the use of conditionals, loops, and other templating functions.
In addition the below functions, sprig template functions can be used as well. See here for their docs
The lookup function can be used to get a result from another table an use it as part of a different result. This lets you reuse tables in more than one place and have complex lookup results. For instance, if we wanted to have fancier versions of the weapons above, we could do the following. Try it wih: makemea makemea/templates/lookup/fancy
| Fancy |
|---|
| Shiny {{lookup "makemea/organizing/weapons" }} |
| Glowing {{lookup "makemea/tables/dicetable/treasure" }} |
| Large {{lookup "makemea/tables/lookuptable/race" }} |
When you have a large hierarchy of deeply-nested tables, it can be cumbersome to provide the full path to every table. You can use relative paths to shorten the call to lookup. The below table has both the full path to the fancy table as well as relative paths to the same table. Try it with: makemea makemea/templates/lookup/fancier
| Fancier |
|---|
| Rusty {{lookup "makemea/templates/lookup/fancy"}} |
| Glittering {{ lookup "./fancy"}} |
| Sparkling {{ lookup "./fancy"}} |
lookup also allows an for an optional argument for performing the same lookup multiple times. The following table will result in three items being selected from the fancier table: makemea makemea/templates/lookup/count
| Count |
|---|
| {{lookup "./fancier" 3}} |
The roll function is used to roll a set of dice as part of the final result. This is great for treasure if you want to generate a random amount of some currency. Try it with makemea makemea/templates/roll/horde
| Horde |
|---|
| {{roll "10d100+500"}} Copper |
| {{roll "5d20+50"}} Silver |
| {{roll "5d8+10"}} Gold |
| {{roll "3d6"}} Platinum |
The fudge function works similar to the lookup function but allows you to provide an alternate set of dice to roll. This is useful if you want to reuse an existing table but only want to use a subset of the times on that table. The following will roll on the treasure table put with a die range that will only allow for the silver and gold values to be rolled. Try it with: makemea makemea/templates/fudge/goldorsilver
| Gold or Silver |
|---|
| {{fudge "makemea/tables/dicetable/treasure" "1d3+3"}} |
The fudge function also supports the optional count argument like lookup does. Try it with: makemea makemea/templates/fudge/goldorsilvermultiple
| Gold or Silver Multiple |
|---|
| {{fudge "makemea/tables/dicetable/treasure" "1d3+3" 2}} |
Use the pick function to get a quick random result from a list of values.
| Monster |
|---|
| The monster has the head of a {{pick "lion" "tiger" "wolf"}} |
Use the chance function for a given element to have a certain chance of appearing. This could be done by rolling on different tables, but would get complicated quickly.
You must provide both a chance (0.0 - 1.0) and an option for when the chance fails.
Also, as the pipe used to chain templates together, you'll need to quote and escape the templates.
The bellow treasure will always give gold and will give platinum 50% of the time
Try it with makemea makemea/templates/chance/treasure
| Treasure |
|---|
Gold: {{ roll "3d100"}} Platinum: {{roll "5d10" |chance 0.50 "None"}} |
roll and lookup can be combined using variables to lookup a value from another table a random number of times. The following table does the following:
- Rolls 2d4
- Stores the result in a variable named "r"
- Calls the lookup function and uses the value of "r" to perform the lookup
- The result will be a list of 2 - 8 creatures
Try it with makemea "makemea/templates/combiningtemplates/encounter"
| Encounter |
|---|
| {{$r := roll "2d4"}}{{lookup "makemea/tables/lookuptable/race" $r}} |
More complex lookups can be done by using a variable to lookup a table based on the result of another lookup. In this example, an npc is generated on a single table. This is done by:
- Doing a lookup of the Race table
- Storing the result of the lookup into the variables
$r - Using the
$rvariable to determine which name table to use - Printing out an NPC using both the race and name generated
Admittedly, fitting this logic into a single table cell is a bit cumbersome. Luckily there is also an option for creating text blocks that are easily formatted and clearer to read.
Try it with ./makemea "makemea/variables/npc"
| NPC |
|---|
| {{$r:=lookup "./race" }}Race: {{$r}} Name: {{lookup (print "./" $r "/names")}} |
| Race |
|---|
| Elven |
| Human |
| Names |
|---|
| Alluin |
| Arwen |
| Aegnor |
| Names |
|---|
| Beorn |
| Aldor |
| Fulgar |
Its not quite a table but sometimes you want to generate something that performs lookups on other tables. Something like an NPC. It would be cumbersome to stuff everything into a table cell. Instead you can use a fenced code block. Here, the npc example from above has been redone using a code block. The result is much easier to understand and maintain. Try it with makemea makemea/text/npc
{{$race:=lookup "makemea/variables/race" -}}
{{$name := lookup (print "makemea/variables/" $race "/names") -}}
{{$level := roll "2d4" -}}
Name: {{$name}}
Race: {{$race}}
Level: {{$level}}
HP: {{roll (print $level "d6")}}
For more comprehensive tables. Check out OpenRPGTables