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

Shadowblade44

#181 Jan 12, 2021, 05:34 PM Source

ThePedro004 said:
Thanks a lot!!!

taaspider said:
I figured out what is going on with the font issue. MZ allows you to easily input your own custom font right at the engine, at the System 2 tab. However, the code behind it gives it a nickname, which is what we should call it when we need to use it here (assuming you don have any other plugins enabled that give you more control over your fonts). I'll add a disclaimer for this at the MZ thread.

So, when setting up your plugin configurations just use this nickname (which is rmmz-mainfont) and your custom font will work as expected!

Those of you that have multiple fonts will probably have a plugin handling that, and should be able to reference the font with its real name (or any other key your plugin provides!).

https://gyazo.com/b90c3d01a953bf9986045dca8642fbda?token=ebf512525bdcf8dd818bed62910ee342 here you go. Sorry for teh late reply
taaspider

#182 Jan 13, 2021, 12:16 AM Source

Shadowblade44 said:
https://gyazo.com/b90c3d01a953bf9986045dca8642fbda?token=ebf512525bdcf8dd818bed62910ee342 here you go. Sorry for teh late reply

No problem. This particular error is being triggered when the plugin tries to load the text portion of a book. It seems there's something wrong with the book setup at the Plugin Manager. Can you send me your plugins.js file?
It is located inside the js folder in your project. With it I can see how your books are configured and help you find what's wrong.
Shadowblade44

#183 Jan 14, 2021, 02:14 AM Source

taaspider said:
No problem. This particular error is being triggered when the plugin tries to load the text portion of a book. It seems there's something wrong with the book setup at the Plugin Manager. Can you send me your plugins.js file?
It is located inside the js folder in your project. With it I can see how your books are configured and help you find what's wrong.

Send you a screenshot of the file explorer window with my plugins folder open? Or send you the plugin manager window?
taaspider

#184 Jan 14, 2021, 03:40 PM Source

Shadowblade44 said:
Send you a screenshot of the file explorer window with my plugins folder open? Or send you the plugin manager window?

No, send me the file "plugins.js" itself. It holds all settings from the Plugin Manager (enabled plugins and their parameters). If you send me the file I can load it here in a test project and see myself what's going on. I'm actually interested in seing details of your book menu setup, so I really need just the plugins.js file.
Shadowblade44

#185 Jan 16, 2021, 01:47 AM Source

taaspider said:
No, send me the file "plugins.js" itself. It holds all settings from the Plugin Manager (enabled plugins and their parameters). If you send me the file I can load it here in a test project and see myself what's going on. I'm actually interested in seing details of your book menu setup, so I really need just the plugins.js file.

Alright, I'll do that.

And reminder that this isn't even the main problem lol, this is just trying to get the plug in to load in the test project. Which it won't I can get it to load just fine in the project I'm actually working on, but It can't seem to load a third category.
Shadowblade44

#186 Jan 16, 2021, 01:49 AM Source

taaspider said:
No, send me the file "plugins.js" itself. It holds all settings from the Plugin Manager (enabled plugins and their parameters). If you send me the file I can load it here in a test project and see myself what's going on. I'm actually interested in seing details of your book menu setup, so I really need just the plugins.js file.

TAA_BookMenu
Hopefully that's what you wanted
Shadowblade44

#187 Jan 16, 2021, 02:23 AM Source

taaspider said:
No, send me the file "plugins.js" itself. It holds all settings from the Plugin Manager (enabled plugins and their parameters). If you send me the file I can load it here in a test project and see myself what's going on. I'm actually interested in seing details of your book menu setup, so I really need just the plugins.js file.

Oh, wow. Nevermind. I'm an idiot. I literally just had to go and start a new game in the play tester and the play all the way to where I was supposed to get the book. All of this for nothing. My bad lmao.
Bilalichwa

#188 Feb 11, 2021, 03:04 AM Source

hi i got problem when i export to android. (RPG Maker MV)
all img from pictures folder not showing up (not work/error)
DarkSearinox92

#189 Feb 19, 2021, 02:41 PM Source

@taaspider Hey spider, is there really a problem on the android version? May i help you? I'm referring to the problem of @Bilalichwa
taaspider

#190 Mar 3, 2021, 11:01 PM Source

@Bilalichwa , @DarkSearinox92 ... sorry for the delay... I've working way more than I wanted and have been having little time to code.

Someone reported a bug directly to me a few weeks ago that affects all web deployments of TAA_BookMenu and TAA_CharacterPoses. From the error posted by Bilalichwa, the same issue applies to Android deployments.

The issue occurs because I added a validation to prevent the code from crashing if the image is not found on disk at runtime. But that backfired :(
At the time I haven't realized that the functions I used works only on PC deployments, it will most definetely break on Android em web deployments.

Right now, fixing this is my top priority. I hope to have this fixed pretty soon, but there is a workaround in case you can't wait: add a line below line 2651 on the plugin code with the command "return true;", and the file validation will get bypassed. The code result should look like the image inside the spoiler tag below.

Spoiler
Taiminat

#191 Mar 25, 2021, 05:32 PM Source

Hello, thanks for the plugin. :rhappy:

I need help editing the parameters. Is it possible to disable Menu Title/text window completely and open a detached book scene every time a book is read?

By the way, I can't find the command to open detached book scene, please help :D
taaspider

#192 Mar 25, 2021, 11:22 PM Source

Tamina said:
Hello, thanks for the plugin. :rhappy:

I need help editing the parameters. Is it possible to disable Menu Title/text window completely and open a detached book scene every time a book is read?

By the way, I can't find the command to open detached book scene, please help :D

Hello there!

There's no built in way to have the detached scene open by selecting an entry from the menu scene, unfortunately. But you can build something like that using common events I think. Or you can change the title window placement (so it doesn't appear in the menu scene) and work with just the list and text windows. If you set the text window to full transparency and always use a custom background for your books you may be able to simulate the effect you want.

