-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add dr wiki * fix link * remove alt-text in links
- Loading branch information
Showing
14 changed files
with
478 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| *.zip |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
| --- | ||
| id: dr-wiki-community-showcase | ||
| title: Dungeon Revealer Community Showcase | ||
| is_entry_point: false | ||
| --- | ||
|
|
||
| Here is a showcase of the interesting ways members of our community are using dungeon-revealer. If you want us to feature your project using dungeon-revealer, please contact us! | ||
|
|
||
| ## Tabletop TV | ||
| [hinjodragonfly](https://github.com/hinjodragonfly) has created a case for a television that sits on the tabletop. There is a [Raspberry Pi](https://www.raspberrypi.org/) in the case running dungeon-revealer and presenting the player view on the screen. The DM page is accessed with a tablet. | ||
|
|
||
|
|
||
| <img src="https://user-images.githubusercontent.com/58919182/71115958-68e6e580-21d3-11ea-917d-d17a5e1d81c6.jpg" alt="" width="500"/> | ||
|
|
||
| <img src="https://user-images.githubusercontent.com/58919182/71115957-68e6e580-21d3-11ea-853a-5f63be61bcda.jpg" alt="" width="500"/> | ||
|
|
||
| <img src="https://user-images.githubusercontent.com/58919182/71115959-697f7c00-21d3-11ea-9999-364bb6e52129.jpg" alt="" width="600"/> | ||
|
|
||
|
|
||
| ## Tabletop Simulator Mod | ||
| [azzco](https://github.com/azzco) has made a [Tabletop Simulator mod](https://steamcommunity.com/sharedfiles/filedetails/?id=2164161399) that projects the player view onto the table background. Players can also view the map through the in-game tablets. | ||
|
|
||
| <img src="https://media.discordapp.net/attachments/730140662691004598/731867556939300884/screenshot.png" alt="" width="600"/> | ||
| <img src="https://steamuserimages-a.akamaihd.net/ugc/1322320201362126177/A05DA92F40DEA1C213858EEE2C081407A189863D/" alt="" width="600"/> | ||
| <img src="https://steamuserimages-a.akamaihd.net/ugc/1322320201362190974/9D87EEB77C5C1B39ADCB308502DBF99A30AB5802/" alt="" width="600"/> | ||
| <img src="https://steamuserimages-a.akamaihd.net/ugc/1322320201362192721/D223ADD2BB0B6E5DCCAEBC7F1C12C8B9C098ACE4/" alt="" width="600"/> | ||
|
|
||
| ## Bikers Dice and Bars Podcast | ||
| The [Bikers Dice and Bars podcast](https://breakfastpuppies.com/podcasts/bikersdicebars) by [nonplayer](https://github.com/nonplayer) released an [episode about virtual tabletops](https://breakfastpuppies.com/podcast-feeds/bdab-bonus-virtual-tabletops-w-alex-hakobian/). They compare various VTTs and feature dungeon-revealer in their "offline VTT" section. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| --- | ||
| id: dr-wiki-contributing | ||
| title: Dungeon Revealer Contributing | ||
| is_entry_point: false | ||
| --- | ||
|
|
||
| The files for the wiki are kept in the [wiki](https://github.com/dungeon-revealer/dungeon-revealer/tree/master/wiki) folder of the [dungeon-revealer repository](https://github.com/dungeon-revealer/dungeon-revealer/). | ||
| To edit the wiki, you can [fork the repository](https://github.com/dungeon-revealer/dungeon-revealer/fork), make changes, and then open a pull request. | ||
| It's the same process as if you were making changes to the code. | ||
|
|
||
|
|
||
| You can also do all of this on the github website itself. | ||
| Simply navigate to the [wiki](https://github.com/dungeon-revealer/dungeon-revealer/tree/master/wiki) folder, open the file you wish to edit, and click on the edit button. | ||
| Github will take care of the fork and pull request processes for you. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| --- | ||
| id: dr-wiki-dice-macros | ||
| title: Dungeon Revealer Dice Macros | ||
| is_entry_point: false | ||
| --- | ||
|
|
||
| ## Chat Message Macros | ||
|
|
||
| ### Simple Macro | ||
|
|
||
| ```hbs | ||
| <ChatMacro message="Attack with Axe [1d20] makes [2d6] Damage"> | ||
| Attack with Axe | ||
| </ChatMacro> | ||
| ``` | ||
|
|
||
| You can embed dice rolls by using a dice notation formula surrounded by square brackets. Besides using them in macros, you can also simply type dice rolls into the chat. | ||
|
|
||
| Examples of dice rolls: | ||
|
|
||
| - `[1d20]` | ||
| - `[3d6]` | ||
| - `[(1d4 + 1) * 3 ]` | ||
| - `[1d9000]` | ||
|
|
||
| When toggeling from the editor mode back into the rendered note mode the above macro will be rendered as a clickable button with the text `Attack with Axe`. | ||
| Click that button for sending the contents of the `message` attribute (`Attack with Axe [1d20] makes [2d6] Damage`) to the chat! | ||
|
|
||
| ### Template Macro | ||
|
|
||
| For more complex templates it is encouraged to use a template. Templates can be declared once per note and re-used with different variables: | ||
|
|
||
| ```hbs | ||
| <Template id="attackTemplate"> | ||
| <Box> | ||
| <BoxRow> | ||
| <span style="color:red;font-weight:bold">Attack with {{weapon}}</span> | ||
| </BoxRow> | ||
| <BoxRow> | ||
| <BoxColumn> | ||
| Attack Roll | ||
| </BoxColumn> | ||
| <BoxColumn> | ||
| {{attackRollFormula}} | ||
| </BoxColumn> | ||
| </BoxRow> | ||
| <BoxRow> | ||
| <BoxColumn> | ||
| Damage | ||
| </BoxColumn> | ||
| <BoxColumn> | ||
| {{damageRollFormula}} | ||
| </BoxColumn> | ||
| </BoxRow> | ||
| </Box> | ||
| </Template> | ||
| <ChatMacro | ||
| templateId="attackTemplate" | ||
| var-weapon="Handaxe" | ||
| var-attackRollFormula="[1d20 + 5]" | ||
| var-damageRollFormula="[1d6 + 6]" | ||
| > | ||
| Attack with Handaxe | ||
| </ChatMacro> | ||
| <ChatMacro | ||
| templateId="attackTemplate" | ||
| var-weapon="Axe" | ||
| var-attackRollFormula="[1d20 + 4]" | ||
| var-damageRollFormula="[1d4 + 4]" | ||
| > | ||
| Attack with Dagger | ||
| </ChatMacro> | ||
| ``` | ||
|
|
||
| A template can be declared by using the `Template` tag. Make sure to set a unique `id` attribute that can later be used for referencing the template. | ||
|
|
||
| Inside the template you can use the following html tags: | ||
|
|
||
| - div (Allowed attributes: `style`) | ||
| - span (Allowed attributes: `style`) | ||
|
|
||
| As well as the following custom components for structuring content: | ||
|
|
||
| - Box (Box with grey border and rounded corners) | ||
| - BoxRow (Horizontal row) | ||
| - BoxColumn (horizontal row column) | ||
|
|
||
| Variables can bes set by using the variable name surrounded by curly brackets `{{myVariable}}`. | ||
|
|
||
| The template can be used by setting the `templateId` attribute to the Template `id`. In addition variable values can be passed by setting them as attributes on the `ChatMacro` and prefixing them with `var-`. | ||
|
|
||
| E.g. the attribute for substituting the `myVariable` variable is `var-myVariable="My Custom Value"`. | ||
|
|
||
| This allows easily defining triggers for multiple skill checks or weapon attacks. | ||
|
|
||
| ```hbs | ||
| <Template id="skillCheck"> | ||
| <div style="background-image:url('/api/images/04545c2f-6f7b-4fc6-a9d8-6d6580503031');background-position: 100% center;background-size:contain;background-repeat:no-repeat"> | ||
| <Box> | ||
| <BoxRow> | ||
| <BoxColumn> | ||
| <div style="font-weight:bold;color:#B71C1C">{title}</div> | ||
| </BoxCoumn> | ||
| </BoxRow> | ||
| <BoxRow> | ||
| <BoxColumn>{{attribute1}}</BoxColumn> | ||
| <BoxColumn>[1d20]</BoxColumn> | ||
| </BoxRow> | ||
| <BoxRow> | ||
| <BoxColumn>{{attribute2}}</BoxColumn> | ||
| <BoxColumn>[1d20]</BoxColumn> | ||
| </BoxRow> | ||
| <BoxRow> | ||
| <BoxColumn>{{attribute3}}</BoxColumn> | ||
| <BoxColumn>[1d20]</BoxColumn> | ||
| </BoxRow> | ||
| </Box> | ||
| </div> | ||
| </Template> | ||
| <ChatMacro | ||
| templateId="skillCheck" | ||
| var-title="Swim Skill Check" | ||
| var-attribute1="Dexterity" | ||
| var-attribute2="Constitution" | ||
| var-attribute3="Strength" | ||
| > | ||
| Schwimmen Probe | ||
| </ChatMacro> | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| --- | ||
| id: dr-wiki-getting-started | ||
| title: Dungeon Revealer Getting Started | ||
| is_entry_point: false | ||
| --- | ||
|
|
||
| The app is separated into two sections. One for the dungeon master and one for the players. | ||
|
|
||
| ## Dungeon Master | ||
|
|
||
| To use dungeon-revealer, the game master and the players must be on the same local network (usually a wifi network). The game master will start the server (see [Installation](dr-wiki-install)), navigate to the server's URL (`your-ip:3000/dm`) in a web browser, and then enter a password if it is set. At this point, they will be prompted to upload an image file of the map to share with the other players. The other players will navigate to the server (`your-ip:3000`) using their own browsers (laptop, tablet, or phone) and will remain at the home page. The connection information is displayed in command prompt for convenience. | ||
|
|
||
| To clear areas of the map, click and draw on the map. You can switch the brush mode by clicking the "Reveal" or "Shroud" button. Alternatively, you can select an area to clear or shroud by clicking the "Select Area" button. Whenever the game master clears some of the fog of war from the map and it is ready to share with the players, they will click "Send" and the revealed areas of the map will appear in the players' browsers. What appears as a shadow to the DM will appear as pure blackness to players, thus only revealing the cleared sections of the map to them. The "Mark" button will display a circle for a period of time to indicate a point of interest. | ||
|
|
||
| To switch to a different map, click "Map Library", and then select one of the maps you have already uploaded and click "Load". The "LIVE" indicator in the lower right indicates if the map currently on the dungeon master page is being presented on the player page. The "Stop Sharing" button will blank the player page in preparation for a new map to be loaded. | ||
|
|
||
| You can add a [token](dr-wiki-tokens) with the "Token" tool. Click anywhere on the map to place it. The token can be changed by opening the context menu trough right-clicking on a single token. You can alter its label, color and size. | ||
|
|
||
| ### Shortcuts | ||
|
|
||
| | Key | Functionality | | ||
| | -------------- | --------------------------------------------------------------------------------------------- | | ||
| | `1` | select move tool. | | ||
| | `2` | select area tool. | | ||
| | `3` | select brush tool. | | ||
| | `4` | select mark tool. | | ||
| | `5` | select token tool. | | ||
| | `Shift` | toggle between hide/reveal. | | ||
| | `CMD/Ctrl + S` | push map to players. | | ||
| | Hold `Alt` | use move tool while `Alt` key is pressed and return to previous mode after `Alt` is released. | | ||
|
|
||
| ## Players | ||
|
|
||
| Navigate to the server using a web browser and wait at the home page. (The connection information is displayed in command prompt for convenience.) When the dungeon master is ready, they will push a map to your webpage. You will see either a black screen or a partially covered image. You can zoom in/out and pan the map. On a long click you will place a "point of interest" on the map that will show as a red circle. | ||
|
|
||
| ### Hide Chat & Note UI | ||
|
|
||
| Append "?map_only" to the URL in order to hide chat & note UI. E.g. `http://localhost:3000/?map_only`. This could be useful in a setup where all players are around a table with a single monitor, for example. | ||
|
|
||
| This can also be used with the password parameter: `http://localhost:3000/?map_only&password=foobar123`. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| --- | ||
| id: dr-wiki-grid | ||
| title: Dungeon Revealer Grid | ||
| is_entry_point: false | ||
| --- | ||
|
|
||
| A grid helps to align tokens added to the map and can be used to easily reveal portions of the map. Any token with size `1x` added to a map with a grid will default to the grid size. | ||
|
|
||
| ## Creating the grid | ||
|
|
||
| Click on the `Add Grid` button at the bottom to open the grid configuration menu. | ||
|
|
||
| Confirm adding a grid and adjust the grid size to match one square of your map. You can increase or decrease the grid size using the Column Width and Column Height boxes. Use the X-and-Y coordinates boxes to align the grid with your map, or press ALT and drag the grid on the map using your mouse. | ||
|
|
||
|  | ||
|
|
||
| ## Grid Settings | ||
|
|
||
| To edit an existing grid, click on `Grid Settings` at the bottom of the main page to adjust the visual style of the grid. | ||
|
|
||
|  | ||
|
|
||
| You can adjust the visibility of the grid for both you and the players. The `rgba`box can be used adjust the color and transparency of the grid. | ||
|
|
||
| The grid can be modified by clicking `Edit Grid`. This will return to the `Grid Configurator`. | ||
|
|
||
| ## Grid Reveal | ||
|
|
||
| You can use the `Area` tool on the left toolbar to reveal or shroud blocks. Click the `Area` tool and set `Snap to grid` to `On`. Using the tool you can reveal or shroud a box in the created grid by selecting an area inside the box with it. | ||
|
|
||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| --- | ||
| id: dr-wiki-home | ||
| title: Dungeon Revealer Home | ||
| is_entry_point: false | ||
| --- | ||
|
|
||
| dungeon-revealer is a web app for tabletop gaming to allow the game master to reveal areas of the game map to players. Join the [discord server](https://discord.gg/dS5khqk). | ||
|
|
||
| ## What the DM Sees | ||
|
|
||
|  | ||
|
|
||
| You can protect the DM area by setting a password. | ||
|
|
||
| ## What the players see | ||
|
|
||
|  |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| --- | ||
| id: dr-wiki-hosting | ||
| title: Dungeon Revealer Hosting | ||
| is_entry_point: false | ||
| --- | ||
|
|
||
| Under construction! | ||
|
|
||
| ## Self-Hosting | ||
|
|
||
| ### Local Network | ||
|
|
||
| Local network connection is currently the default assumption of these docs. | ||
|
|
||
| ### Remote Access | ||
|
|
||
| In order to allow players and even other DMs to remotely access to your installation, you need to enable additional outside services. The easiest two approaches to this are either using a Virtual Private Network (VPN), or a combination of Dynamic DNS (DDNS) and local port forwarding: | ||
|
|
||
| * **VPN:** Many modern routers feature built-in VPN configuration. See your router's docs for more details. | ||
| * **DDNS:** A number of [free and paid online DDNS services](https://www.google.com/search?q=dynamic+dns&oq=dynamic+dns) exist that can forward a custom hostname to your home internet network. Using port forwarding (see your router's docs) it's easy to then forward a remote port to the host port of your Dungeon Revealer installation. | ||
|
|
||
| ### Hosting on a Server | ||
|
|
||
| - [Install Dungeon Revealer on a Digital Ocean Droplet](https://www.ehrenpforte.com/technical-2/943/) |
Oops, something went wrong.