README.md

DungeonGenerator

A heavy metal dungeon generator meant to be used with Mörk Borg, but is game-agnostic aside from any monster stats.

Installation

Will eventually have a full front-end, but for now:

Clone repo

git clone git@github.com:riccjohn/dungeon_generator.git

Install dependencies

cd dungeon_generator
mix deps.get

Set up database

mix ecto.create

Run database migrations

mix ecto.migrate

Start an elixir repl and start generating dungeons

iex -S mix
DungeonGenerator.generate

If available in Hex, the package can be installed by adding dungeon_generator to your list of dependencies in mix.exs:

def deps do
  [
    {:dungeon_generator, "~> 0.1.0"}
  ]
end

Documentation can be generated with ExDoc and published on HexDocs. Once published, the docs can be found at https://hexdocs.pm/dungeon_generator.

Dungeon Generator is an independent production by John Riccardi and is not affiliated with Ockult Örtmästare Games or Stockholm Kartell. It is published under the MÖRK BORG Third Party License.

MÖRK BORG is copyright Ockult Örtmästare Games and Stockholm Kartell.