This is an example that how to use Markdown creating a dungeon, please give a ⭐
This is an example repo illustration of a dungeon using Markdown on GitHub. In the dungeon the reader chooses which option to take and jumps into an appropriate page of the room that is based on their choice. It is collaborative because the room is written by many authors.
Start a new game |
---|
You need to install yarn.
git clone https://github.com/MakeContributions/markdown-dungeon.git
cd markdown-dungeon
yarn
.env.development
file in the project root folder and copy the format of .env.example
file.yarn start
Ensure you are not using PowerShell
A floor is a folder and each floor is a collection of rooms and every room is a Markdown
file.
The Markdown capability links are used for up/down and to go to another room, like the example below.
[Go to Github dungeon](https://github.com/)
Structure should be dungeon-name/floor-number/room-number
, please see the definitions below for each variable:
1, 2, 3 // Compliance
01, 02, A3 // Non-Compliance
1, 2, 3-AF, 3-01 // Compliance
01A, 02*A3, A3+F // Non-Compliance
Folder or file name only accept all ASCII characters and the dash(-).
If you created a new dungeon please add in Start a new game, add it on images folder, and in the dungeon-info.json, so the reader can go to your dungeon and open it on the website
If you want to get an idea of which option leads to what when contributing, look for
decision_tree.png
file under any dungeon folder, which contains a graphical view of that dungeon.
The links in this file must be relative links to continue working if the repository is forked.
Keep all lines 120 characters or less. Otherwise, the raw files will be difficult to read in the browser or on the command line, and the changes will be more difficult to review.
Insert blank lines between the different options so that the options are visually separated.