Card Game Deck Builder (Irina)
- 1 System
- 2 Download
- 3 Atelier Irina
- 4 RPG Maker Version
- 6 Required Plugins
- 7 Extension Plugins
- 8 Introduction
- 9 Instructions
- 10 Plugin Parameters
- 10.1 Deck Rulesets
- 10.1.1 Deck Rulesets: Name
- 10.1.2 Deck Rulesets: Unlock Switch
- 10.1.3 Deck Rulesets: Description
- 10.1.4 Deck Rulesets: Ruleset Image
- 10.1.5 Deck Rulesets: Minimum Deck Size
- 10.1.6 Deck Rulesets: Maximum Deck Size
- 10.1.7 Deck Rulesets: Max Copies of Cards
- 10.1.8 Deck Rulesets: JS: Filter Rules
- 10.1.9 Deck Rulesets: JS: Restriction Rules
- 10.2 Main Menu Settings
- 10.3 Deck Builder Scene
- 10.4 Select Ruleset
- 10.5 Deck Command Window
- 10.6 Deck Building Windows
- 10.1 Deck Rulesets
- 11 Notetags
- 12 Script Calls
- 13 Main Menu Manager Integration
This is a plugin created for RPG Maker MV.
For help on how to install plugins, click here.
For help on how to update plugins, click here.
Got errors with your RPG Maker MV plugin? Click here.
This is a plugin created by Atelier Irina.
You can also follow Atelier Irina on itch.io.
Support e-mail: rpgmakerplugins+Irina@gmail.com
RPG Maker Version
This plugin is made for and tested on RPG Maker MV with version 1.6.2. I cannot guarantee if it works on lower versions. Some of the plugin parameters require the later updates of RPG Maker MV for you to be able to use their entries so please update RPG Maker MV to the latest version if you want the best experience in using this plugin.
You are only allowed to use the plugins made by Atelier Irina if you agree to all of the following:
- These plugins may be used in free or commercial games.
- 'RPG Maker Irina' must be given credit in your games.
- You are allowed to edit the code.
- Do NOT change the filename, parameters, and information of the plugin.
- You are NOT allowed to redistribute these Plugins.
- You may NOT take code for your own released Plugins.
The following plugins are required in order to use this plugin.
Place the following plugins above this plugin located in the Plugin Manager.
Place the following plugins below this plugin located in the Plugin Manager if you plan on using them.
This file is the second of three files to be included in the collectible card game set of plugins and it primarily focuses on the deck building aspect of the plugin set. In any kind of game that offers a CCG to play with, it must have a strong deck builder and this plugin adds that scene to your game. It can be accessible through the main menu or through script call.
What comes with this deck builder is the ability to make decks based on different rulesets, letting the player make their own decks, naming them, choosing deck boxes, deck sleeves, changing up the order of decks, filtering certain cards while deck building, sorting them, and more.
As this is the second piece, it will require the first plugin to be installed and located above this file in the Plugin Manager list inside your game project.
While the Deck Builder add-on is mostly plug and play, please go through the Plugin Parameters and make sure that the settings for the game are to your liking. Otherwise, do not be surprised that things will look weird in your game if you do not adjust them properly according to your game.
It is recommended that you download the assets pack to get started with the projet. Everything should go into their respective folders structured in the assets pack archive file.
There are Plugin Parameters that you may configure for this plugin.
There are a lot of plugin parameters. You must set these up properly if you wish to make this project work. Here's what each plugin parameter do.
This is a list of the various deck rulesets that can be used by the card game. A deck ruleset determines the minimum deck size, maximum deck size, maximum copies of a card that a deck can have, and more.
Deck Rulesets: Name
This is the name of the deck ruleset. Make sure that the ruleset name is different from other ruleset names if you want to avoid confusion. It will be used in a variety of places such as help descriptions.
Deck Rulesets: Unlock Switch
The ruleset may or may not be available from the start of the game. If it requires a switch, then the switch must be on before the player is able to build decks using that ruleset. Otherwise, it is available automatically.
Deck Rulesets: Description
This is the help description that accompanies this ruleset while the player is selecting a ruleset before going to edit their decks. Provide a proper description of what the ruleset entails.
Deck Rulesets: Ruleset Image
When the player is picking a ruleset, this is the image used with the ruleset. The images are located in the game project's img/pictures/ folder.
Deck Rulesets: Minimum Deck Size
This is the minimum number of cards that need to be inside a deck going by this ruleset. While the player can prematurely save a deck that has not met the minimum deck size, that deck will not be considered valid for play by the game.
Deck Rulesets: Maximum Deck Size
This is the maximum number of cards that can be placed inside a deck. Deck sizes can go up to this number but not beyond it. If this number is set to 0, then there is no maximum deck size and the player can add all the cards they want to the deck.
Deck Rulesets: Max Copies of Cards
This is the maximum number of copies of a single card that can be added to the deck and extra copies of said cards cannot go beyond it. If this number is set to 0, then there is no maximum and the player can add any number of copies they want.
Deck Rulesets: JS: Filter Rules
Deck Rulesets: JS: Restriction Rules
Main Menu Settings
These settings determine if the Deck Builder option will show up in the main menu and how it will appear text-wise. If you are using Yanfly's Main Menu Manager plugin, there is a section later in the help file to tell you how to integrate it into the menu. These settings can also be changed by script calls in-game.
WARNING: If the player does not have a single card in their inventory, the Deck Builder option will -NOT- appear regardless of what your plugin parameters have it set to.
Deck Builder Scene
These control the basic UI and visual aspects of the deck builder scene.
Deck Builder Scene: Icons
These are the icons used for marking a card/deck's level, power, and/or health (if your game opts to show health).
Deck Builder Scene: Parallax Background Image
If you wish to use a parallax background image for the scene, change the settings here to your liking. You can even set the scrolling speeds for the parallax image.
Deck Builder Scene: Transparent Windows
The windows (save for a few) can be made transparent in the scene. If you want them to appear transparent, they will not obscure the background. Otherwise, the game's window skin will show on them.
These plugin parameter options here let you decide how to make the ruleset selection process look like. You can determine the text displayed, the number of columns of cards to use, and more.
WARNING: If there is only one ruleset available for the player, then this part of the Deck Builder scene will be skipped.
After selecting a ruleset (or if there is none), players will reach this step where they have to select a deck to edit or create a new one. In the deck selection screen, it will list all the decks available to the player, a preview window that displays deck boxes/cards, a ratio window, and a contents window that displays the cards inside of a deck.
Select Deck: Preview Window
Select Deck: Deck List Window
Select Deck: Ratio Window
Select Deck: Contents Window
Deck Command Window
If the player does not pick Create New Deck and instead, picks a deck on the list, the command window pops up giving the player options on what they want to do with the deck. The plugin parameters let you change their command name and help description. Some other commands have specific traits that can also be altered.
Deck Command Window: Edit Deck
Puts the player into Deck Editing mode. More on that in a later section of the help file.
Deck Command Window: Rename Deck
Lets the player rename the deck. This works with Yanfly's Key Name Entry if you want keyboard typing access for naming stuff. You can download it from here: Key Name Entry
Deck Command Window: Favorite/Unfavorite
Lets the player favorite/unfavorite their decks. Favorited decks will have a different icon than normal ones.
Deck Command Window: Change Box
Allows the player to swap out the deck box used for the currently selected deck. The plugin parameters let you decide which ones are available by default. Players can unlock more deck boxes through items with specific notetags in them (explained later in the helpfile).
Deck Command Window: Change Sleeves
Allows the player to swap out the deck sleeves used for the currently selected deck. This does not show up anywhere except during the card game. There are no default sleeves and they will be "empty" using the default card back set up in the Card Game Core plugin parameters. Players can unlock deck sleeves through items with specific notetags in them (explained later in the helpfile). If there are no unlocked deck sleeves, this option will not appear in the command window.
Deck Command Window: Order
What happens if players don't like the order of the deck list? They can reorder them with this command.
Deck Command Window: Delete Deck
And if a player decides it's time to sack a deck, this command will delete the deck from the list.
Deck Building Windows
Upon selecting Create New Deck or Edit Deck, the player is taken to these windows where the player can filter cards, sort cards, add and remove them from the currently selected deck.
Deck Building Windows: Filter/Sort Window
Deck Building Windows: Inventory Window
RPG Maker MV's editor is unable to allow for custom traits/properties that a game dev may wish to associate with a database object, event, map, etc. Notetags are used to work around such limitations by allowing the game dev to tag certain traits/properties using specific Notetags declared by the related plugin.
Here is a list of Notetag(s) that you may use.
<Deck Box: filename> - Replace 'filename' with the filename of a graphic from img/pictures/ to unlock this deck box image for the player if this item is in their inventory. This is case sensitive.
<Deck Sleeves: filename> - Replace 'filename' with the filename of a graphic from img/pictures/ to unlock this deck sleeves image for the player if this item is in their inventory. This is case sensitive.
Here is a list of Script Call(s) that you may use:
$hideCardGameDeckBuilder(); $showCardGameDeckBuilder(); - Use these script calls to hide/show the Deck Builder command in the main menu screen respectively.
$disableCardGameDeckBuilder(); $enableCardGameDeckBuilder(); - Use these script calls to disable/enable the Deck Builder command in the main menu screen respectively.
$openCardGameDeckBuilder(); - Use this script call to open up the Deck Builder scene unless the player is currently in battle.
To integrate access to a scene from this plugin into Yanfly's Main Menu Manager, use the settings below:
Name: 'Deck Builder' Symbol: cardGameDeckBuilder Show: $gameSystem.isCardGameDeckBuilderVisible() Enabled: $gameSystem.isCardGameDeckBuilderEnabled() Ext: Main Bind: this.commandCardGameDeckBuilder.bind(this) Actor Bind:
Insert the above setup within a Main Menu Manager slot. Provided you copy the exact settings to where you need it, it will appear there while using all of the naming, enabling, disabling, hiding, and showing effects done by the plugin parameters.