TAA_BookMenu (v1.6.7)

taaspider · 2018-12-08T07:20:39+0900

TAA_BookMenu - v1.6.7 Created by taaspider Terms of Use Any plugins developed by taaspider are free for use for both commercial and noncommercial RPG Maker games, unless specified otherwise. Just remember to credit "taaspider". Redistribution of parts or the whole of taaspider plugins is forbidden (which also includes reposting), unless it comes from the official website (linked within the post). You are allowed to edit and change the plugin code for your own use, but you're definitely not allowed to sell or reuse any part of the code as your own. Although not required to use my plugins, a free copy of your game would be nice! Introduction When we create a game, we usually create a whole new world rich in lore and details, and want to make it all available to the players, so that they can understand every single detail we develop. However, just dumping it all in lengthy dialogues usually bore and scare most of the players, who will simply give up on your world. A common alternative used by many AAA games is to minimize dialogue and exposition, and provide additional details through in-game books. This plugin aims to provide just that for your game: a book menu where the player can read up additional lore when he feels up to it. You can place books throughout your game, providing a bit more of context for hungry players as they progress, and keeping exposition to a minimum. Features Creates a main menu command gathering books the player discovers throughout your world, letting them read whenever they want; Allows the dev to call a detached window and show the contents of a book outside the menu; Input your game books into the engine using either the Plugin Manager or an external JSON file; Compatibility with multilanguage plugins that uses multiple external files for text; Allows the dev to setup background images for both scenes separately, with options to use different images for each window or a single image for everything; Allows you to include inline images along with the book text. The image can be used with its original size, or proportionally resized through a special escape code. Use inline trailing images to give a nice finishing touch to your books! Scroll book text by cliking (PC) or touching (mobile) the arrows or swyping up and down; Have book contents change as the game progresses; Mark newly added or recently changed books in the book menu so your player knows when there's new information available; Solar_Flare also developed a nice add on for this plugin, which allows books to be loaded from external text files (one file per book). I recommend checking it out here. Screenshots Spoiler How to Use WARNING: This plugin requires RPG Maker MV 1.5.0 or above! Please make sure your RPG Maker MV software is up to date before using this plugin. First of, download the plugin here. There's a bunch of parameters that allows you to customize each of the scenes (the detached book window and the book menu). The plugin's help section describe most which are not self explanatory, try taking a look there if you feel lost. One important thing though... you have to set up your books before you can call them inside your game. There's two ways of doing that: inside the Plugin Manager itself or using external JSON files. The plugin can only work with one of this methods at a time, so you need to chose which one you want at the "DataSource Type" parameter. I'll enclose the instructions for each case in spoiler tags below to make it more readable. You can also test the plugin using my sample demo project. It was built with MV, but you can open it with MZ as well (just open the game.rmmzproject file and you're good to go). Spoiler: Plugin Manager as Source There's two main parameters to configure: Category Order: List your book categories in the order you wish them to appear in the menu command. If you don't wish to display categories, input at least one entry here and choose to hide categories in the Menu List Window options; Books: Here you'll have to list all the books you want to make available to the player. Each book have the following attributes: Title Title Color Text Variable Text List Visible Text List Category Id Custom Background Custom Background Mode The book category parameter must be one of the categories listed in the Category Order parameter. The Id is used only to order the books under each category. If you leave all Ids equal (0), the plugin will use the order it reads the books from the editor (usually the order you input them). Title Color is an optional parameter that allows you to set a custom color ONLY on the title section of the scene. So that it will appear with the default color on the list section of the menu, and the custom color on the title window. If you want a custom color on both windows just use color escape codes. If you want a book to have a custom background (overriding the global settings), just select an image for the "Custom Background" parameters. Leave it blank to go with…

● ARCHIVED · READ-ONLY

Started by taaspider Dec 7, 2018, 10:20 PM 301 posts Page 14 of 16 View original ↗

Random Panda

#261 Jul 4, 2022, 05:19 PM Source

I see, that helps so much, thank you!
Super015

#262 Jul 14, 2022, 11:39 AM Source

taaspider said:
Which version you are using?

Up to version 1.4.0 the plugin used to store the whole library in the save file, which would cause the issue you describe. On later versions I have changed the way save files are handled, and we only store which books have been read, if they are marked as new, and which variable text indexes are visible. So adding a new book or changing the text of an existing one should be automatically reflected on the the game the next time it boots (you need to at least close and open the game again, or press F5, to force it to reload your settings). I just tested this with the latest version and it works perfectly :)
Hi, thanks for the answer!
I started my project with your plugin at version 1.3, updating it periodically up to 1.6.5.
I was able to solve the problem only by completely deleting the plugin and setting it up again, in this way I was able to see also the "new marks".
Now I can add new books but not new categories.

Edit.
Another problem I just discovered, the new books are lacking in content. :kaoswt2:
taaspider

#263 Jul 20, 2022, 03:17 PM Source

Super015 said:
Hi, thanks for the answer!
I started my project with your plugin at version 1.3, updating it periodically up to 1.6.5.
I was able to solve the problem only by completely deleting the plugin and setting it up again, in this way I was able to see also the "new marks".
Now I can add new books but not new categories.

Edit.
Another problem I just discovered, the new books are lacking in content. :kaoswt2:
Hello!

Same as new books, there should be no problem in adding new categories, as the only thing that goes into the save file is which books are marked as read, and which ones have the "new marks". The same goes for the new books contents... unless you're using the variable text feature to hide parts of it, it should be displayed without problems, as the plugin really loads the books contents at game boot, regardless of using a save file or starting a new game.

Since I've been unable to replicate it, can you PM me a test project containing the issue so I can take a look?
IlTerrificatore

