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