makecontributions / markdown-dungeon

This is an example that how to use Markdown creating a dungeon, please give a ⭐

⚔️ Markdown Dungeon ⚔️

A dungeon is a place or prison where people are held. Usually, they can be found underground

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

📥 Installation

You need to install yarn.

1. Clone the repo

git clone https://github.com/MakeContributions/markdown-dungeon.git

2. Go to the folder

cd markdown-dungeon

3. Run install dependency

yarn

4. Create a .env.development file in the project root folder and copy the format of .env.example file.
5. To start the development server run:

yarn start

Ensure you are not using PowerShell

6. 🎉 Open your browser and go to http://localhost:8000/ or http://localhost:8000/___graphql

👷‍♂️ Floor and the room format

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

[Go to Github dungeon](https://github.com/)

👩‍💻 Contribution Guidelines

1. 📐 Make Adequately Sized Changes

• Keep changes small
• Don't add an option without adding any gate for readers who decide on that option, so that the dungeon will not be full of dead links. Instead, the last markdown file the reader reaches on any path of the room should not have any options.

Here are some examples of appropriate changes:

• Add one or two sentences to an existing "page" (file) in the room.
• Add a new option to an existing choice point, and link that option to an existing "room" or "floor".
• Add a new option to an existing choice point, create a new "page" for that option, and add a sentence or two to the new "page".
• Add a couple of options to a current dead-end "page", and add a "page" or link to an existing "page" for each option.

2. ⛩ Dungeon Structure

Structure should be dungeon-name/floor-number/room-number, please see the definitions below for each variable:

• dungeon-name: is a folder that contains floor number, should separate words with a dash(-), is alphanumeric. Example: normal-dungeon-1.
• floor-number: is a folder that contains room number, is numeric do not add 0 before the number.

1, 2, 3 // Compliance

01, 02, A3 // Non-Compliance

• room-number: is a markdown file, the name of the file should be in numeric, but if has sub-rooms of the room you could separate the room number with a dash(-), the sub room could be alphanumeric.

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.

3. 🔗 Use Relative Links

The links in this file must be relative links to continue working if the repository is forked.

4. 📏 Line Lengths

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.

5. 🪓 Blank Lines Between Options

Insert blank lines between the different options so that the options are visually separated.

📝 License

MIT

markdown-dungeon's Issues

Improvising README.md

I was thinking🤔 to compress the 📖README.md so that it become easier to read for the users, but I want suggestions on how to do it or should not do it at all.

1. should I break the main file in multiple file (one for contributing instructions, one for installation instructions etc) and link them in the main readme.md file

2. or

   should I use a drop down menu like this one

3. or something else....(your suggestion)🤔

Some static pages are not jumping into the correct page as markdown

The markdown is jumping into the right page, but the static page that is generated by Gatsby is not working using relative link, example, in the normal-dungeon/1/2-1A.md, if selected option Forget it should jump into normal-dungeon/2/1.md, but on the static page is trying to jump into normal-dungeon/1/2/1

✔ Definition of done:
Every page that is trying to jump into another floor, should work fine on the static page.

Shouldn't We Add Translations

Recently, there has been many commits to the english folder and fresh rooms and dungeons have been added.

But, the new files have not been translated into portuguese (I think chinese is a seperate dungeon).

So, shouldn't we update the translations?

Inviting some maintainers for their feedback: @ming-tsai, @Arsenic-ATG, @FukurouMakoto. Others are also welcome.

Open Source Projects/Repositories

I would request for starting few new repositories for open source contributions in DSA , python projects anyhting to encourage more open source developers and contributors.

Create a home screen for the game

In english/normal-dungeon there is no markdown file to give a basic description about the game. It directly shows the floor folders which lead to the game starting. A home screen would have a start game and exit game button as well as some help information (how-to-play, about etc.)

Improvise COVID-19 dungeon

Right now the COVID-19 dungeon have a lot of scope to expand🙂 and is waiting for YOU✌️ to expand it.

If you have any query regarding the dungeon and/or want to contribute something to that dungeon then you are most welcome leave a comment here regarding the same.🎉

NOTE 🧐 : -

Everyone can work on this issue ( being assigned is not necessary ) , just mention the PR on the comment when you are finished and wait for it to be reviewed and merged 🎉

• just make sure you read the contribution guidelines before contributing to this repo.

---

P.S. You can also directly issue a Pull Request for small contributions like fixing typos or adding 1-2 rooms.

Add icons to it

If it’s possible to use https://github.com/game-icons/icons icons, it would be more fun.

Add more dungeons, rooms or floors - Part 3

It'd be awesome to have a lot of the dungeons, rooms, or floors, so the game could be more fun 😜

🐞 Problem
Currently, we have only a bunch of dungeons, rooms, or floors in the project

🎯 Goal
Have a lot of dungeons, rooms, or floors from the diverse games.

💡 Possible solutions
Add new a new dungeon, rooms, or floors.

How to make it?
Check out Contribution Guidelines

📋 Steps to solve the problem

1. Comment below about what you've started working on.
2. Add, commit, push your changes
3. Submit a pull request and add this in comments - Addresses #
4. Ask for a review in the comments section of the pull request
5. Celebrate your contribution to this project 🎉

This issue will close every 10 contributions for adding new room(s) or floor(s)

Add emoji to files

Every option/statement if possible should have emoji to make it more appealing to the players.

Link not found

I started the game, i ended up in a page
where it shows like this

When i click the link it took me to 404 page of github.
Please take a note.

No way to go back to home page

I would like to add a way to go back to the homepage from any game. I am thinking of a button with href on the top left of web page.

Charts for journey's

These would be simple charts to show you the different pathways for a dungeon.
This will be easier for developers to see what pathways lead to where.

This is a test for discord webhooks

A new PR for test welcome bot

Spanish translation

Adding Spanish translation for normal-dungeon

Proofread README.md

Hello,

I noticed that the README.md file has grammatical errors. Would it be okay if I could contribute and edit them?

Beautify the page

Beautify the static page using Gatsby + React + JS

What is going on with folder number 9 in English Normal Dungeon?

While I was working on the decision tree, I came upon folder number 9. It is just an infinite loop hole, with the explore room number not being completed. That page itself has nothing in it is just

# Under Construction

so, there is no way to get out of it, or by dying. But is there a way just to organize it, the doors are just to excessive, they all lead back to the same place. Most are outdated as well, they don't have any emoji's and are pretty long.

We are not participating the event Hacktoberfest 2022

This repo is not inside of the hacktoberfest 2022, due to we have already participated last year, and sorry about not removing the hacktboerfest topic on the issue.

IF YOU OPEN A PULL REQUEST FOR THAT AND WON'T CONTINUE WITH IT, PLEASE HELP US CLOSED IT.

For more details read the below link.
https://hacktoberfest.com/participation/#pr-mr-details

[ EXCLUDED ]

REPOS THAT GO AGAINST HACKTOBERFEST’S VALUES WILL BE EXCLUDED FROM QUALIFICATION AND PR/MRS MADE TO THOSE REPOS WON’T COUNT.

Best Regards.

Add more dungeons, rooms or floors - Part 2

It'd be awesome to have a lot of the dungeons, rooms, or floors, so the game could be more fun 😜

🐞 Problem
Currently, we have only a bunch of dungeons, rooms, or floors in the project

🎯 Goal
Have a lot of dungeons, rooms, or floors from the diverse games.

💡 Possible solutions
Add new a new dungeon, rooms, or floors.

How to make it?
Check out Contribution Guidelines

📋 Steps to solve the problem

1. Comment below about what you've started working on.
2. Add, commit, push your changes
3. Submit a pull request and add this in comments - Addresses #
4. Ask for a review in the comments section of the pull request
5. Celebrate your contribution to this project 🎉

Expand Floor 2 in english/normal-dungeon

Creating this issue. Will work on it myself.

TODO:

• Create story for floor 2

• Create rooms for floor 2

• Add link to reach floor 3

Fix: Footer url is pointing to https://material-ui.com/

On the footer, "Copyright © Make Contributions 2021." . The text Make Contribution is linked to material-ui page but it should be linked to https://github.com/MakeContributions.

error while compiling

Hello everyone!

This is my first contribution to an open source! i'm really excited to contribute to this one as well, although when forking the project and install it on my machine, i got a few errors.

I followed all the instructions, I've got npm and yarn installed on my machine globally and i installed gatsby as well, when executingyarn start for the first time and go on localhost:8000 i got an error on the console with 404s for commons.js frameworks.js and common.css.

On my terminal i get WEBPACK.DEVELOP error as well as an API.NODE.EXECUTION, I tried to update gatsby on my local machine thinking that would resolve the problem, but it didn't

italian normal-dungeon

I'd like to insert an italian translation for the "normal-dungeon" file, if everyone agrees

Linking

As i am create a new dungeon, i want to link two .md files, i need help link those two files

Emojis not showing

Add more dungeons, rooms or floors

It'd be awesome to have a lot of the dungeons, rooms, or floors, so the game could be more fun 😜

🐞 Problem
Currently, we have only a bunch of dungeons, rooms, or floors in the project

🎯 Goal
Have a lot of dungeons, rooms, or floors from the diverse games.

💡 Possible solutions
Add new a new dungeon, rooms, or floors.

How to make it?
Check out Contribution Guidelines

📋 Steps to solve the problem

1. Comment below about what you've started working on.
2. Add, commit, push your changes
3. Submit a pull request and add this in comments - Addresses #
4. Ask for a review in the comments section of the pull request
5. Celebrate your contribution to this project 🎉

Proofread pages

Hi,

I noticed that some of the pages in the English project have grammatical errors. Would it be okay if I go ahead and edit them?

Animation suggestion

On the main page, the cards change colors + have a shadow on hover. It think it might look nicer if we ease into the animation and make the card size slightly larger.

No Message Shows For An Option in the Game

Hello,

I just explored this repo and played the game. But, I found a bug.

This is the way I played:

Start a new game > I choose you, the normal dungeon > Begin Your Journey > Find a Way Out > Go Home > Something seems amiss, so you venture forth with an uneasiness of what may lie ahead > Sneak around and enter from the back?

And, when I click the last link, it gets me back to the Begin your Journey page. If I choose other options, it will show a message saying that I am dead. It would be nice if there is a similar message for this option as well.

Thanks!

General Question - Maintenance?

Is this repo still being maintained?

Add more dungeons, rooms or floors 🤣

It'd be awesome to have a lot of the dungeons, rooms, or floors, so the game could be more fun 😜

🐞 Problem
Currently, we have only a bunch of dungeons, rooms, or floors in the project

🎯 Goal
Have a lot of dungeons, rooms, or floors from the diverse games.

💡 Possible solutions
Add new a new dungeon, rooms, or floors.

How to make it?
Check out Contribution Guidelines

📋 Steps to solve the problem

1. Comment below about what you've started working on.
2. Add, commit, push your changes
3. Submit a pull request and add this in comments - Addresses #
4. Ask for a review in the comments section of pull request
5. Celebrate your contribution to this project 🎉