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 13 of 16 View original ↗

Random Panda

#241 Dec 3, 2021, 01:54 PM Source

taaspider said:
Hello!

There's a few new parameters added from version 1.3 to 1.6.3. The error you're getting is probably because some of them might not be set. I believe you just need to open the JSON config parameters, so the plugin can load default values for the new parameters, then save your settings and give it another go.

From the console error message it seems the crash is occurring because the plugin is trying to access specifically the parameters that defines which object inside your JSON describes the variable and visible text arrays. Having those parameters updated in the Plugin Manager should fix that!
Wow... I can't believe it was that simple. Thank you so much!
upaw

#242 Dec 15, 2021, 04:34 AM Source

Hello I cant seem to figure out how to add the book menu to yanfly's main menu manager it keeps showing an error

Edit: After some hours of fiddling with it I finally figured it out!
PLUEVNR

#243 Feb 13, 2022, 09:35 PM Source

Hello,
I'm having an issue when I'm putting icons one line after another

Is there anyway to modify the space between lines?
Foucal

#244 Feb 20, 2022, 10:30 AM Source
Hi,

PLUEVNR said:
Hello,
I'm having an issue when I'm putting icons one line after another
View attachment 216205
Is there anyway to modify the space between lines?

In the plugin options : Menu Text Window Config > Line Height (default 36).

Now, I started using this plugin in MV and it worked as expected so far. However, in a separated JSON file I tried to use the "visibleTexts" field but it gives me the following error :
JavaScript:
Uncaught TypeError : Cannot read property "visibleTexts" of undefined
So, apparently the book textArray (or texts in general) is not defined before getting its "visibleTexts" property, does someone know how to fix it ? I guess it should be a simple if condition but I don't know where to put it.
PLUEVNR

#245 Feb 20, 2022, 01:10 PM Source

Foucal said:
In the plugin options : Menu Text Window Config > Line Height (default 36).
Already tried and it doesn't work
Foucal

#246 Feb 20, 2022, 01:18 PM Source

Is it in the menu or the detached entry ? If so, maybe it's in the Detached Text Window property.
PLUEVNR

#247 Feb 20, 2022, 08:55 PM Source

It's in the menu. I've changed it to 200 to make it too big and be able to see any changes. Nothing moves.
taaspider

#248 Feb 21, 2022, 01:38 PM Source
PLUEVNR said:
Already tried and it doesn't work
It should have worked. I'll take a look at it later.
Foucal said:
Hi,

In the plugin options : Menu Text Window Config > Line Height (default 36).

Now, I started using this plugin in MV and it worked as expected so far. However, in a separated JSON file I tried to use the "visibleTexts" field but it gives me the following error :

JavaScript:
Uncaught TypeError : Cannot read property "visibleTexts" of undefined
So, apparently the book textArray (or texts in general) is not defined before getting its "visibleTexts" property, does someone know how to fix it ? I guess it should be a simple if condition but I don't know where to put it.
Can you show me the complete error message in the console?
My guess is that there may be something misconfigured in the plugin manager parameters, but I need more information to confirm.
Foucal

#249 Feb 21, 2022, 02:18 PM Source
taaspider said:
It should have worked. I'll take a look at it later.

Can you show me the complete error message in the console?
My guess is that there may be something misconfigured in the plugin manager parameters, but I need more information to confirm.
Thanks for your quick answer. In the console I get :
JavaScript:
Uncaught TypeError: Cannot read property 'visibleTexts' of undefined at TAA_BookMenu.js:2695 at XMLHttpRequest.xobj.onload (TAA_BookMenu.js:2751)
This is all I have. I double checked the spelling of the field in the JSON file and in the plugin parameters but no issue here, it does match.
taaspider

#250 Feb 21, 2022, 06:07 PM Source
Foucal said:
Thanks for your quick answer. In the console I get :

JavaScript:
Uncaught TypeError: Cannot read property 'visibleTexts' of undefined at TAA_BookMenu.js:2695 at XMLHttpRequest.xobj.onload (TAA_BookMenu.js:2751)
This is all I have. I double checked the spelling of the field in the JSON file and in the plugin parameters but no issue here, it does match.
There is something wrong with the source JSON file I think. The error happens exactly in the spot the code tests if the visibleText object exists (for error handling), but it is crashing because it is iterating through the books and one of them seems to be undefined.

