Difference between revisions of "Script:Dungeon Utils"
From Roll20 Wiki
(Created page with "{{script overview |name=DungeonUtils |author={{user profile|518146|Alex B.}} |version=1.0 |lastmodified=2016-03-01}} {{stub}} ===Overview=== This script contains useful com...") |
(→Using images) |
||
| Line 27: | Line 27: | ||
====Using images==== | ====Using images==== | ||
If the script requires an image, it needs the URL of a thumbnail. To get this, first find an image in the Marketplace and favorite it. | If the script requires an image, it needs the URL of a thumbnail. To get this, first find an image in the Marketplace and favorite it. | ||
| − | Then, find the image in your Art Library, right-click the image and select "Copy image address." This URL can be pasted into | + | Then, find the image in your Art Library, right-click the image and select "Copy image address." This URL can be pasted into commands. |
(Note: If you do not get the URL from your Art Library, it will not work). | (Note: If you do not get the URL from your Art Library, it will not work). | ||
Revision as of 01:04, 2 March 2016
API ScriptAuthor: Alex B.
Version: 1.0
Last Modified: 2016-03-01
Code: DungeonUtils
Dependencies: None
Conflicts: None
Version: 1.0
Last Modified: 2016-03-01
Code: DungeonUtils
Dependencies: None
Conflicts: None
 | This article is a stub. |
Contents |
Overview
This script contains useful commands for quickly editing dungeons.
Commands
- !du paper [<floor=thumbnail-path>] [<stride=Number>]
- Covers the map/background layer of the current player-active page with the given image.
- !du dungeon [<wall=thumbnail-path>] [<floor=thumbnail-path>] [<stride=Number>]
- Randomly generates a dungeon on the map/background layer of the current player-active page. Includes dynamic lighting
- !du clear
- Deletes all dynamic lighting and all images added by this plugin
Usage
Configuration
Configuration is not required to use this module. However, setting default images can make things quicker. Refer to the comments at the top of the code for how to configure the 4 default variables.
Using images
If the script requires an image, it needs the URL of a thumbnail. To get this, first find an image in the Marketplace and favorite it. Then, find the image in your Art Library, right-click the image and select "Copy image address." This URL can be pasted into commands. (Note: If you do not get the URL from your Art Library, it will not work).
Examples
Grass Paper!
- Move the "Players" ribbon to an empty page
- Get an image URL from your Art Library
- Type the following command into the game chat:
!du paper f=URL s=WIDTH
Replace URL with a Roll20 thumbnail, and replace WIDTH with the width of the image in tiles. E.g.:!du paper f=https://s3.amazonaws.com/files.d20.io/images/7186/thumb.jpg?1336392023 s=3
Random Dungeon Generation
- Move the "Players" ribbon to an empty page
- Enter the following command:
!du dungeon f=URL w=URL s=WIDTH
where f is a floor image from your Art Library and and w is your wall image. This may take a while; very large maps are not recommended. - (Optional) Enable dynamic lighting
Backlog
- Add a feature for replacing images with other images
- Make a more efficient dungeon generation algorithm
Changelog
v1.0 (2016-03-01)
- Release