To open the detached scene (in MV), simply use the ReadBook Plugin Command (take a look at the plugin help file for details on how to use it).
Taiminat

#193 Mar 27, 2021, 05:16 AM Source

@taaspider

Thanks for the answer :)

I have another question :) Is it possible to change "category" name color or turn it off in menu list? Since both category and book titles are white, it can be confusing to read if this list is very long.

I tried to turn it off so the menu list is less confusing but it still shows blank space.

Edit: Nevermind, I think I figured it out!
taaspider

#194 Apr 5, 2021, 10:13 PM Source

Bilalichwa said:
hi i got problem when i export to android. (RPG Maker MV)
all img from pictures folder not showing up (not work/error)

DarkSearinox92 said:
@taaspider Hey spider, is there really a problem on the android version? May i help you? I'm referring to the problem of @Bilalichwa

taaspider said:
@Bilalichwa , @DarkSearinox92 ... sorry for the delay... I've working way more than I wanted and have been having little time to code.

Someone reported a bug directly to me a few weeks ago that affects all web deployments of TAA_BookMenu and TAA_CharacterPoses. From the error posted by Bilalichwa, the same issue applies to Android deployments.

The issue occurs because I added a validation to prevent the code from crashing if the image is not found on disk at runtime. But that backfired :(
At the time I haven't realized that the functions I used works only on PC deployments, it will most definetely break on Android em web deployments.

Right now, fixing this is my top priority. I hope to have this fixed pretty soon, but there is a workaround in case you can't wait: add a line below line 2651 on the plugin code with the command "return true;", and the file validation will get bypassed. The code result should look like the image inside the spoiler tag below.

Spoiler
View attachment 181601

@Bilalichwa , @DarkSearinox92 , this issue has been fixed in version 1.6.0!
I've reworked the entire function in a way that works for Mobile and Web deployments, and have also included a parameter to disable the check altogether if you ever need to (since inline images are dynamic, I recommend leaving it enabled as a safety measure).

This version has also included a feature that has been requested a few times: it allows book contents to change as the game progresses. Apart from that, added the possibility of marking newly added or recently changed books so the player can easily find new information in the book menu list. That and a few other bug fixes!

Sample image
DarkSearinox92

#195 Apr 6, 2021, 08:12 PM Source

Hem... :( @taaspider

What the hell? I just replaced it ...

EDIT: Wait, i remember this... i had a flash.
I don't know why, but under the path for .json file, the / before the folder disappeared.

I have the json under data, so:

/data/books_ita.json > in this way it works.

But i think that it wasn't there before. .-. Or yes?

I don't remember if we had put it on, the last time, or we had removed it ... but I haven't touched that parameter anymore. How strange!
taaspider

#196 Apr 6, 2021, 10:40 PM Source

DarkSearinox92 said:
Hem... :( @taaspider

View attachment 185229

What the hell? I just replaced it ...

EDIT: Wait, i remember this... i had a flash.
I don't know why, but under the path for .json file, the / before the folder disappeared.

I have the json under data, so:

/data/books_ita.json > in this way it works.

But i think that it wasn't there before. .-. Or yes?

I don't remember if we had put it on, the last time, or we had removed it ... but I haven't touched that parameter anymore. How strange!
The error in the console points exactly to where the code reads the JSON file. I can't really explain what happened, as I didn't change a thing there, but I'm glad it worked! hahaha :guffaw:
Spocker

#197 May 23, 2021, 03:37 PM Source

Hi Taaspider!
I was enjoying your BookMenu plugin version 1.3.6 (yup, two years ago I was already here! ^^), but when I downloaded and tried the new version 1.6, here is what I received.

"AddChildAt: an index supplied is out of bounds"

I would gladly give you more info if you could tell me where exactly to find them (what "Index4" refers to, or "bounds2").
Thank you a lot! I don't mind using the old version but I'm sure you made amazing changes.
taaspider

#198 May 23, 2021, 07:04 PM Source

Spocker said:
Hi Taaspider!
I was enjoying your BookMenu plugin version 1.3.6 (yup, two years ago I was already here! ^^), but when I downloaded and tried the new version 1.6, here is what I received.

"AddChildAt: an index supplied is out of bounds"

I would gladly give you more info if you could tell me where exactly to find them (what "Index4" refers to, or "bounds2").
Thank you a lot! I don't mind using the old version but I'm sure you made amazing changes.

View attachment 189974
Hello there!
I'm glad to hear this plugin has been going around all this time! :)
I need to see the console error messages to try and see what is happening. Just press F12 (or sometimes F8) to open the console when the error occurrs. Then send me a print of the console window (or paste the console messages here, just be sure to copy everything).

If I would guess, I would say there's something unexpected happening when trying to add an image somewhere. I need to see the console output first, then I'll be able to say if I'll need more data!
Spocker

#199 May 23, 2021, 07:30 PM Source

Hi,
Thank you for this quick answer!
Here is what I get when opening the console with F12.
(I precise that the version 1.3.6 does not show this error, even with the same other plugins.
taaspider

#200 May 25, 2021, 10:36 PM Source

Spocker said:
Hi,
Thank you for this quick answer!
Here is what I get when opening the console with F12.
(I precise that the version 1.3.6 does not show this error, even with the same other plugins.

View attachment 189982
I think this may be a compatibility issue. Have you tried the new version with your settings in a blank project to see if it works?
Or just disable all other plugins and see if the issue persists. If it starts working, turn on your other plugins one by one until the issue comes back and let me know which one is the culprit. If the issue does persist I may need you to PM me a test project where I can replicate the issue so I can run some tests