Can you double check if there is any book key without its underlying objects, or with typos on their names?
If everythin is ok, please PM me your books JSON file so I can take a look in my test project.
Foucal

#251 Feb 21, 2022, 06:17 PM Source

I checked everything and even used a much shorter file to verify, same problem. Sending you a PM.
Seacliff

#252 Feb 22, 2022, 02:38 AM Source

I am having issue using the Plugin Manager Books in MZ. The book titles are displayed, but the text is not.
Spoiler

Tried the plugin by itself and tried reinserting it fresh into the project, same results.

The text was displaying earlier, but all of a sudden stopped doing so. I don't know what I did that could have caused this. Any help would be appreciated.
taaspider

#253 Feb 24, 2022, 10:22 PM Source

Seacliff said:
I am having issue using the Plugin Manager Books in MZ. The book titles are displayed, but the text is not.
Spoiler
View attachment 217105

View attachment 217108

Tried the plugin by itself and tried reinserting it fresh into the project, same results.

The text was displaying earlier, but all of a sudden stopped doing so. I don't know what I did that could have caused this. Any help would be appreciated.
Sorry for the delay... Have been pretty busy this week.
At glance I have no ideia what could have caused this. Anyways, I'll run some tests in the next few days and see if I can manage to replicate the issue by myself, but if you have a test project with the issue present and are able to send it to me (a download link, attached to a PM, whatever suits you better), that can speed things up! :)
Seacliff

#254 Feb 25, 2022, 10:52 PM Source

@taaspider I figured out my issue. A new file had to be created for the books to load properly.

Apparently when you load a file all the books are loaded automatically, so I didn't realize that was the issue at first. Nothing needs to be fix after all.
taaspider

#255 Mar 26, 2022, 09:13 PM Source

taaspider said:
It should have worked. I'll take a look at it later.

Can you show me the complete error message in the console?
My guess is that there may be something misconfigured in the plugin manager parameters, but I need more information to confirm.
Sorry for the delay @PLUEVNR ... I've piled up quite a backlog, took a while to get to this.

Ok, I've tested the LineHeight parameter, but using my test project changing the parameter value correctly changed the window behavior:

Line Height at 68

Line Height at 200

Are you still having this issue?
If so, make sure you are editing the correct parameter. I've added screenshots highlighting it in the spoiler tag below.

Parameters

If it is correctly set and the issue is still present, then I'll need you to PM me a test project with it happening so I can try and debug it :/
taaspider

#256 May 2, 2022, 02:25 AM Source

Strife250 said:
Hello Everyone!

Has anyone made this plugin work with Luna Engine?

Thanks!
I've managed to add compatibility with Luna Engine with version 1.6.4.
You won't be able to customize the interface using Luna's yml files, you'll still have to configure it through the BookMenu's parameters (it's more a bypass to Luna's customizations, so the game won't crash, then a real compatibility patch). That's the best I can do on my side... anything more than this should be done by Luna's developers.
Super015

#257 Jul 2, 2022, 12:24 PM Source

Hi, congratulations on the great plugin!
I've only one problem, if I add a book during a game that has already started I can't see it in the menu, this is a problem because if I want to update the game with some corrections or new information I have to force the player to restart the game.
taaspider

#258 Jul 2, 2022, 08:30 PM Source

Super015 said:
Hi, congratulations on the great plugin!
I've only one problem, if I add a book during a game that has already started I can't see it in the menu, this is a problem because if I want to update the game with some corrections or new information I have to force the player to restart the game.
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 :)
Random Panda

#259 Jul 3, 2022, 11:16 PM Source

Hi Taaspider,

I am using this plugin in MV and found an issue where if you deploy a game with encryption, the images used in the book don't load. Is there a way to make this work? Any help would be greatly appreciated.
taaspider

#260 Jul 4, 2022, 01:53 PM Source

Random Panda said:
Hi Taaspider,

I am using this plugin in MV and found an issue where if you deploy a game with encryption, the images used in the book don't load. Is there a way to make this work? Any help would be greatly appreciated.
Hello there!

Is the parameter Check Files First enabled?
Unfortunately, this feature is not compatible with encrypted deployments, as I have not yet found a way to discover and use the encrypted file names in the code. In this scenario the plugin won't find any images, since it is looking for their unencrypted names, and that's why none of them are loaded (the plugin assumes they don't exist). The workaround, for now, is to disable this parameter or not to encrypt the deployment. I've spent some time looking into making it compatible, but haven't found a way to do so yet.