markdown dungeon

markDown Dungeon

ダンジョンは、人々が拘束される場所または刑務所です。通常、それらは地下に見つけることができます

これは、GitHubのMarkdownを使用したダンジョンのレポの例です。ダンジョンでは、読者は、選択した部屋の適切なページに撮影してジャンプするオプションを選択します。部屋は多くの著者によって書かれているので、それは協力的です。

新しいゲームを開始します

？インストール

糸をインストールする必要があります。

1. レポをクローンします

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

2. フォルダーに移動します

 cd markdown-dungeon

3. インストール依存関係を実行します

yarn

4. プロジェクトルートフォルダーに.env.developmentファイルを作成し、 .env.exampleファイルの形式をコピーします。
5. 開発サーバーを起動するには：

yarn start

PowerShellを使用していないことを確認してください

6. ？ブラウザを開き、http：// localhost：8000/or http：// localhost：8000/___ graphqlにアクセスしてください

床と部屋の形式

床はフォルダーであり、各フロアは部屋のコレクションであり、すべての部屋はMarkdownファイルです。マークダウン機能リンクは、上下に、以下の例のように別の部屋に行くために使用されます。

Github Dungeonに行きます

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

？‍貢献ガイドライン

1。？適切にサイズの変更を加えます

• 変更を小さく保ちます
• ダンジョンがデッドリンクでいっぱいにならないように、そのオプションを決定する読者にゲートを追加せずにオプションを追加しないでください。代わりに、読者が部屋の任意の道に到達する最後のマークダウンファイルには、選択肢がないはずです。

適切な変更の例をいくつか紹介します。

• 部屋の既存の「ページ」（ファイル）に1つまたは2つの文を追加します。
• 既存の選択ポイントに新しいオプションを追加し、そのオプションを既存の「ルーム」または「フロア」にリンクします。
• 既存の選択ポイントに新しいオプションを追加し、そのオプションの新しい「ページ」を作成し、新しい「ページ」に1つか2つの文を追加します。
• 現在の行き止まりの「ページ」にいくつかのオプションを追加し、各オプションの既存の「ページ」に「ページ」またはリンクを追加します。

2。

構造はdungeon-name/floor-number/room-numberである必要があります。各変数の以下の定義を参照してください。

• Dungeon-Name：フロア番号を含むフォルダーで、ダッシュ（ - ）で単語を分離する必要があります。例： Normal-Dungeon-1 。
• フロア数：部屋番号を含むフォルダーであり、数値は数字の前に0を追加しないでください。

 1, 2, 3 // Compliance

01, 02, A3 // Non-Compliance

• 部屋番号：マークダウンファイルで、ファイルの名前は数値である必要がありますが、部屋のサブルームがある場合は、部屋番号をダッシュ​​（ - ）で分離できる場合、サブルームは英数字である可能性があります。

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

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

フォルダーまたはファイル名は、すべてのASCII文字とダッシュ（ - ）のみを受け入れます。

新しいダンジョンを作成した場合は、新しいゲームを開始し、画像フォルダーに追加し、Dungeon-info.jsonに追加してください。

どのオプションが寄与するときにどのオプションが何につながるかを知りたい場合は、そのダンジョンのグラフィカルなビューを含むDungeonフォルダーの下でdecision_tree.pngファイルを探してください。

3。？相対リンクを使用します

このファイルのリンクは、リポジトリがフォークされている場合、動作を続けるための相対的なリンクでなければなりません。

4。？ラインの長さ

すべての行を120文字以下に保ちます。それ以外の場合、RAWファイルはブラウザまたはコマンドラインで読み取るのが難しく、変更を確認するのがより困難になります。

5。？オプション間の空白線

オプションが視覚的に分離されるように、異なるオプションの間に空白線を挿入します。

ライセンス

mit