Difference between revisions of "Dungeon Connect API"
From Roll20 Wiki
Stephen S. (Talk | contribs) (→Menu Overview) |
Andreas J. (Talk | contribs) m |
||
| (8 intermediate revisions by one user not shown) | |||
| Line 3: | Line 3: | ||
There are lots of limitations since we don’t have canvas select at this time; still Dungeon Connect is a flexible and forgiving API solution to map making on Roll20. | There are lots of limitations since we don’t have canvas select at this time; still Dungeon Connect is a flexible and forgiving API solution to map making on Roll20. | ||
| + | |||
==GM Layer== | ==GM Layer== | ||
| Line 8: | Line 9: | ||
Read more on layers here: [[Layers]] | Read more on layers here: [[Layers]] | ||
| + | |||
==Menu Overview== | ==Menu Overview== | ||
[[File:DungeonConnectMenu.png|thumb|upright|alt=Dungeon Connect Menu.|Dungeon Connect Menu.]] | [[File:DungeonConnectMenu.png|thumb|upright|alt=Dungeon Connect Menu.|Dungeon Connect Menu.]] | ||
| − | # '''Direct Placement of Doors/stairs:''' | + | # '''Direct Placement of Doors/stairs:''' Indented line Will place a door/stair tile near the center of that map that can be moved and placed from the GM layer. |
| − | + | # '''Cancel Fill Area:''' Removes any "Paint Cans" used to fill map areas (saves selection-delete or useful if you have several flaoting around you want to dismiss. | |
| − | + | # '''Fill Area:''' Creates a "Paint Can" used to fill map areas. "Paint Can" is created near the center of the map. | |
| − | # '''Cancel Fill Area:''' | + | # '''Merge Points:''' Two selected "end points" segments will be merged into one. Menu button or "nudge rotation" triggered. |
| − | + | # '''Connect Points:''' Two selected "end points" segments will have a connection path add to join them. Menu button or "nudge rotation" triggered. | |
| − | # Fill Area | + | # '''Add Branch to a Point:''' A selected "end point" will have a branch segement added to it. Menu button or "nudge rotation" triggered. |
| − | # Merge Points | + | # '''Add a Point to a Segement:''' A selected "middle marker" will be removed and replaced with an "end point." Splitting one segment into two. Menu button or "nudge rotation" triggered. |
| − | # Connect Points | + | # '''Add A Segement:''' Adds a new segment near the center of the map. |
| − | # Add Branch to a Point | + | # '''More Commands:''' Clicking provides more menu options or toggles back to the main menu. |
| − | # Add a Point to a Segement | + | # '''Toggle API "On" or "Off:"''' This turns off most of the API functions. |
| − | # Add A Segement | + | # '''Get Help:''' In game link to this Wiki page. |
| − | # More Commands | + | # '''Clear Map:''' Removes all "Dungeon Connect" generated images and paths. |
| − | # Toggle API "On" or "Off | + | # '''Change Texture:''' Allows for multiple tile packs to be used with the API script. |
| − | # Get Help | + | |
| − | # Clear Map | + | |
| − | # Change Texture | + | ==Split the Party & Player's Bookmark== |
| + | [[File:Splitpartyss.jpg|thumb|right|Recommend using the party split feature to select the page you wish to edit.]] | ||
| + | [[File:DungeonDrawMistake.jpeg|thumb|right|Avoid this!! Easy mistake is you (GM) being a page different from your party split avatar.]] | ||
| + | This script leverages the "Split the Party" and "Player's Bookmark" to determine the active page for editing.<br /> | ||
| + | <br /> | ||
| + | Its is prefered that controlling GM drag-and-drop the "Player Avatar" to the page they which to map with Dungeon Connect. All changes by the API will be applied to that page.<br /> | ||
| + | <br /> | ||
| + | If the controlling GM has not done this, the Player's Bookmark will act as the active page.<br /> | ||
| + | <br /> | ||
| + | '''Caution:''' Easy mistake is you (GM) being a page different from your party split avatar (notice the BLUE border.)<br /> | ||
| + | <br /> | ||
| + | [[File:PageToolbar_SplitThePartyExample.gif]]<br /> | ||
| + | <br /> | ||
| + | See [[Page_Toolbar|Page Toolbar]] for more information.<br /> | ||
| + | <br /> | ||
| + | [[Category:Old Pages]] | ||
Latest revision as of 22:52, 31 January 2021
Contents |
[edit] Dungeon Connect: "Line Segemtent" Map Making
Dungeon Connect emulates some common features found in drawing tools; such as creating line segments between “points” where the points can be moved or added to change the overall shape and dimensions of the drawing. This allows for a map making experience that is somewhat like drawing a map in an image editing program.
There are lots of limitations since we don’t have canvas select at this time; still Dungeon Connect is a flexible and forgiving API solution to map making on Roll20.
[edit] GM Layer
The Dungeon Connect API is designed so the map can be created and edit from the "GM layer." This reduces the need to switch between layer during the process of map creation.
Read more on layers here: Layers
[edit] Menu Overview
- Direct Placement of Doors/stairs: Indented line Will place a door/stair tile near the center of that map that can be moved and placed from the GM layer.
- Cancel Fill Area: Removes any "Paint Cans" used to fill map areas (saves selection-delete or useful if you have several flaoting around you want to dismiss.
- Fill Area: Creates a "Paint Can" used to fill map areas. "Paint Can" is created near the center of the map.
- Merge Points: Two selected "end points" segments will be merged into one. Menu button or "nudge rotation" triggered.
- Connect Points: Two selected "end points" segments will have a connection path add to join them. Menu button or "nudge rotation" triggered.
- Add Branch to a Point: A selected "end point" will have a branch segement added to it. Menu button or "nudge rotation" triggered.
- Add a Point to a Segement: A selected "middle marker" will be removed and replaced with an "end point." Splitting one segment into two. Menu button or "nudge rotation" triggered.
- Add A Segement: Adds a new segment near the center of the map.
- More Commands: Clicking provides more menu options or toggles back to the main menu.
- Toggle API "On" or "Off:" This turns off most of the API functions.
- Get Help: In game link to this Wiki page.
- Clear Map: Removes all "Dungeon Connect" generated images and paths.
- Change Texture: Allows for multiple tile packs to be used with the API script.
[edit] Split the Party & Player's Bookmark
This script leverages the "Split the Party" and "Player's Bookmark" to determine the active page for editing.
Its is prefered that controlling GM drag-and-drop the "Player Avatar" to the page they which to map with Dungeon Connect. All changes by the API will be applied to that page.
If the controlling GM has not done this, the Player's Bookmark will act as the active page.
Caution: Easy mistake is you (GM) being a page different from your party split avatar (notice the BLUE border.)
See Page Toolbar for more information.
