markdown dungeon

⚔️ Masmorra de Marydown ⚔️

Uma masmorra é um lugar ou prisão onde as pessoas são mantidas. Geralmente, eles podem ser encontrados no subsolo

Este é um exemplo de ilustração repo de uma masmorra usando o Markdown no Github. Na masmorra, o leitor escolhe qual opção levar e pular para uma página apropriada da sala que se baseia em sua escolha. É colaborativo porque a sala é escrita por muitos autores.

Comece um novo jogo

? Instalação

Você precisa instalar o fio.

1. Clone o repo

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

2. Vá para a pasta

 cd markdown-dungeon

3. Execute a dependência de instalação

yarn

4. Crie um arquivo .env.development na pasta Root Project e copie o formato do arquivo .env.example .
5. Para iniciar a execução do servidor de desenvolvimento:

yarn start

Certifique -se de que você não está usando o PowerShell

6. ? Abra seu navegador e vá para http: // localhost: 8000/ou http: // localhost: 8000/___ graphql

Piso e formato da sala

Um piso é uma pasta e cada piso é uma coleção de quartos e cada quarto é um arquivo Markdown . Os links de capacidade de marcação são usados ​​para cima/para baixo e para outra sala, como o exemplo abaixo.

Vá para o Github Dungeon

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

Diretrizes de contribuição?

1.? Faça alterações de tamanho adequado

• Mantenha as mudanças pequenas
• Não adicione uma opção sem adicionar nenhum portão para os leitores que decidem essa opção, para que a masmorra não esteja cheia de links mortos. Em vez disso, o último arquivo de marcação que o leitor atinge em qualquer caminho da sala não deve ter nenhuma opção.

Aqui estão alguns exemplos de mudanças apropriadas:

• Adicione uma ou duas frases a uma "página" existente na sala.
• Adicione uma nova opção a um ponto de escolha existente e vincule essa opção a um "quarto" ou "piso" existente.
• Adicione uma nova opção a um ponto de escolha existente, crie uma nova "página" para essa opção e adicione uma ou duas frases à nova "página".
• Adicione algumas opções a uma "página" de extremidade inicial atual e adicione uma "página" ou link para uma "página" existente para cada opção.

2. ⛩ Estrutura de masmorra

A estrutura deve ser dungeon-name/floor-number/room-number , consulte as definições abaixo para cada variável:

• Dungeon-Name: é uma pasta que contém o número do piso, deve separar as palavras com um traço (-), é alfanumérico. Exemplo: Dungeon Normal-1 .
• NOBRE O PISO: é uma pasta que contém o número do quarto, é numérico, não adicione 0 antes do número.

 1, 2, 3 // Compliance

01, 02, A3 // Non-Compliance

• Número da sala: é um arquivo de marcação, o nome do arquivo deve estar no numérico, mas se tiver sub-salas da sala, você pode separar o número da sala com um traço (-), o sub-quarto pode ser alfanumérico.

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

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

Nome da pasta ou arquivo Aceite apenas todos os caracteres ASCII e o traço (-).

Se você criou uma nova masmorra, adicione Iniciar um novo jogo, adicione-o na pasta de imagens e na masmorra-info.json, para que o leitor possa ir para sua masmorra e abri-lo no site

Se você deseja ter uma idéia de qual opção leva ao que, ao contribuir, procure o arquivo decision_tree.png na pasta Dungeon, que contém uma visualização gráfica dessa masmorra.

3.? Use links relativos

Os links neste arquivo devem ser links relativos para continuar trabalhando se o repositório for bifurcado.

4.? Comprimentos de linha

Mantenha todas as linhas 120 caracteres ou menos. Caso contrário, os arquivos brutos serão difíceis de ler no navegador ou na linha de comando, e as alterações serão mais difíceis de revisar.

5.? Linhas em branco entre opções

Insira linhas em branco entre as diferentes opções para que as opções sejam visualmente separadas.

Licença

Mit