markdown dungeon

⚔️ Markdown Dungeon ⚔️

Un donjon est un lieu ou une prison où les gens sont détenus. Habituellement, ils peuvent être trouvés sous terre

Ceci est un exemple d'illustration de repo d'un donjon utilisant Markdown sur GitHub. Dans le donjon, le lecteur choisit l'option à prendre et saute dans une page appropriée de la pièce basée sur leur choix. C'est collaboratif parce que la salle est écrite par de nombreux auteurs.

Démarrer un nouveau jeu

? Installation

Vous devez installer du fil.

1. Cloner le repo

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

2. Aller au dossier

 cd markdown-dungeon

3. Exécutez la dépendance à l'installation

yarn

4. Créez un fichier .env.development dans le dossier racine du projet et copiez le format du fichier .env.example .
5. Pour démarrer l'exécution du serveur de développement:

yarn start

Assurez-vous que vous n'utilisez pas PowerShell

6. ? Ouvrez votre navigateur et allez sur http: // localhost: 8000 / ou http: // localhost: 8000 / ___ graphQL

Plancher et le format de la pièce

Un étage est un dossier et chaque étage est une collection de chambres et chaque pièce est un fichier Markdown . Les liens de capacité de marque sont utilisés pour le haut / bas et pour aller dans une autre pièce, comme l'exemple ci-dessous.

Aller au donjon github

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

? ‍ Lignes directrices de contribution

1.? Apporter des modifications de taille adéquate

• Gardez les changements petits
• N'ajoutez pas d'option sans ajouter de porte pour les lecteurs qui décident de cette option, afin que le donjon ne soit pas plein de liens morts. Au lieu de cela, le dernier fichier Markdown que le lecteur atteint sur n'importe quel chemin de la salle ne devrait avoir aucune option.

Voici quelques exemples de changements appropriés:

• Ajoutez une ou deux phrases à une "page" (fichier "existante dans la salle.
• Ajoutez une nouvelle option à un point de choix existant et liez cette option à une "salle" ou "planche" existante.
• Ajoutez une nouvelle option à un point de choix existant, créez une nouvelle "page" pour cette option et ajoutez une ou deux phrases à la nouvelle "page".
• Ajoutez quelques options à une "page" impassible actuelle et ajoutez une "page" ou un lien à une "page" existante pour chaque option.

2. ⛩ Structure du donjon

La structure doit être dungeon-name/floor-number/room-number , veuillez consulter les définitions ci-dessous pour chaque variable:

• Dungeon-Name: est un dossier qui contient le numéro de sol, devrait séparer les mots avec un tableau de bord (-), est alphanumérique. Exemple: Donjonge normal-1 .
• Nombre de plancher: est un dossier qui contient le numéro de la pièce, est numérique n'ajoute pas 0 avant le numéro.

 1, 2, 3 // Compliance

01, 02, A3 // Non-Compliance

• Numéro de pièce: est un fichier Markdown, le nom du fichier doit être en numérique, mais si des sous-chambres de la pièce, vous pouvez séparer le numéro de la pièce avec un tableau de bord (-), la sous-salle pourrait être alphanumérique.

 1, 2, 3-AF, 3-01 // Compliance

01A, 02*A3, A3+F // Non-Compliance

Le dossier ou le nom de fichier accepte uniquement tous les caractères ASCII et le tableau de bord (-).

Si vous avez créé un nouveau donjon, veuillez ajouter un nouveau jeu, ajoutez-le sur le dossier des images et dans le donjon-info.json, afin que le lecteur puisse aller à votre donjon et l'ouvrir sur le site Web

Si vous souhaitez avoir une idée de quelle option mène à ce que lorsque vous contribuez, recherchez le fichier de decision_tree.png sous n'importe quel dossier de donjon, qui contient une vue graphique de ce donjon.

3.? Utiliser des liens relatifs

Les liens de ce fichier doivent être des liens relatifs pour continuer à fonctionner si le référentiel est fourchu.

4.? Longueurs de ligne

Gardez toutes les lignes 120 caractères ou moins. Sinon, les fichiers bruts seront difficiles à lire dans le navigateur ou sur la ligne de commande, et les modifications seront plus difficiles à examiner.

5.? Lignes vierges entre les options

Insérez des lignes vides entre les différentes options afin que les options soient séparées visuellement.

Licence

Mit