dungeonclub

Dungeon Club - comprimido virtual

Uma plataforma on -line para reunir e jogar Dungeons & Dragons, Call of Cthulu, Pathfinder e muito mais.

O Dungeon Club se esforça para ser a mesa virtual mais amigável de todos, fornecendo toneladas de recursos e um design confortável. Visite a página inicial para uma demonstração de recursos ou tente a demonstração agora!

Desenvolvimento

Para executar e depurar a VTT localmente, você precisará do DART SDK. Se você está no Windows e não quer o trabalho de instalar o chocolate, recomendo seguir este guia.

Depois de baixar o SDK e garantir que ele faça parte do seu caminho, execute as seguintes linhas como uma configuração única :

 # Clone repository and navigate into the directory
git clone https://github.com/doodlezucc/dungeonclub.git
cd dungeonclub

dart pub get                     # Download all required packages
dart pub global activate webdev  # Download Dart->JavaScript transpiler

A folha de estilo do aplicativo da web está escrita em SASS e deve ser transpilada no CSS. Você pode instalar o SASS como um executável independente ou usando o Node.js Package Manager NPM.

npm install -g sass              # Download SCSS->CSS transpiler

^{Mais informações sobre SASS e WebDev.}

Lançamento via código VS

Se você é um código do IDE Visual Studio, pode usar as configurações de lançamento do repositório. Você pode iniciar o back -end e os serviços de front -end simultaneamente escolhendo a configuração de depuração Launch All (Terminal) .

Observe que esta configuração de lançamento all-in-one é iniciada no terminal do vs code. Isso permite que você reinicie o servidor de back -end com um KeyPress simples . Caso você prefira o console de depuração do IDE, você pode iniciar os processos de desenvolvimento separadamente:

• Web/Frontend - Executar Tasks: Run Build Task (ou pressione Control + Shift + B ).
• Servidor/back -end - Executar Debug: Start Debugging (ou pressione F5 ) e escolha a configuração Launch Backend .

Lançamento via shell

Como alternativa, você pode iniciar o servidor de desenvolvimento executando um script de dardo.

 # Launch the webdev server / stylesheet compiler / backend server
dart bin/dev.dart

Depois de inicializar o back-end e a Web Serviing, você pode ir ao localhost:8080 e ver sua versão recém-entregue e compilada ao vivo do Dungeon Club.

As alterações no código -fonte são refletidas em momentos diferentes, dependendo da parte em que você está trabalhando. Mudanças podem ser vistas ...

• Código do servidor - Após reiniciar o servidor. Ao iniciar a partir de um terminal, você pode pressionar R dentro do seu terminal para reiniciar o processo de back -end.
• Código do site - Após a atualização do site (em http://localhost:8080 ).
• Site Stylesheet - Depois de atualizar o site ou pressionar o Shift + R no site (não disponível no Firefox).

Auto-hospedagem

Você pode encontrar a versão pública oficial do Dungeon Club em https://dungeOnClub.net. Caso você queira hospedar um servidor local em sua máquina, há duas maneiras de conseguir isso.

Lançamentos pré-compilados

Sempre que uma atualização é lançada no site público, um novo lançamento é adicionado à guia Repositório de Repositório. Os lançamentos consistem em um curto-changelog, seguido de uma lista de compilações pré-compiladas para várias plataformas e arquiteturas.

Após o download e abrigar sua compilação selecionada, você encontrará dois arquivos relevantes dentro:

• Server.exe - o servidor executável. (Dependendo da sua plataforma, a extensão do arquivo pode ser diferente.)
• login.yaml - um arquivo que pode definir logins de conta personalizados.

Ao executar server.exe , um terminal se abre, informando que o Dungeon Club agora está servindo em http://localhost:7070 . Você pode navegar para este endereço e ver sua própria cópia do VTT carregado e pronto para uso.

Tente fazer login na conta simulada pré-registrada, preenchendo o email "admin", senha "admin" na página inicial. Não há diferença no uso de uma conta simulada versus uma conta regular verificada por e-mail , além da maneira como é criada. Após um login bem -sucedido, você recebe a capacidade de criar e gerenciar suas próprias campanhas.

Se você abrir a porta do servidor ( 7070 por padrão) em sua rede, os jogadores externos devem poder interagir com seu site hospedado localmente acessando seu endereço IP.

Construção personalizada

Além da lista oficial de lançamentos executáveis, você também pode criar o Dungeon Club. Siga a configuração única descrita no desenvolvimento para instalar as ferramentas necessárias. Em seguida, execute o script de construção dedicado incluído no repositório executando o seguinte comando:

 dart bin/build.dart [options]

Para obter uma lista de argumentos possíveis, execute dart bin/build.dart --help ou consulte a próxima seção.

Argumentos da linha de comando

As seguintes opções podem ser inseridas como argumentos para o servidor e/ou construtor.

Opção	Definição	Padrão (servir)	Padrão (build)
-h, --help	Imprime uma lista de sinalizadores e opções disponíveis.
--[no-]mock-account	Se deve aceitar o conteúdo de "login.yaml" como uma lista de contas registradas.	false	true
--[no-]music	Se deve permitir o tocador de música integrado. Os hosts do servidor podem precisar instalar o YT-DLP e o FFMPEG para baixar 500 MB de música em segundo plano.	true	false
Somente servidor
-p, --port	Especifica a porta do servidor.	7070
--bootstrap	all - Ativar arquivos de log e saídas graciosas logging - Ativar arquivos de log none - Bypass Bootstrapper	all
Construir apenas
--[no-]copy-music	Se deve incluir música baixada localmente (Ambience/Tracks/*. MP3) na construção.		false
--[no-]download-icons	Se deve baixar e incluir o lançamento mais recente do Font Awesome (ícones usados ​​no site)		true
--part	Quais peças para compilar e incluir na construção. Pode ser server ou all .		all