CG Gallery VisuStella MZ

Welcome to the wiki! This is where you can find resources from Yanfly.moe, Ækashics.moe,
VisuStella, Caz Wolf, Fallen Angel Olivia, Atelier Irina, and other affiliated content creators.

Download
System This is a plugin created for RPG Maker MZ.
Click here for help on how to install plugins and an explanation on the Tier Hierarchy System.	Click here to learn how to update plugins.	Click here for how to troubleshoot plugins if you get an error.

VisuStella MZ This plugin is a part of the VisuStella MZ Plugin Library. Click here if you want to help support VisuStella on Patreon. Introduction Does your game have a lot of pretty art? Especially pretty art that your players would love to view again on their own? This plugin provides a new scene called a CG Gallery for players to view art that they have encountered on their game playthroughs. The CG Gallery allows you to separate art into various categories where the player can view them individually, zooming in and out and moving all about for that perfect angle. Features include all (but not limited to) the following: Automatically unlock art listings for the CG Gallery through Show Picture event commands or unlock them manually through Plugin Commands. The Plugin Parameters allow you the ability to add categories, listings, and adjust various aspects of the CG Gallery. When art listings are unlocked, they will be visible across all saves and can be accessible through the title scene even. Art listings can be paired with text descriptions to explain what the art piece is all about and/or even provide credit to the artist that drew it. Art listings can have variants so that you can bundle up similar art pieces together without cluttering the entire CG Gallery. When viewing art listings, extra features are added to allow players to zoom in, zoom out, toggle the borders, move the picture about, and change between art variations. Completion Rates and Variant Counts are displayed in-game to let the player know about the progress made in completing the CG Gallery. Some art listings can be automatically unlocked by default as a form of bonus art, similar to what you see in many commercial Visual Novels. Requirements This plugin is made for RPG Maker MZ. This will not work in other iterations of RPG Maker. Tier 4 This plugin is a Tier 4 plugin. Place it under other plugins of lower tier value on your Plugin Manager list (ie: 0, 1, 2, 3, 4, 5). This is to ensure that your plugins will have the best compatibility with the rest of the VisuStella MZ Plugin library. Major Changes This plugin adds some new hard-coded features to RPG Maker MZ's functions. The following is a list of them. --- CG Gallery Storage The CG Gallery unlock progress is stored in the configuration file. This is primarily done so that the progress is readily accessible across all saves and can be updated across all saves. --- Plugin Commands Plugin Commands are event commands that are used to call upon functions added by a plugin that aren't inherently a part of RPG Maker MZ. Here is a list of Plugin Command(s) that you may use: --- The following are Plugin Commands that come with this plugin. They can be accessed through the Plugin Command event command. --- CG Plugin Commands --- CG: Unlock Image(s) - Unlocks specific image(s) for the CG Gallery. Filename(s): - List of filenames for CG's that will become unlocked. Argument: - Description Argument: - Description Argument: - Description Argument: - Description --- CG: Unlock All Images (Debug) - Unlocks all image(s) for the CG Gallery. - Only for playtesting. Resets upon game closing. --- CG: Unlock All Images (Permanent) - Unlocks all image(s) for the CG Gallery. - This is a permanent unlock. --- CG: Reset All Unlocks (Permanent) - Reset all unlocks for the CG Gallery. - This is a permanent reset. Use SPARRINGLY! --- Scene Plugin Commands --- Scene: Open CG Gallery - Opens CG Gallery. - CANNOT be used inside of battle. --- System Plugin Commands --- System: Enable CG Gallery in Menu? - Enables/disables CG Gallery menu inside the main menu. Enable/Disable?: - Enables/disables CG Gallery menu inside the main menu. --- System: Show CG Gallery in Menu? - Shows/hides CG Gallery menu inside the main menu. Show/Hide?: - Shows/hides CG Gallery menu inside the main menu. --- Plugin Parameters Image Categories List of categories that are used for this plugin. The order these categories appear in the settings will be the order they're displayed in the gallery. --- Settings ID Key: - This category's identification key. - Categories require unique keys for the plugin to differentiate them. Text: - This category's command text. Icon: - Icon used for this category. - Use 0 for no icon. Help Description: - A description of the CG Gallery listing. - Text codes allowed. --- Image Listing Settings A listing of all the pictures found in the CG Gallery. The order these images appear in the settings will be the order they're displayed in the CG Gallery. --- Settings Filename: - Filename used for the CG Gallery listing. - This will be used as the CG Gallery thumbnail, too. Variations: - Variations of the CG Gallery listing. Category: - The category this image is listed under. - If unlisted, the image will be listed under "Unlisted". Help Description: - A description of the CG Gallery listing. - Text codes allowed. --- Default Unlocks Settings List of filenames for CG's that are already unlocked and viewable. --- Settings Filename: - Filename used for the default unlocked art listing. - Make sure the art listing is found inside Image Listings. --- System Settings System settings for CG Gallery. --- Auto-Unlocks Show Picture?: - Auto-unlock listings for the CG Gallery when using "Show Picture" event commands? Variations?: - Auto-unlock variations for listings for the CG Gallery? --- Scene_CG_Gallery Move Distance: - How many pixels should pictures move per frame? --- Main Menu Settings Main Menu settings for CG Gallery. --- Main Menu Settings Command Name: - Name of the 'CG Gallery' option in the Main Menu. Show in Main Menu?: - Add the 'CG Gallery' option to the Main Menu by default? Enable in Main Menu?: - Enable the 'CG Gallery' option to the Main Menu by default? --- Background Settings Background settings for Scene_CG_Gallery. --- Background Settings Snapshop Opacity: - Snapshot opacity for the scene. Background 1: - Filename used for the bottom background image. - Leave empty if you don't wish to use one. Background 2: - Filename used for the upper background image. - Leave empty if you don't wish to use one. --- Sound Settings Sound settings for the CG Gallery. --- Select Image Filename: - Filename of the sound effect played. Volume: - Volume of the sound effect played. Pitch: - Pitch of the sound effect played. Pan: - Pan of the sound effect played. --- Change Variation Filename: - Filename of the sound effect played. Volume: - Volume of the sound effect played. Pitch: - Pitch of the sound effect played. Pan: - Pan of the sound effect played. --- Vocabulary Settings These settings let you adjust the text displayed for this plugin. --- Special Categories "All" Command: "Unlisted" Command: - Text used for the special Categories. --- Help Descriptions "All" Category: "Unlisted" Category: - A description used for the special Categories. - Text codes allowed. Not Unlocked Image: - A description used for yet to be unlocked images. - Text codes allowed. --- Gallery Window > Variations Complete Text: - Text displayed for listings with complete unlocks. - Leave empty to not use. Text Format: - Text format for listings with variations left. - %1 - Percent, %2 - Unlocked, %3 - Total --- Gallery Window > Completion Vocabulary: - Main vocabulary used for this text. Text Format: - Text format used for completion percentage. - %1 - Percent, %2 - Unlocked, %3 - Total --- Gallery Window > Progress Vocabulary: - Main vocabulary used for this text. Text Format: - Text format used for progress unlocked. - %1 - Percent, %2 - Unlocked, %3 - Total --- Button Assist Window Border: - Text used for toggling border and borderless. - Requires VisuMZ_0_CoreEngine! Gallery: - Text used for returning back to the gallery. - Requires VisuMZ_0_CoreEngine! Next Variation: - Text used for going to next variation. - Requires VisuMZ_0_CoreEngine! Previous Variation: - Text used for going to previous variation. - Requires VisuMZ_0_CoreEngine! Reset Zoom/Position: - Text used for resetting the zoom and position. - Requires VisuMZ_0_CoreEngine! Zoom Change: - Text used for changing the zoom scale. - Requires VisuMZ_0_CoreEngine! --- Window Settings Settings for all the windows inside the CG Gallery scene. --- Window_Help Background Type: - Select background type for this window. JS: X, Y, W, H: - Code used to determine the dimensions for this window. --- Window_CG_Category Background Type: - Select background type for this window. Special Categories: Add All Command?: - Add the "All" command for the CG Gallery Category window. "All" Icon: - Icon used for the "All" Category. Show Unlisted?: - Show the "Unlisted" command for the CG Gallery Category window if applicable. "Unlisted" Icon: - Icon used for the "Unlisted" Category. Style: - How do you wish to draw commands for this window? - Text Only - Icon Only - Icon + Text - Automatic Text Align: - Text alignment for this window? JS: X, Y, W, H: - Code used to determine the dimensions for this window. --- Window_CG_Gallery Background Type: - Select background type for this window. Custom Locked Image: - Custom picture graphic used for entries that have yet to be unlocked. Image Buffer: - How many pixels of buffer range should there be for selected images? Listing Background?: - Show the dark background for listings? Max Columns: - Max columns used for this window. Spacing: - Column spacing for this window. Max Rows: - Max rows used for this window. Spacing: - Row spacing for this window. Stagger: - How many pixels should the gallery entries stagger by? - This is the diagonal listing effect. Towards Left?: - Which direction should the stagger be going towards? Text: Variations: Show?: - Show variations on the gallery thumbnail? Display Singles?: - Show text on listings with no variations? Horz Text Align: Vert Text Align: - Horizontal/vertical alignment for this text? Completion: Show?: - Show this text? Decimal Places: - How many decimal places should the percentage value go to? Font Name: - What is the font family name (NOT filename) of the font? - Look up the name via Windows Font Preview. Font Size: Vocab: - What is the font size of the main vocabulary? Font Size: Value: - What is the font size of the main value? Offset: Angle: - What angle should this text be shown at? Offset X: - How many pixels to offset the x position? - Negative: left. Positive: right. Offset Y: - How many pixels to offset the y position? - Negative: up. Positive: down. Progress: Show?: - Show this text? Decimal Places: - How many decimal places should the percentage value go to? Font Name: - What is the font family name (NOT filename) of the font? - Look up the name via Windows Font Preview. Font Size: Vocab: - What is the font size of the main vocabulary? Font Size: Value: - What is the font size of the main value? Offset: Angle: - What angle should this text be shown at? Offset X: - How many pixels to offset the x position? - Negative: left. Positive: right. Offset Y: - How many pixels to offset the y position? - Negative: up. Positive: down. JS: X, Y, W, H: - Code used to determine the dimensions for this window. --- Terms of Use 1. These plugins may be used in free or commercial games provided that they have been acquired through legitimate means at VisuStella.com and/or any other official approved VisuStella sources. Exceptions and special circumstances that may prohibit usage will be listed on VisuStella.com. 2. All of the listed coders found in the Credits section of this plugin must be given credit in your games or credited as a collective under the name: "VisuStella". 3. You may edit the source code to suit your needs, so long as you do not claim the source code belongs to you. VisuStella also does not take responsibility for the plugin if any changes have been made to the plugin's code, nor does VisuStella take responsibility for user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow custom JavaScript code. 4. You may NOT redistribute these plugins nor take code from this plugin to use as your own. These plugins and their code are only to be downloaded from VisuStella.com and other official/approved VisuStella sources. A list of official/approved sources can also be found on VisuStella.com. 5. VisuStella is not responsible for problems found in your game due to unintended usage, incompatibility problems with plugins outside of the VisuStella MZ library, plugin versions that aren't up to date, nor responsible for the proper working of compatibility patches made by any third parties. VisuStella is not responsible for errors caused by any user-provided custom code used for custom control effects including advanced JavaScript notetags and/or plugin parameters that allow JavaScript code. 6. If a compatibility patch needs to be made through a third party that is unaffiliated with VisuStella that involves using code from the VisuStella MZ library, contact must be made with a member from VisuStella and have it approved. The patch would be placed on VisuStella.com as a free download to the public. Such patches cannot be sold for monetary gain, including commissions, crowdfunding, and/or donations. 7. If this VisuStella MZ plugin is a paid product, all project team members must purchase their own individual copies of the paid product if they are to use it. Usage includes working on related game mechanics, managing related code, and/or using related Plugin Commands and features. Redistribution of the plugin and/or its code to other members of the team is NOT allowed unless they own the plugin itself as that conflicts with Article 4. 8. Any extensions and/or addendums made to this plugin's Terms of Use can be found on VisuStella.com and must be followed. Terms of Use: Japanese 『VisuStella MZ』利用規約 1. これらのプラグインは、VisuStella.comおよび/または公式に承認されたVisuStellaのソースから合法的な手段で入手したものである限り、フリーゲームや商用ゲームに使用することができます。例外的に使用が禁止される場合については、VisuStella.comの記載をご確認ください。 2. 本プラグインの「クレジット」部分に記載されているすべてのコーダーの名前は、ゲーム内にクレジット表記を行うか、もしくは「VisuStella」という名前の下にまとめて表記する必要があります。 3. ソースコードを自分のものだと主張しない限りは、必要に応じて編集することが可能です。ただしプラグインのコードに変更が加えられた場合、VisuStellaはそのプラグインに対して一切の責任を負いません。高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードについても、VisuStellaは一切の責任を負いません。 4. これらのプラグインやプラグイン内のコードを、「自分のもの」として再配布したり使用したりすることはできません。これらのプラグインとそのコードは、VisuStella.comおよび、その他の公式/承認済みVisuStellaソースからのみダウンロードすることができます。公式/承認済みのソースのリストは、VisuStella.comでご確認いただけます。 5. VisuStellaは、意図しない使用方法による問題、VisuStella MZライブラリ以外のプラグインとの非互換性の問題、プラグインのバージョンが最新でないことによる問題、第三者による互換性パッチが適切に動作していないことなどが原因でゲーム内で発生した問題については、一切の責任を負いません。VisuStellaは、高度なJavaScriptのノートタグやJavaScriptコードを許可するプラグインのパラメータを含む、カスタムコントロールエフェクトに使用される、ユーザー提供のカスタムコードに起因するエラーについても、一切の責任を負いません。 6. VisuStella MZライブラリのコードを使用した互換性パッチをVisuStellaとは関係のない第三者を通じて作成する必要がある場合は、まずVisuStellaのメンバーと連絡を取り、承認を得る必要があります。パッチはVisuStella.comに公開され、誰でも無料でダウンロードすることができるようになります。このようなパッチを、制作発注やクラウドファンディングの対象にしたり、寄付などの金銭的な利益を得るために販売することはできません。 7. このVisuStella MZプラグインが商用製品である場合、プロジェクトチームのすべてのメンバーは、それを使用するため、それぞれ製品を購入しなければなりません。使用方法には、関連するゲームメカニクスの作業、関連するコードの管理、および/または関連するプラグインコマンドや機能の使用、が含まれます。プラグインそのものやそのコードをチームの他のメンバーに再配布することは第4項に抵触するため、そのメンバーがプラグインそのものを所有していない限りは許可されません。 8. このプラグインの利用規約の追加項目や補足については、VisuStella.comに掲載されていますので、それを参照し従ってください。 Credits If you are using this plugin, credit the following people in your game: Team VisuStella Irina Arisu Olivia Yanfly Changelog Version 1.01: August 17, 2023 Bug Fixes! Fixed a crash that would occur if the "Touch UI" option is off. Fix made by Arisu. Version 1.00 Official Release Date: March 3, 2023 Finished Plugin! See Also Inspiration Behind Visual Novel Volume 3 End of File