Skip to content

Latest commit

 

History

History
85 lines (65 loc) · 3.66 KB

README.md

File metadata and controls

85 lines (65 loc) · 3.66 KB

Deal-Init

Roll20 API Script to Deal Initiative for Savage Worlds Games

DealInit supports Savage Worlds style card based inititive by dealing cards to the Turn Order and 
sorting the order by suit.  

(Note: If you are using VTTES to enhance your Roll20 experience, you must disable 
"Automatically Sort Initiative" in the VTTES config settings for Deal-Init to work properly.)

DealInit does not utilize the Roll20 deck system. Instead it manages an internal array of cards 
that are reshuffled when the deck runs out or a joker is drawn.

It also checks character attributes for any SW Inititative Edges and handles them appropriately.  
The Initiative Edges must be stored in a comma separated list in an Attribute named 
"InitEdges" (e.g. Qui,LH)

The Edge shorthand is as follows: (spelling and case count!)
  Qui = Quick
  LH  = Level Headed
  ILH = Improved Level Headed
  TT  = Tactician (cards dealt to chat)
  MTT = Master Tactician (cards dealt to chat)
  HH  = Hesitant Hindrance 
  WCE = Any Joker Activated Wild Card Edge (announced in turn order)

Going on Hold is accomplished by the GM editing the affected token's card in teh Turn Order to 
be "H" or "h."  As long as the card is an H/h, DealInit will not deal a card to that token and 
will put it at the top of the order on a new round.  The GM must set the card to an non-H/h 
value in order for DealInit to start dealing to that token again.

The script only has a few options:

!deal-init [ --help ] [--clearTurnOrder] [--[4j]reset --quiet] [ --show ] [ --onlyto --string ] [ --deal2chat ] [--showComps]
(no args) Deals cards to turn order and sorts by suit.
--help : Displays the help.
--clearTurnOrder : Removes all tokens from the Turn Order.  Useful after changing pages in Roll20.
--reset : Reset the deck and shuffle. Use at the start of a new scene or encounter to start 
          the deck fresh.   Add --quiet to minimize chat messages.
--4jreset : Reset the deck with 4 Jokers and shuffle. Use at the start of a new scene or 
          encounter to start the deck fresh.   Add --quiet to minimize chat messages.
--show : Shows the current contents of the deck, discard pile, and turn order (hand)
--onlyto --string : Deal initiative only to token names that contain "string".  
                    Overwrites init if token is on hold. Case sensitive.
--deal2chat : Deal a card into the chat window.  Use this when someone spends a benny 
              to draw a new card
--showComps : flag complications (clubs) in chat for chases and dramatic tasks

I personally use these macros to call the script that look like this:
"New Scene"
!deal-init --4jreset --quiet

"New Round"
!deal-init --showComps

"Deal Only To"
!deal-init --onlyto --?{Enter name to deal to|string}

"Benny a New Card"
!deal-init --deal2chat

"Clear Turn Order"
!deal-init --clearTurnOrder

Debugging API Crashes:

The most common help request I get is for debugging this API Crash error:

      TypeError: Cannot read property 'get' of undefined
          at getInitiativeEdges (apiscript.js:523:66)
          at dealInitiative (apiscript.js:968:10)

This type of problem occurs when the TurnOrder is not "flushed" between sessions or pages. Roll20 does a poor job of managing the Turn Order data structure across pages or sessions. By "Flush" i mean: Open Turn Order => Poke Blue Gear Button => Poke Red "Remove all Turns" button

My workflow, when I use the script is like this:

  1. New Roll20 session or New Page => Clear Turn Order: !deal-init --clearTurnOrder
  2. New Encounter: !deal-init --reset
  3. New Round: !deal-init
  4. Someone Spends a Benny to Draw a New Card: !deal-init --deal2chat (then I just manually move them around in the TurnOrder)
  5. etc.