|Last updated||1 week ago|
|Created||8 months ago|
|Project source||Project URL|
This module has been developped with the following mindset :
This module is currently available in French and in English.
Inside the settings, you will be able to toggle those decks :
For those decks, on click in the settings and all is ready to use !
And then uncheck actions you don't want to have :
The GUI won't change as long as the stack is not registered inside this module decks.
You can still create other decks. The same way you did it before.
Once you're done, you can add the deck to the registered ones :
By doing so, a second stack for the discard will automatically be created. And now you will have access to this module GUI !
If you want to make slight changes (like adding Jokers) from preconfigured decks, presets are available :
The conf panel for choosing them is available by two methods :
If you choose the second method, config panel will directly be set on the click stack.
Each checkbox is linked to a possible action in the main GUI.
Appear when a deck is unfolded. This first paragraph gives you additional information on this deck, and let you decide some general parameters :
Those parameters are for an advanced usage of this module. If you just want to know how to select the available actions for your deck, you can skip those details
Used prefix for labels
Most of the decks only have this parameter.
It indicates RTUC where to search for labels when cards of this deck are played. Labels for deck name, actions or chat messages are constructed with a prefix depending from the deck. (It will try with the given prefix, and fallback to
RTUCards.default. if not found ).
You will have more details on how this works inside README LABELS
Revealed cards put face down
By default, revealed cards are handled the same way the some way has the hand stacks. This options can allow players to reveal cards face down.
When this option is chosen, the revealed cards are directly put face down and the other players don't see anything in chat. (Same behavior as when players draw cards in their hand)
The deck configuration is locked
This parameter only appear when a deck has been registred inside RTUC via hooks. By unlocking it, you will be able to modify what has been defined in the hook.
If you lock it back, it will fallback to the default settings defined in the hook.
With version 1.10.0, the hook signature has slightly changed, and available actions for the deck have to be defined differently. When migrating from a previous version, this parameters will be set to
unlockedso that you won't loose your previously defined actions.
Once you're sure the module/system calling the hook has also been updated, you can lock it back. It will then retrieve the defaultSettings from the hook.
When a deck configuration is locked, you can dwelve into action categories to see which actions have been chosen, but you won't be able to change them.
You will first see actions for deck and discard cards. Those actions are for GMs. (Some of them are also accessible to players if you give them ownership on those stacks.)
For each of these action groups, will you be able to define where this action can be done, and by who :
And depending on which options you took, you will be able to define additionnal properties :
All those properties have default values. Apart from the button text, a next chapter will describe the utility of each one.
When an action group is folded, the square icon will help you see if you took :
Some actions groups have no grid : It just means that there is only on action related to this group.
Player card stacks rules :
Decks and Discard piles rules :
By default, GM can't see a player hand, but there are some cases where it can be useful. Mainly for assisting a player who hasn't understood one of its cards.
With this action, the GM may see other player cards, or even the deck cards.
If the GM choose to do so, players will be warned
This is what he will see by default :
And once he clicks on the
Peek on content button :
It regroups multiple actions, each one making a card go from a stack to another :
Its grid is the most complex one. When you put the mouse cursor on top of one of the grid boxes, it will let you see which action is concerned.
All discard in batch
This will add a button on left side to discard all card of this type. If not set, the discard will need to be done by selecting each card one by one.
This one has mulitple parameters, allowing different play modes :
Playing card mode
Multiple cards paly rangefor more information.
Amount of discarded cardsfor more information
Show played cards in chat
By default, only the card name and description is shown in chat.
By setting it to
1, the card image will also be put in the message.
Multiple cards play range
Only used if the
Playing card mode is set to Multiple cards.
When click on the button for playing a card, you will have access to a second panel, allowing you to select additional cards.
This parameter allows you to define the min and max amount of cards that have to be added.
You have to use one of the following syntaxes :
1. In this case, min and max will have this number value.
$value. In this case, it will try to retrieve this attribute on the card data. This attribute value should be a number or a range
Amount of discarded cards
Only used if the
Playing card mode is set to Card cost.
Works like the
Multiple cards plays range attribute, except that the card will be labelled as discard instead of played.
Show played cards in chat has been set to
1, those card image won't be displayed in chat. Only the first selected card image will be displayed.
For this action, you need to choose two things :
This action can be done as long as the card is visible for you and you own the stack.
You also need to have multiple faces for your card or this action won't be displayed.
Card back is included
By default, the card back is considered as a valid card face, making all cards having at least two faces. You can choose to remove this face from the available faces by setting this parameter to
This one is slightly different from the others : It actually doesn't add any changes to the card. Only the GUI is altered. The card is put upside down.
Mainly useful for cards who can be read from the two ways.
This functionnality is available for decks and discard piles. Only the GMs are allowed to do it.
It can be accessed via the main display :
Why two images?
Be it Actors, Items, or Card stacks, their are represented inside Chat or Right panel via a square. That's not the ideal format for cards. So I'm using two different images:
It will simply toggle the listing display.
When you add the module, two panels will be displayed on your canvas :
This configuration is available for each player.
The configure panel can be opened via the module settings panels, or directly via a right click on the left icon of one of the two panels.
In it, you can:
If you choose to display 0 cards, the panel will instead display the summary of the stack :
The left icon of each shortcut is draggable. Use them to move your shortcuts where you want.
Each action comes with a message sent to the chat log.
Some messages such has the drawing card part are not displayed the same way depending on if you own the stack or not.
What the other player will see :
What the player will see :
And when they clicks on the link :
Once registered, decks and discard piles are set with default permissions to OBSERVER.
You can alter those permissions for each players if you want to change the default behavior :
You don't have access to this panel for player hands and revealed cards. What can be done for there are directly managed by code and you should not alter the default permissions put on these.
By default, permissions are set to OBSERVER to everyone.
If you change it to :
By default, permissions are set to OBSERVER to everyone.
If you change it to :
Warning : If you choose to give OWNER rights to players, they will have access to the actions Put it back in the deck and Shuffle all discard inside deck. Those actions usually shuffle the deck after putting the cards inside it. If the player doing it doesn't have the OWNER rights on the deck, the shuffle step will be ignored and the cards will be put on the top of the deck. (
The first two ones are for the chatlog when GM is doing actions
Smaller window : Each player can choose if he wants the classic card stack display or if he prefers a smaller one. Smaller one may be mandatory if you use a laptop screen which is most of the time smaller.
Cards in hands and
Revealed cards can be toggled to delete players hands or revealed cards. That way, Players will only have one stack to manage. But the related actions won't be available anymore.
Peek on player's hand : Uncheck it if you don't want to be tempted !
There are some more stuff that can be done. Since it can be a little complicated, I've stored those feature description in a separated file : README DEVELOPERS
Here is a summaray of what can be done :
To install this package, open your Foundry Setup screen and navigate to your Module tab and click the Install Module button.
From there, you can either search for the package unique name: ready-to-use-cards or copy its manifest URL:
And paste it to the input box at the bottom of your window.
You can install this package directly to your Forge account.
Necessary cookies are absolutely essential for the website to function properly. This category only includes cookies that ensures basic functionalities and security features of the website. These cookies do not store any personal information.
Functional cookies help to perform certain functionalities like sharing the content of the website on social media platforms, collect feedbacks, and other third-party features.
Analytical cookies are used to understand how visitors interact with the website. These cookies help provide information on metrics the number of visitors, bounce rate, traffic source, etc.
Performance cookies are used to understand and analyze the key performance indexes of the website which helps in delivering a better user experience for the visitors.
Advertisement cookies are used to deliver visitors with customized advertisements based on the pages they visited before and analyze the effectiveness of the ad campaign.