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/또는 http : // localhost : 8000/___ GraphQL로 이동하십시오

바닥과 객실 형식

바닥 은 폴더이고 각 층은 객실 모음이며 모든 객실은 Markdown 파일입니다. Markdown 기능 링크는 아래 예제와 같이 위/다운 및 다른 방으로 이동하는 데 사용됩니다.

Github Dungeon으로 가십시오

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

? ines 기여 지침

1.? 적절한 크기의 변화를 만듭니다

• 변경을 작게 유지하십시오
• 해당 옵션을 결정하는 독자에게 게이트를 추가하지 않고 옵션을 추가하지 마십시오. 던전에는 죽은 링크가 가득하지 않도록하십시오. 대신, 독자가 객실의 모든 경로에 도달하는 마지막 마크 다운 파일에는 옵션이 없어야합니다.

적절한 변경의 몇 가지 예는 다음과 같습니다.

• 객실의 기존 "페이지"(파일)에 하나 또는 두 문장을 추가하십시오.
• 기존 선택 점에 새 옵션을 추가하고 해당 옵션을 기존 "실"또는 "바닥"에 연결하십시오.
• 기존 선택 점에 새 옵션을 추가하고 해당 옵션의 새 "페이지"를 작성하고 새 "페이지"에 문장을 추가하십시오.
• 현재 막 다른 "페이지"에 몇 가지 옵션을 추가하고 각 옵션에 대해 "페이지"또는 기존 "페이지"에 링크를 추가하십시오.

2. ⛩ 던전 구조

구조는 dungeon-name/floor-number/room-number 여야합니다. 각 변수에 대한 아래 정의를 참조하십시오.

• Dungeon-Name : 바닥 번호가 포함 된 폴더이며, 대시 (-)와 단어를 분리 해야하는 폴더는 영숫자입니다. 예 : 정상-펀지 -1 .
• Floor-Number : 객실 번호가 포함 된 폴더이며 숫자는 숫자 전에 0을 추가하지 않습니다.

 1, 2, 3 // Compliance

01, 02, A3 // Non-Compliance

• Room-Number : 마크 다운 파일, 파일 이름은 숫자이어야하지만 객실의 하위 룸이 있으면 객실 번호를 대시 (-)로 분리 할 수 ​​있다면 하위 룸은 영숫자 일 수 있습니다.

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

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

폴더 또는 파일 이름은 모든 ascii 문자와 대시 (-) 만 허용합니다.

새 던전을 만들면 새 게임 시작을 추가하고 이미지 폴더와 Dungeon-Info.json에 추가하여 독자가 던전으로 가서 웹 사이트에서 열 수 있습니다.

어떤 옵션이 어떤 옵션으로 이어지는 지에 대한 아이디어를 얻으려면, Dungeon 폴더에서 Dungeon 폴더 아래에서 decision_tree.png 파일을 찾으십시오.

3.? 상대 링크를 사용하십시오

이 파일의 링크는 저장소가 포크 된 경우 계속 작동하려면 상대 링크 여야합니다.

4.? 라인 길이

모든 줄을 120 자 이하로 유지하십시오. 그렇지 않으면 원시 파일을 브라우저 나 명령 줄에서 읽기가 어렵고 변경 사항을 검토하기가 더 어렵습니다.

5.? 옵션 사이의 빈 줄

옵션이 시각적으로 분리되도록 다른 옵션 사이에 빈 줄을 삽입하십시오.

특허

MIT