Back to documentation

Automations

Automation Buttons are used to do repetitive actions at the press of a button. Deal cards, reset the board, and much more.

Adding Automations

To add an automation button, first switch to Edit Mode, then click "Automation Button" in the bottom toolbox to add a button to the game.

The Turn Button can also be configured to run an automation when clicked, available in the Automation tab when editing the Turn Button.

Customizing Automations

To edit an automation, first enter Edit Mode, then click an Automation Button and select Edit. From the edit popup you can change the automation steps. When the button is clicked during a game, the automation will go through the steps and run each in order one-by-one.

To add a step, scroll to the bottom and click one of the rectangle buttons. Once a step is added you can change the settings to configure the detailed behavior, depending on the type of the automation step.

Note: A Move Cards and Pieces step will be added by default when a button is created.

To reorder steps, drag the circle number icon and drop in the desired position.

To delete a step, press the trash can icon.

Tips:

Above the first step you'll see a Popup option. Turning this on will prompt the person clicking the button to confirm if they really want to run the automation. This is great for preventing accidental clicks of the button.

In the popup, you can also add Questions that will appear in the popup. Then, further down in the automation you can use the values entered by the player. This allows you to do things such as changing how many cards are dealt each time the button is pressed.

Automations

Move Cards & Pieces

Moves cards and pieces between card holders and/or player hands. To move to/from the player hand area, choose Player Seat widgets in the To/From Holders. Note that not all games have Player Seats but they can be added from the bottom menu in Edit Mode.

From Holders / To Holders

Click the button to enter selection mode, from selection mode click on holders or Player Seats to choose where cards/piece are moved from/to.

Number of Objects To Each

How many cards/pieces to move to each To Holder.

To deal entire card pile out, set the number to anything larger than the number of objects e.g. 1000.

Add or Fill-To

Add mode will add cards to chosen holders each time the automation is run.

Fill-to mode will stop adding cards when each holder contains the number of cards/pieces specified in the Number of Objects To Each setting.

Move Order

Determines the order the cards are dealt to multiple holders.

Deal one-by-one will go through the To Holders giving each one card, then repeat. Dealing 9 ordered number cards to 3 holders would result with: 147 258 369

Move as pile will go through the To Holders giving each holder all the necessary cards at once. Dealing 9 ordered number cards to 3 holders would result with: 123 456 789

Flip Cards

Determines if moved cards should be flipped face-up, face-down, or kept as-is.

Rotation

Determines if moved cards should be rotated. The Fit to holder will rotate based on the card and holder orientation, e.g. for an upright holder a 180 degree rotated card will not be changed as it fits into the holder, but a 45 degree card will be rotated upright.

Recall Cards & Pieces

Recall cards and pieces back to their deck/collection location. This can include cards/pieces that aren't in any holders and can be used to easily pull all cards/pieces from anywhere in the game.

Decks

Click the button to enter selection mode, from selection mode click on deck/collection widgets to choose which to recall cards/pieces to.

Include Objects in Holders

When set to Normal cards/pieces in holders will be ignored. When set to Include Holders cards/pieces in holders will be recalled back to the deck position.

Include Objects in Hands

When set to Normal cards/pieces in the bottom hand area will be ignored. When set to Include Hands cards/pieces in the hand area will be recalled back to the deck position.

Flip Cards

Determines if recalled cards should be flipped face-up, face-down, or kept as-is.

Flip Cards

Flip cards face up or face down.

Card Holders

Click the button to enter selection mode, from selection mode click on holders to choose the holders in which cards/pieces are flipped.

Flip Cards

Determines how to flip the relevant cards.

Face up will flip all cards to face-up.

Face down will flip all cards to face-down.

Switch will flip each individual card to the opposite side.

Switch (all to same side) will flip the top card to the opposite side, and all other cards to the same side.

Randomize will randomize which face is up, for games where both sides have values.

How Many To Flip

When set to Top Card Only, only the top cards of specified holders will be flipped, Otherwise the entire pile/piles will be flipped.

Shuffle Objects

Shuffles the order of cards and pieces in specified holders.

Holders

Click the button to enter selection mode, from selection mode click on holders or Player Seats to choose holders in which cards/pieces will be shuffled.

Sort Objects

Sorts cards/pieces in the specified holders. Objects will be sorted to the same order they're specified in the card deck widget.

Holders

Click the button to enter selection mode, from selection mode click on holders or Player Seats to choose where to sort cards/pieces.

Direction

Sort ascending or descending.

Change Counter

Modify the number shown in counter widgets.

Counters

Click the button to enter selection mode, from selection mode click on counters to choose which counters are affected.

Mode

How to use the Number: increase/decrease by number specified, or change the counter to the number specified.

Number

When Mode is set to increase/decrease, counters will add or subtract them by the specified number. When Mode is Set to, counters will be changed to the number specified.

Roll Dice

Rolls selected dice to select a new face randomly.

Spin Spinner(s)

Spins selected spinners to select a new number randomly.

Start/Pause Timer

Starts, pauses, or toggles the running state of selected timers.

Change Timer

Reset Timer will change timer back to 0 and pause any running time. Add Time will add Seconds specified. Subtract Time will subtract Seconds specified. Jump to Time will jump directly to Seconds specified.

Change Chooser

Choosers

Click the button to enter selection mode, from selection mode click on choosers that will be affected. Note: all selected choosers must be in the same collection, to change more than one chooser collection in a single automation you can add multiple Change Chooser steps.

Change

How to modify the Choosers.

Cycle Previous/Next will rotate the current option in order, looping around the start or end.

Change To will show another option to select an option to set all choosers to.

Stand Up Players

Removes players from specified Player Seats. Great for clearing the room at the end of the night.

Finish Turn

Equivalent to clicking the Turn Button. Note: room must contain a Turn Button.

Confused? Drop us a message at rob@playingcards.io We appreciate all feedback.