dungeonclub

Dungeon Club - Mesa virtual

Una plataforma en línea para reunir y jugar Dungeons & Dragons, Call of Cthulu, Pathfinder y más.

Dungeon Club se esfuerza por ser la mesa virtual más fácil de usar de todas, proporcionando toneladas de características y un diseño cómodo. ¡Visite la página de inicio para una demostración de características o pruebe la demostración ahora mismo!

Desarrollo

Para ejecutar y depurar el VTT localmente, necesitará el SDK DART. Si está en Windows y no quiere la molestia de instalar Chocolatey, le recomiendo seguir esta guía.

Después de descargar el SDK y asegurarse de que sea parte de su camino, ejecute las siguientes líneas como una configuración ú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

La hoja de estilo de la aplicación web está escrita en SASS y debe traspasarse a CSS. Puede instalar Sass como ejecutable independiente o utilizando el NODE.JS PACKATY Manager NPM.

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

^{Más información sobre Sass y WebDev.}

Lanzamiento a través de VS Code

Si está utilizando el código IDE Visual Studio, puede utilizar las configuraciones de lanzamiento del repositorio. Puede comenzar los servicios de backend y frontend simultáneamente eligiendo la configuración de depuración Launch All (Terminal) .

Tenga en cuenta que esta configuración de lanzamiento todo en uno comienza dentro del terminal del código. Esto le permite reiniciar el servidor de backend con una K keyPress simple. En caso de que prefiera la consola de depuración del IDE, puede iniciar los procesos de desarrollo por separado:

• Web/Frontend - Ejecutar Tasks: Run Build Task (o presione el control + shift + b ).
• Server/Backend - Ejecutar Debug: Start Debugging (o presione F5 ) y elija la configuración Launch Backend .

Lanzamiento de Via Shell

Alternativamente, puede iniciar el servidor de desarrollo ejecutando un script DART.

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

Después de inicializar el backend y la servicio web, puede ir a localhost:8080 y ver su versión recién entregada y compilada en vivo de Dungeon Club.

Los cambios en el código fuente se reflejan en diferentes momentos dependiendo de en qué parte esté trabajando. Se pueden ver cambios ...

• Código del servidor : después de reiniciar el servidor. Al lanzar desde un terminal, puede presionar R dentro de su terminal para reiniciar el proceso de backend.
• Código del sitio web : después de actualizar el sitio web (en http://localhost:8080 ).
• Hojas de estilo del sitio web : después de actualizar el sitio web o presionando Shift + R en el sitio web (no disponible en Firefox).

Anfitrión

Puedes encontrar la versión pública oficial de Dungeon Club en https://dungeonclub.net. En caso de que desee alojar un servidor local en su máquina, hay dos formas de lograr esto.

Lanzamientos previamente compilados

Cada vez que se lanza una actualización al sitio web público, se agrega una nueva versión a la pestaña Lanzamientos del repositorio. Los lanzamientos consisten en un breve Changelog seguido de una lista de compilaciones precompiladas para múltiples plataformas y arquitecturas.

Después de descargar y desactivar su compilación seleccionada, encontrará dos archivos relevantes dentro:

• Server.exe : el servidor ejecutable. (Dependiendo de su plataforma, la extensión del archivo puede diferir).
• Login.yaml : un archivo que puede definir inicios de sesión de cuenta personalizados.

Al ejecutar server.exe , se abre un terminal, informándole que Dungeon Club ahora está sirviendo en http://localhost:7070 . Puede navegar a esta dirección y ver su propia copia del VTT cargado y listo para usar.

Intente iniciar sesión en la cuenta simulada pre-registrada completando el correo electrónico "Admin", contraseña "Administrador" en la página de inicio. No hay diferencia en el uso de una cuenta simulada frente a una cuenta regular verificada por correo electrónico , aparte de la forma en que se crea. Tras un inicio de sesión exitoso, se le presenta la capacidad de crear y administrar sus propias campañas.

Si abre el puerto del servidor ( 7070 por defecto) en su red, los reproductores externos deberían poder interactuar con su sitio web alojado localmente accediendo a su dirección IP.

Construcción personalizada

Además de la lista oficial de lanzamientos ejecutables, también puede construir Dungeon Club usted mismo. Siga la configuración única descrita en el desarrollo para instalar las herramientas requeridas. Luego, ejecute el script de compilación dedicado incluido el repositorio ejecutando el siguiente comando:

 dart bin/build.dart [options]

Para obtener una lista de posibles argumentos, ejecute dart bin/build.dart --help o consulte la siguiente sección.

Argumentos de la línea de comandos

Las siguientes opciones pueden ingresarse como argumentos para el servidor y/o constructor.

Opción	Definición	Predeterminado (servir)	Predeterminado (compilación)
-h, --help	Imprime una lista de banderas y opciones disponibles.
--[no-]mock-account	Si se debe aceptar el contenido de "Login.yaml" como una lista de cuentas registradas.	false	true
--[no-]music	Si habilita el reproductor de música integrado. Los hosts del servidor pueden necesitar instalar YT-DLP y FFMPEG para descargar 500 MB de música de fondo.	true	false
Solo servidor
-p, --port	Especifica el puerto del servidor.	7070
--bootstrap	all - Habilitar archivos de registro y salidas elegantes logging - Habilitar archivos de registro none - Bypass Bootstrapper	all
Construir solamente
--[no-]copy-music	Si se debe incluir música descargada localmente (ambiente/pistas/*. Mp3) en la compilación.		false
--[no-]download-icons	Si descargar e incluir el último lanzamiento de Font Awesome (iconos utilizados en el sitio web)		true
--part	Qué piezas compilar e incluir en la construcción. Puede ser server o all .		all