Character List - For Rpg Maker MZ

GENERAL

"Character List" is a plugin for RPG MAKER MZ highly inpired to the one you can see in the game "World End Syndrome". 

FEATURES

• Character List inspired to World End Syndrome with customizable data entries;
• Easy customizable graphics placed inside the img/pictures/ folder in a custom sub-directory called CharacterList.
• Character data is entered inside plugin parameters and It can be edited further in game;
• Character List could be added directly in menu by plugin parameters. The plugin is compatible with VisuMZ_1_MainMenuCore.js, you can find more information about compatibility below.
• Character descriptions could be easily edited and the use of escape codes is allowed.

GRAPHICAL ASSETS:

This plugin uses some custom graphics that are inside a folder named CharacterList the graphics created for showcasing the plugin si free to be downloaded from this project page.

The mentioned folder should be placed inside the img/pictures/ folder of your game.

Image file names are case sensitive. Let's take a look at them.

The use of the single images is pretty self-explanatory if you look the showcase images. The only important note I feel to do it's related to the containeratlas and containermask. Those sheets are used for drawing an entry inside the Character List scene, in particular containeratlas will determine the background and the cursor of an entry; on the other hand, containermask is used for encapsulating properly the character faceset in the entry. 

Furthermore, the drawing of the containeratlas.png is affected from one of the plugin parameter we're going to illustrate below (character list item size). Finally, inside the container atlas the plugin draw the well-know actor faceset that could be default or zoomed by plugin parameters (look at Character Face Zoom below).

PLUGIN PARAMETERS: 

The main functionalities offered by this plugin are determined by the customization options offered by the plugin parameters.

Unknown Entry -> This is a string parsed when a character entry is not unlocked.

Character List Item Size -> This is the parameter determining the frame of the  the item width/height of the character list window where the container atlas is drawn.  My suggestion is always to make those values a little higher than the actual containeratlas frame size.

Character Face Zoom -> This parameter determines if the actor faceset set should be scaled or not. If TRUE, the actor face is scaled around x1.2 for fitting your containeratlas properly.

Entries per row -> The number of entries in a single row.

Total Elements Format -> This is the format string used for showing the number of unlocked entries and their total in the footer window.

Command Hints Text -> This is the text shown always in the footer rendering a string with command hint. Despite being named this way, you can write whatever you want.

Character List Menu Name and Show In Menu -> Those parameters affects the Character List command being shown or not and the name in the game Scene_Menu. The parameters works differently if VisuMZ_1_MainMenuCore is enabled. Look at Plugin Compatibility section for more information.

List -> This is a structure containing all the character entries that will appear in the character list scene. Let's make a deep examination about those structure.

Some of those  parameters could be changed/updated in-game by using the plugin command we're going to explain below.
Short Name -> The short name of the entry; shown in the character selection;

Complete Name -> The complete name of the entry show in the information window;

Default Faceset -> The default faceset shown for the entry;

Default Face Index -> The default face index related to the chosen faceset;

Description -> This array contains the descriptions that could be shown inside the information window. This way, you can write more than one description that could be update as your game narrative goes on. Every description is independent from each other, meaning that they will not be merged when you increase/decrease the description index.

Default Description Index -> This is the default description index; this parameter determines the first description that will be taken from the Description array from above. The index starts from 1.

Unlocked? -> This parameter determines the condition that needs to be satisfied to make visible an entry. There are several options:

unlocked -> The entry is unlocked from the start;

switch:value (ex. switch:3) -> The entry is unlocked if the used switch is set to TRUE;

eval:script -> For the bravest one, they could use their JS knowledge to write a custom condition (ex. eval:$gameVariables.value(35) % 4 === 0)

manual -> The entry could be unlocked only forcing its unlock through a plugin command explained below. WARNING! Despite using this unlocking method or not, if you use the plugin command for unlocking forcefully an entry, it will overwrite the other eventual unlocking method you may set.

PLUGIN COMMANDS: 

The plugin is provided by two plugin commands.

Unlock Character Entry is a plugin command that allows to manually unlock a character entry inside the character list. As mentioned above, the manual unlock overwrite the other unlocking methods. 

Entry Id represents the ID of the entry in the character list starting from 0.

However, you can both set the entry to true or false. If you set the manual unlock to false, the other unlocking methods will start to work again.

Edit Character List Entry allows to edit some data types related to a character entry in the list. The available data that could be changed dynamically could be seen from the image above. Those edits are obviously stored in savefile.

However, the edits you do on the default values in the plugin parameters for each key will still be detected (but if you have set a custom one using this parameter it will be read the one you set).

You can restore the default value writing the word "default" inside the "Value" spot.

PLUGIN COMPATIBILITY:

This plugin should be compatible with VisuStella's core's plugins and It should not give problems with other plugins if they do not affect intensively default RPG MAKER MZ library.

About VisuMZ_1_MainMenuCore.js: 

If this plugin is available inside your plugin manager the "Show In Menu?" parameters will not add automatically the "Bestiary" command in menu. Otherwise, you can add it through the parameters of the MainMenuCore. Here you are some default settings you can use.

Settings for Command Window List plugin parameter:

{"Symbol:str":"_character_list","Icon:num":"50","TextStr:str":"Character List","TextJS:func":"\"\"","ShowJS:func":"\"return !!$gameSystem._showCharacterList\"","EnableJS:func":"\"return true\"","ExtJS:func":"\"return null;\"","CallHandlerJS:func":"\"SceneManager.push(Scene_CharacterList)\"","PersonalHandlerJS:func":"\"\""}

However, you can edit those settings the way you want if you have the knowledge for doing so. For example, the "$gameSystem._showCharacterList" could be used for determining if the command is enabled instead of determining the command visibility in menu if you need to do something different.

RPG MAKER VERSION:

The plugin is developed on Rpg Maker MZ - Version 1.4.0 and with the related PIXI.js Version 5.2.4. 

This plugin is NOT compatible with RPG MAKER MV.

TERMS OF USE:

• Credits to BlueMoon.
• Avoid to change plugin information, filename and parameters name for the sake of integrity of the code.
• Edits to the code are allowed.
• The plugin can be used for both commercial and non-commercial projects.
• You can't redistribute this plugin as it is or incorporating portion of the code inside another plugin;