Both sides previous revisionPrevious revisionNext revision | Previous revision |
plugin-core [2024/09/09 22:04] – [Version History] isiahgames | plugin-core [2025/06/13 20:45] (current) – [Passives] isiahgames |
---|
This plugin is required for all other CGC Plugins to work. It can function standalone but the supporting plugins add features that greatly improve the experience of making and playing card games. You can find this plugin as part of the [[https://mythatelier.itch.io/card-game-combat|Main Plugin Suite.]] | This plugin is required for all other CGC Plugins to work. It can function standalone but the supporting plugins add features that greatly improve the experience of making and playing card games. You can find this plugin as part of the [[https://mythatelier.itch.io/card-game-combat|Main Plugin Suite.]] |
| |
**Current Version: 1.6.0** | **Current Version: 1.6.2** |
| |
{{ https://img.itch.zone/aW1hZ2UvMTQyODQ1Ny8xNTQ3ODc3NS5naWY=/347x500/KDUHd7.gif?nolink }} | {{ https://img.itch.zone/aW1hZ2UvMTQyODQ1Ny8xNTQ3ODc3NS5naWY=/347x500/KDUHd7.gif?nolink }} |
{{https://img.itch.zone/aW1nLzE1NDk2OTI4LnBuZw==/original/tRkguc.png?nolink}} | {{https://img.itch.zone/aW1nLzE1NDk2OTI4LnBuZw==/original/tRkguc.png?nolink}} |
| |
See [[card-actions#battle_start_turn_start|Battle Start/Turn Start]]. | These parameters set the Card Actions that actors execute at the start of their turns. See [[card-actions#battle_start_turn_start|Battle Start/Turn Start]] for more information. |
| |
| The Max Hand Size determines how many cards can be in an actor's hand before the game starts ignoring Draw actions. If set to -1, actors will have no max hand size. |
| |
**Card Appearance** | **Card Appearance** |
| |
{{https://img.itch.zone/aW1nLzE1NTAyNDU4LnBuZw==/original/%2BdU33r.png?nolink}} | {{https://img.itch.zone/aW1nLzE4NzkxNzE1LnBuZw==/original/AUw58x.png?nolink}} |
| |
See [[card-overview#card_customization|Card Customization]]. | This section contains various settings that change cards' appearance, including text component locations. See [[card-overview#card_customization|Card Customization]]. |
| |
**UI Order** | **UI Order** |
{{https://img.itch.zone/aW1nLzE1NTAyNDkwLnBuZw==/original/x9q21i.png?nolink}} | {{https://img.itch.zone/aW1nLzE1NTAyNDkwLnBuZw==/original/x9q21i.png?nolink}} |
| |
See [[card-overview|????]]. | This section contains settings for the appearance and functionality of Card Zones and Buttons. See [[zones|Card Zones]]. |
| |
**Change Battle Windows** | **Change Battle Windows** |
{{https://img.itch.zone/aW1nLzE1NTAyNTQ3LnBuZw==/original/1GMt8V.png?nolink}} | {{https://img.itch.zone/aW1nLzE1NTAyNTQ3LnBuZw==/original/1GMt8V.png?nolink}} |
| |
See [[card-overview|????]]. | This section allows you to specify SEs to play when specific Card Actions are used. Most SE settings are found inside specific Zone settings, but General Sounds play regardless of the zone affected. |
| |
**Card Selection Window** | **Card Selection Window** |
{{https://img.itch.zone/aW1nLzE1NTAyODgwLnBuZw==/original/%2FSR6aw.png?nolink}} | {{https://img.itch.zone/aW1nLzE1NTAyODgwLnBuZw==/original/%2FSR6aw.png?nolink}} |
| |
See [[card-overview|????]]. | This section contains settings for the appearance of the Card Selection Window, which is the window that appears when you peek at a Zone's cards or when selecting cards through Card Actions. See [[plugin-card-action-pack-1|Action Pack 1]] for selection Card Actions. |
| |
**Card Library** | **Card Library** |
{{https://img.itch.zone/aW1nLzE1NTAyODg0LnBuZw==/original/U6dHGC.png?nolink}} | {{https://img.itch.zone/aW1nLzE1NTAyODg0LnBuZw==/original/U6dHGC.png?nolink}} |
| |
See [[card-overview|????]]. | This section contains settings for the Card Library scene. See [[card-library|Card Library]]. |
| |
===== Plugin Commands ===== | ===== Plugin Commands ===== |
| |
===== Actions ===== | ===== Actions ===== |
| ^ Card Action Syntax ^ Description ^ |
| <code>Draw X</code> | Where X is a number, playing this card will make the actor draw X cards | | | <code>Draw X</code> | Where X is a number, playing this card will make the actor draw X cards | |
| <code>Draw Until X</code> | Where X is a number, will make the actor draw until their hand is size X | | | <code>Draw Until X</code> | Where X is a number, will make the actor draw until their hand is size X | |
Search For [skill name]</code> | Draws the Card of the specified Skill ID (x) or name, if it is in the deck. | | Search For [skill name]</code> | Draws the Card of the specified Skill ID (x) or name, if it is in the deck. | |
| <code>Shuffle Deck</code> | Will shuffle the deck. | | | <code>Shuffle Deck</code> | Will shuffle the deck. | |
| | <code>Move X from [zoneName] |
| <code>Move X from [zoneName] to [zoneName]</code> | A generic form of Draw/Discard/Mill where you can specify any zone. For example "Move 3 from Discard to Hand" will return 3 cards to the hand. | | to [zoneName]</code> | A generic form of Draw/Discard/Mill where you can specify any zone. For example "Move 3 from Discard to Hand" will return 3 cards to the hand. | |
| <code>Move this to [zoneName]</code> | Will move the card currently being used to the specified zone. If the zone is absent the card will move to the discard at the end of all Card Actions. | | | <code>Move this to [zoneName]</code> | Will move the card currently being used to the specified zone. If the zone is absent the card will move to the discard at the end of all Card Actions. | |
| <code>Move all from [zoneName] to [zoneName]</code> | This will move all cards from one zone to another. | | | <code>Move all from [zoneName] |
| to [zoneName]</code> | This will move all cards from one zone to another. | |
| <code>Eval [expression]</code> | Will execute anything after the word "eval" as a piece of code. | | | <code>Eval [expression]</code> | Will execute anything after the word "eval" as a piece of code. | |
| <code>If [expression]</code> | This will evaluate the expression, and if it's true, it will execute the next Card Action. If false, it will skip that action. | | | <code>If [expression]</code> | This will evaluate the expression, and if it's true, it will execute the next Card Action. If false, it will skip that action. | |
| <code>Jump to [labelName]</code> | This will search for the label with the same name, and move to that label. If the label is after this Card Action, it will skip all Card Actions between the two. If the label is before this Card Action, it will execute the Card Actions between the two a second time. | | | <code>Jump to [labelName]</code> | This will search for the label with the same name, and move to that label. If the label is after this Card Action, it will skip all Card Actions between the two. If the label is before this Card Action, it will execute the Card Actions between the two a second time. | |
| <code>Wait X</code> | Causes Card Action execution to wait X frames before continuing, like a Wait command in RPG Maker. Does not work in Start of Turn/Battle params. | | | <code>Wait X</code> | Causes Card Action execution to wait X frames before continuing, like a Wait command in RPG Maker. Does not work in Start of Turn/Battle params. | |
| | <code>Play SE [fileName] |
| Play SFX [fileName]</code> | Will play the specified sound file located in audio/se folder. | |
| | <code>Force Action X</code> | Forces the user (in Card Actions) or the target (in Card Target Actions) to execute skill X. | |
| |
Example of how these Card Actions can be used: | Example of how these Card Actions can be used: |
</code> | </code> |
These card actions will draw 1 card, wait 5 frames, and then repeat until the player has 10 cards in their hand. | These card actions will draw 1 card, wait 5 frames, and then repeat until the player has 10 cards in their hand. |
| |
| |
| <code>Play SE [fileName] | |
Play SFX [fileName]</code> | Will play the specified sound file located in audio/se folder. | | |
| |
===== Passives ===== | ===== Passives ===== |
| ^ Card Passive Syntax ^ Description ^ |
| | <code>Will End Turn</code> | This will cause the card to end the turn upon use. | |
| <code>Discard if unplayed</code> | Will discard this card if the turn ends while this card is in the hand. | | | <code>Discard if unplayed</code> | Will discard this card if the turn ends while this card is in the hand. | |
| <code>Remove if unplayed</code> | Will remove this card from play if the turn ends while this card is in the hand. | | | <code>Remove if unplayed</code> | Will remove this card from play if the turn ends while this card is in the hand. | |
| |
| <code>Require [expression]</code> | Cannot be played unless the expression evaluates to true. Multiple requirements can be placed. Use the word 'user' to refer to the user of the card.\\ \\ <code>Require user.handSize > 2 | | <code>Require [expression]</code> | Cannot be played unless the expression evaluates to true. Multiple requirements can be placed. Use the word 'user' to refer to the user of the card.\\ \\ <code>Require user.handSize > 2 |
Require user.handSize < 10 | Require user.handSize < 10 |
Require $gameSwitches.value(3)</code>This will make a card playable only if the user's hand contains more than 2 and less than 10 cards. In addition, can only be played if Game Switch 3 is set to ON. | | Require $gameSwitches.value(3)</code>This will make a card playable only if the user's hand contains more than 2 and less than 10 cards. In addition, can only be played if Game Switch 3 is set to ON. | |
| |
| <code>Start in [zoneName]</code> | Will be in the specified zone at start of battle, before start-of-battle actions. | | | <code>Start in [zoneName]</code> | Will be in the specified zone at start of battle, before start-of-battle actions. | |
| <code>Start of Turn: Skill X</code> | At the Start of Turn, if this Card is in Hand, execute Skill ID X. | | | <code>Start of Turn: Skill X</code> | At the Start of Turn, if this Card is in Hand, execute Skill ID X. | |
| |
<code> | <code> |
| **v1.6.3** |
| - Added Window Word Wrap parameter. |
| - Added End Turn/Discard/Remove description parameters instead of using the End Turn Button Skill's description for all 3. |
| - Fixed crash if MV users are using the old ShowCard plugin. |
| - Fixed default bitmap loading properly in MZ if Default.png is not present in project. |
| - Cards now appear properly in the Deck on battle start if the Deck's "Show cards?" parameter isn't set to "No." |
| - Cards now properly shuffle while their zones' "Show Cards?" parameter isn't set to "No." |
| - Added image culling along the edges of Library windows, should be a huge visual improvement for MZ in particular. |
| - Fixed Deck zone not using the Skew property. |
| - Fixed typo in MZ plugin command |
| - Fixed crash if using YEP_SkillCore but not YEP_MessageCore Help Window now always displays proper ICV values regardless of scene. |
| - Fixed bug where actors will execute their start-of-battle Card Actions twice if the actor before them is dead or cannot move. |
| - The Action Failure message in the Battle Log no longer displays when using a skill that has Card Actions. |
| - Setting Origin Badges to false now prevents cards being separated by their Origin in Library type scenes. |
| - Added "None" option to Card Removal Animation. |
| - Added several Card Library parameters that were previously in Card Library Plus. |
| - Fixed bug where the If Action wouldn't work inside Empty Zone Actions. |
| - Fixed bug with Card Target Actions that would cause two actors to swap hands in MZ. This bug would also cause the used card to go to the wrong discard in MV. Same cause, different outcomes! |
| - Fixed MZ bug where "Move this to Hand" wouldn't allow you to use the card twice in a row. |
| - Fixed bug where extra zones wouldn't update what cards were visible when it was a different actor's turn. |
| - Changing classes now replaces learned cards from the previous class with cards belonging to the new class. |
| - Added compatbility with YEP_ClassChangeCore. |
| - Fixed MZ touch input bug that would strangely let you hover over and click cards/buttons/zones when your mouse was at the top of the screen in battle. |
| - Fixed similar bug for the Library scenes. |
| - Added Scale parameters to the Hand Zone. |
| - Added Move Card to Target parameter to the Hand Zone. |
| - Temp Fix for forced actions that end the turn not properly ending it. The code is bad and will be improved in the future. |
| - Forced actions are now either better or worse. |
| - New warning system comes with error codes so that warnings can be translated into multiple languages. |
| |
| |
**v1.6.2** | **v1.6.2** |
- Consolidated ShowCard into the Core Engine. | - Consolidated ShowCard into the Core Engine. |