dungeonclub

地牢俱乐部 - 虚拟桌面

一个在线平台来收集和玩龙，Cthulu，Pathfinder等人的呼唤等。

地牢俱乐部致力于成为所有人最用户友好的虚拟桌面，提供大量功能和舒适的设计。访问主页以展示功能或立即尝试演示！

发展

为了在本地运行和调试VTT，您需要DART SDK。如果您在Windows上，并且不希望安装Chocolatey的麻烦，我建议您改用本指南。

下载SDK并确保其路径的一部分后，将以下行作为一次性设置运行：

 # 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

Web应用程序的样式表是用Sass编写的，必须将其转换为CSS。您可以将SASS安装为独立可执行文件，也可以使用node.js package manager npm。

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

^{有关SASS和WebDev的更多信息。}

通过VS代码启动

如果您是使用IDE Visual Studio代码，则可以使用存储库的启动配置。您可以通过选择Launch All (Terminal)调试配置来同时启动后端和前端服务。

请注意，这种多合一的启动配置从VS Code的终端开始。这使您可以使用简单的R Keypress重新启动后端服务器。如果您喜欢IDE的调试控制台，则可以单独启动开发过程：

• Web/Frontend-运行Tasks: Run Build Task （或按Control + Shift + B ）。
• 服务器/后端- 运行Debug: Start Debugging （或按F5 ）并选择Launch Backend配置。

通过外壳启动

另外，您可以通过运行DART脚本来启动开发服务器。

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

初始化后端和网络服务后，您可以转到localhost:8080 ，并查看您刚刚交付的现场编译版的Dungeon Club。

源代码的更改在不同时间反映了您的工作部分。可以看到变化...

• 服务器代码- 重新启动服务器后。从终端启动时，您可以在终端内部按R重新启动后端过程。
• 网站代码- 刷新网站后（ http://localhost:8080 ）。
• 网站样式表- 刷新网站或按在网站上按Shift + R （Firefox上不可用）之后。

自我托管

您可以在https://dungeonclub.net上找到地牢俱乐部的官方公共版本。如果您想在计算机上托管本地服务器，则有两种实现此目的的方法。

预编译版本

每当更新推出到公共网站时，都会将新版本添加到“存储库版本”选项卡中。版本由简短的变形值组成，然后是针对多个平台和架构的预编译构建列表。

下载并解压缩所选构建后，您会在其中找到两个相关文件：

• server.exe-可执行的服务器。 （根据您的平台，文件扩展名可能不同。）
• login.yaml-可以定义自定义帐户登录的文件。

执行server.exe时，终端将打开，通知您，地牢俱乐部现在正在http://localhost:7070 。您可以导航到此地址，并查看您自己的VTT加载并准备使用的副本。

尝试通过在主页上填写电子邮件“管理员”，密码“ admin”来登录预注册的模拟帐户。除了创建的方式，使用模拟帐户与常规电子邮件验证的帐户没有区别。成功登录后，您将获得创建和管理自己的广告系列的能力。

如果您在网络中打开服务器端口（默认情况下为7070 ），则外部播放器应能够通过访问您的IP地址与本地托管的网站进行交互。

自定义构建

除了官方的可执行版本清单外，您还可以自己建立地牢俱乐部。请按照开发中描述的一次性设置安装所需的工具。然后，通过运行以下命令来执行包括存储库的专用构建脚本：

 dart bin/build.dart [options]

对于可能的参数列表，请运行dart bin/build.dart --help或参考下一节。

命令行参数

可以将以下选项作为对服务器和/或构建器的参数输入。

选项	定义	默认（服务）	默认（构建）
-h, --help	打印可用标志和选项的列表。
--[no-]mock-account	是否接受“ login.yaml”的内容作为注册帐户列表。	false	true
--[no-]music	是否启用集成音乐播放器。服务器主机可能需要安装YT-DLP和FFMPEG才能下载500 MB的背景音乐。	true	false
仅服务器
-p, --port	指定服务器端口。	7070
--bootstrap	all - 启用日志文件和优雅的退出 logging - 启用日志文件 none - 绕过引导者	all
仅构建
--[no-]copy-music	是否在构建中包括本地下载的音乐（氛围/曲目/*。mp3）。		false
--[no-]download-icons	是否下载并包括最新版本的字体Awesome（网站上使用的图标）		true
--part	哪些部分要编译并包括在构建中。可以是server或all 。		all