Roll20 uses cookies to improve your experience on our site. Cookies enable you to enjoy certain features, social sharing functionality, and tailor message and display ads to your interests on our site and others. They also help us understand how our site is being used. By continuing to use our site, you consent to our use of cookies. Update your cookie preferences .
×
Create a free account

Introducing the Roll20 API

We've said since the beginning that we wanted Roll20 to be a system-agnostic, general purpose virtual tabletop. Our primary goal has been making an application which brings all the great things about tabletop gaming online, while avoiding implementing features that go above and beyond what a physical tabletop can do, such as combat automation. We've also avoided implementing features which would make Roll20 too closely tied to any specific type of tabletop game, instead opting to create general tools like a Card Deck or a Journal that could be used with many different types of games and gameplay styles. However, we also know that while this provides a good foundation for the system, many of our users would like to take their Roll20 experience beyond this basic format and really customize things to fit their specific game of choice.&nbsp; Today we're pleased to introduce the Roll20 API for Mentor users which allows those who want this level of customization to interact directly with the data underlying their games.&nbsp;Be it custom dice rolls, automatic status marker management, or even tokens that patrol around the game board, the API provides a powerful set of tools that allow you to truly do just about anything you'd like to your game. <a href="http://www.youtube.com/watch?v=I-JD8I8T_ic" rel="nofollow">http://www.youtube.com/watch?v=I-JD8I8T_ic</a> At launch, the API already lets you interact with the tokens, maps, characters, handouts, chat, dice rolls, rollable tables, pages, and players of your campaigns, modifying nearly any property and responding to events in the game in real-time. We're going to continue further expanding the API as well to include additional in-game objects like the card decks, additional utility functions, and even additional ways to access the API. So if this is the sort of thing you've been wanting to do, be sure to check out the full API Documentation on the wiki, and if you're not already a Mentor, consider upgrading to get this and other great features and perks to get the most out of your Roll20 gaming.
Oh it is ON.
Mentor only? Too bad.
Cue Lonely Island soundtrack... And then the API came out and I... ****ed in my pants! Definitely going to have some fun with this. &nbsp;After I tear my&nbsp;nonexistent&nbsp;hair out learning yet another programming language's syntax, lol.
Riley D. said: (. . .) many of our users would like to take their Roll20 experience beyond this basic format and really customize things to fit their specific game of choice.&nbsp; Today we're pleased to introduce the Roll20 API for Mentor users which allows those who want this level of customization to interact directly with the data underlying their games. This sounds excellent.
Mentor only? :(((
Will this allow me to make scripts that turn Macros screen presence on and off depending on the PC or NPC's place in the turn order? As the GM, I'd like to see only the macros for the NPC that is currently at the top of the turn order appear on my screen. Then once their turn is done, the macros vanish and the next token I control's macros come up. Also, can I make a macro that will create a shape object around a token that will last for a given number of turns? What about a buff that changes the stats on other tokens?
1367754936
Alex L.
Pro
Sheet Author
Tuck S. said: Will this allow me to make scripts that turn Macros screen presence on and off depending on the PC or NPC's place in the turn order? As the GM, I'd like to see only the macros for the NPC that is currently at the top of the turn order appear on my screen. Then once their turn is done, the macros vanish and the next token I control's macros come up. Also, can I make a macro that will create a shape object around a token that will last for a given number of turns? What about a buff that changes the stats on other tokens? Maybe yes i will have a look give me 10 mins to prototype something.
1367755542
Alex L.
Pro
Sheet Author
Alex L. said: Tuck S. said: Will this allow me to make scripts that turn Macros screen presence on and off depending on the PC or NPC's place in the turn order? As the GM, I'd like to see only the macros for the NPC that is currently at the top of the turn order appear on my screen. Then once their turn is done, the macros vanish and the next token I control's macros come up. Also, can I make a macro that will create a shape object around a token that will last for a given number of turns? What about a buff that changes the stats on other tokens? Maybe yes i will have a look give me 10 mins to prototype something. Currently we don't have permission to write to the property "_macrobar" (it determines what is shown in the macro bar), until we do something like this won't be possible I'm afraid.
Thanks very much for looking at this. I imagine you have a large todo list. Frankly, except for a few weird glitches to do with the turn order window needing a reboot every now and then this tool is great. We use it ever time we play, and it's pretty good at what it does. Of course I have suggestions for improvements, but for a part time project you guys are doing an amazing job. From all my players- THANKS!
I wanted to give you some feedback on where I heard about this great site. This site was mention in a D&amp;D podcast called Major spoilers Critical Hit episode I believe #189.
You got my subscription support!
I am a Mentor, but my campaigns do not have an API script available to edit. Is there somewhere in the settings to turn on the API?&nbsp;
1368560108
Pat S.
Forum Champion
Sheet Author
they are on the dev server only for now.
1368560172
Gauss
Forum Champion
Josh, API is only live on the Dev server. Head over to the Dev server, go to the campaign details page of your campaign and click on API scripts. Note: If your campaign is on Main you will need to copy the campaign from Main to Dev.&nbsp; - Gauss
How do I go to the Dev server?
1369008423
Gauss
Forum Champion
Go to your account settings (top right corner, click on Welcome) and the link to the Dev server is on the right hand side about 1/3 down the page.&nbsp; Alternately:&nbsp; <a href="http://app.roll20dev.net/" rel="nofollow">http://app.roll20dev.net/</a> - Gauss
Thanks!
How to acess to game tabletop page? I'm new here, but i really like plaing and GM Rpg games. So where do i start?.. How to create a games? Do i hace to pay any thing?
1369176441
Gauss
Forum Champion
Wesley, this forum is for the API. Please post your questions in the General On-topic forum and they can be answered there:&nbsp; <a href="https://app.roll20.net/forum/category/20977" rel="nofollow">https://app.roll20.net/forum/category/20977</a> &nbsp; - Gauss
When do you think this might be rolled out beyond the Dev server. &nbsp; As a fan of roll20 I'd love to have access to it on a supporter level?
1370006487
Alex L.
Pro
Sheet Author
Chris A. said: When do you think this might be rolled out beyond the Dev server. &nbsp; As a fan of roll20 I'd love to have access to it on a supporter level? Even on Live it is currently only going to be for Mentors.
Chris A. said: When do you think this might be rolled out beyond the Dev server. &nbsp; As a fan of roll20 I'd love to have access to it on a supporter level? It's out on Main today, but still just for Mentors. At this point we have no plans to offer it below the Mentor level, as it's a premium feature which takes a lot of extra time for us both in supporting people using it and in just keeping the system running,&nbsp;
Just a question about the API to the staff... once it is live... does everyone playing have to be a mentor, or just the person who created the table with the scripts? &nbsp;IE, a person (me, once I'd upgrade to mentor) creates a table with scripts, can someone invite basic/supporter level people to still play on the table (although, they wouldn't be able to be a GM of the table). &nbsp; Secondarily, do you see it as something down the road where API scripts are part of an "Asset Module" someone would purchase in the marketplace (packaged along with the graphics, sounds, etc to be a complete game/table experience), or, do you see the scripts as always being "Open Sourced" as far as being editable by all who have rights?
The API is live. You only need one Mentor, and everyone at the table can be GMs. As with all the in-game benefits of the Mentor, and subscriber.&nbsp;