#264 Aug 24, 2022, 06:50 PM Source

Demo's link shows this to me:
taaspider

#265 Aug 26, 2022, 12:56 PM Source

IlTerrificatore said:
Demo's link shows this to me:
Hi there!

That's strange... I think you may be using an old link. I've updated everything to point to my itch page a long time ago (just checked the main post and it is pointing to the right place). You can find its most recent version here: https://taaspider.itch.io/sample-demo-project

I've bundled up all my plugin demos on the same project.
IlTerrificatore

#266 Aug 26, 2022, 06:16 PM Source

taaspider said:
Hi there!

That's strange... I think you may be using an old link. I've updated everything to point to my itch page a long time ago (just checked the main post and it is pointing to the right place). You can find its most recent version here: https://taaspider.itch.io/sample-demo-project

I've bundled up all my plugin demos on the same project.
This link works. Thank you very much comrade! :thumbsup-left:
Viranda

#267 Sep 28, 2022, 03:37 PM Source

Hello. Is the plugin not working on MZ 1.5? I can get to start it.

I downloaded the demo, which works fine. It says "Unkown version". When I updated its core to find out if that was the problem with my project, it indeed stopped working.
taaspider

#268 Oct 12, 2022, 10:03 PM Source

Viranda said:
Hello. Is the plugin not working on MZ 1.5? I can get to start it.

I downloaded the demo, which works fine. It says "Unkown version". When I updated its core to find out if that was the problem with my project, it indeed stopped working.
Yes, it is working on MZ 1.5 (I just tested it here). If you're trying to update the core for the sample project I am not sure that will work. Instead of recreating the whole demo on MZ I found a way of bundling together MV and MZ init files so the same project could be opened on both engines, but it is actually a MV project.

My advice is to create a new project on MZ and test the plugin there, using the sample project just as a reference.
oddproject

#269 Apr 4, 2023, 08:01 PM Source

Could someone tell me how I could do the localization of this plugin with the L10nMV?

CONTEXT:
I tried to use the "Plugin Manager", but after doing the translation of the plugin parameters, they were not superimposed.
taaspider

#270 Apr 21, 2023, 02:35 PM Source

oddproject said:
Could someone tell me how I could do the localization of this plugin with the L10nMV?

CONTEXT:
I tried to use the "Plugin Manager", but after doing the translation of the plugin parameters, they were not superimposed.
You mean that the book data was not replaced with the translated texts?

I'm not sure how L10nMV does localization for plugins... taking a quick glance at the code, it seems that whenever a plugin is added to the whitelist parameter, L10nMV replaces its parameters with the translated texts you write. However, I couldn't look into it as thoroughly as would need to understand exactly how it works. But I think support from the L10nMV dev would be more helpful here. If he (or she) finds that changes are required in my plugin to make them compatible I would be happy to help!
oddproject

#271 Apr 25, 2023, 01:13 PM Source

I talked about with the creator of the localization mod,
he replied "I just checked TAA_BookMenu code, if this doesn't work for it, that's the problem that probably caused by it uses own load system."

and it really seems to be the situation of how the plugin loads.

thank you for the answer.
Gudako

#272 May 21, 2023, 03:23 AM Source

It is possible to change text but can images be add with variables too? I want to make a medals collection and it would show, the medals when certain actions have been completed.
taaspider

#273 Jun 9, 2023, 10:01 PM Source

Gudako said:
It is possible to change text but can images be add with variables too? I want to make a medals collection and it would show, the medals when certain actions have been completed.
Well, you could do that by adding variable text entries for each medal (by referencing then with the %img or %in_img tags, or by referencing an icon with the default engine substitution texts), and then using the plugin commands to enable each medal as they are earned by the player.

The only restriction to this approach is that you would need to have one medal per line, as the current version won't allow you to add two or more images side by side.
Spocker

#274 Jul 14, 2023, 01:09 PM Source

Hi! Totally sorry to bother! I'm currently working on another category and I have a little issue with an image that is automatically cropped (on the right - we can see the border is cropped). I'm not sure how to avoid that, could you guide me a bit towards the good parameter? (The Test image is 1356*760).
Thank you a lot!

Edit: Sorry, an information I didn't give: I use the "Force Image into Window" parameter already.
taaspider

#275 Aug 5, 2023, 08:19 PM Source

Hi @Spocker !

Took a quick look at the plugin code, and I think it might be a bug. When the "Force Image into Window" parameter is set it resizes the image to the window width, but it is not taking window padding into consideration when resizing.

I did a small fix in the attached version. Can you test it and let me know if it fixes your issue?
Spocker

#276 Aug 8, 2023, 10:36 AM Source

Hi there! Sorry I took some time, because of holidays ^^'
It totally works, you magic master!
sanguine1038

#277 Oct 2, 2023, 07:29 AM Source

is there anyway to have it stored in when the player first sees it? like global switches, once the player triggers it, it stays active even after the game is closed?
ShadowDragon

#278 Oct 2, 2023, 09:11 AM Source

@sanguine1038 if it's not available, try Olivia_MetaControls which is
global switches/variables throughout the savefile or all savefiles.

unless he has one too :)
sanguine1038

#279 Oct 2, 2023, 09:15 PM Source

ShadowDragon said:
if it's not available, try Olivia_MetaControls which is
global switches/variables throughout the savefile or all savefiles.

unless he has one too :)
thats what im asking, if theres a way for the plugin to be similar to olivia metacontrols in that way.
ShadowDragon

#280 Oct 3, 2023, 07:56 AM Source

I'm not sure, but if you need it, why not use that plugin together?
unless it doesn't work for what you seek of course.

than it need to be either implemented or work nicely together.