Difference between revisions of "Player API"
From Roll20 Wiki
Andreas J. (Talk | contribs) (create page for listing APIs related to expand or restrict what players can do, and is meant to be a wiki element to be used with transclusion to some other pages) |
Andreas J. (Talk | contribs) m |
||
| Line 21: | Line 21: | ||
* '''[[Script:Token Lock|TokenLock]]''' – Allows GMs to selectively lock the movement of Player Tokens. - Useful for when you want to pause the situation and prevent players from accidentally revealing too much. | * '''[[Script:Token Lock|TokenLock]]''' – Allows GMs to selectively lock the movement of Player Tokens. - Useful for when you want to pause the situation and prevent players from accidentally revealing too much. | ||
<noinclude>==Related Pages== | <noinclude>==Related Pages== | ||
| − | * [[ | + | * [[Game Management]] |
** [[GM]] | ** [[GM]] | ||
** [[Players]] | ** [[Players]] | ||
| Line 29: | Line 29: | ||
** [[Adding Character Sheet]] | ** [[Adding Character Sheet]] | ||
* [[Complete Macro Guide]] | * [[Complete Macro Guide]] | ||
| + | * [[Community FAQ]] | ||
<br> | <br> | ||
<br> | <br> | ||
[[Category:API]][[Category:Tips]]</noinclude> | [[Category:API]][[Category:Tips]]</noinclude> | ||
Revision as of 17:03, 3 April 2021
 | This is about a Roll20 feature exclusive to Pro-subscribers (and often to players in a Game created by a Pro-subscriber). If you'd like to use this feature, consider upgrading your account. |
This is a guide listing various API scripts that can be used for expanding or restricting what players normally can do in Roll20. Normally, people in a campaign is either:
- the GM/Creator, who have full access and visibility to everything in a game, or
- a player, who can only see and affect a limited number of things, most of which a GM explicitly needs give the player permissions/access to
This base system lacks some granularity and has some frustrations to first-time users(like how a GM needs to create & assign character sheets to players), but there are surprisingly many API that can change that.
Using these APIs you can hand some campaign resposnibilites to individual or all players, or to create a "Co-GM" that can do almost as many things as an actual GM, when needed.
Expand Permissions
Some GM-only features can be indirectly be granted to players through using different APIs:
- emas -- Provides player
!emasand!ascommands. This is equvivalent to the/emas, which is GM-only - Roll20 Audio Master (aka. Roll20AM) -- API commands to manage the u Jukebox, GM can grant selective access to individual players/tracks
- MapChange(Forum) -- has option to allow players to move between map pages, and GM can choose which pages are available/visible to them
- CharacterSheet -- A simple and easily customizable script allowing players to create their own character sheets, using the command
!charsheet - PublicSheet(Forum) — create public, read-only versions of character sheets
Restrict Permissions
There are also API that can be used to restrict players more that normal:
- DryErase(Forum) – An API that can stop players from drawing on the map, deleting any drawing instantly.
- TokenLock – Allows GMs to selectively lock the movement of Player Tokens. - Useful for when you want to pause the situation and prevent players from accidentally revealing too much.
Related Pages
- Game Management
- API:Script Index - longer list of APIs
- Subscription | Free vs Plus vs Pro
- Character Sheets
- Complete Macro Guide
- Community FAQ
