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

C64_Mat

#221 Sep 29, 2021, 05:30 AM Source

ThreeSixNine said:
I use CGMV Core, many Yanfly Plugins and this plugins and I havent had any issues.

I have CGMV placed above all the yanfly plugins and this amazing plugin below all the Yanfly ones.
That's interesting feedback! For me, moving this particular plugin around doesn't make any difference... I'll try moving CGMV Core above Yan's and let you know the outcome.
C64_Mat

#222 Sep 30, 2021, 04:09 PM Source

ThreeSixNine said:
I use CGMV Core, many Yanfly Plugins and this plugins and I havent had any issues.

I have CGMV placed above all the yanfly plugins and this amazing plugin below all the Yanfly ones.
That didn't work I'm afraid... The ONLY thing that works for me is turning off the CGMV Core.
taaspider

#223 Oct 6, 2021, 11:50 PM Source

C64_Mat said:
That didn't work I'm afraid... The ONLY thing that works for me is turning off the CGMV Core.
Have you tried setting up a clean test project with only the aforementioned plugins present to see if the issue persists?
I just did that and couldn't replicate the problem on my own.

Maybe if you send me your plugins.js file I can check if there isn't any specific parameters giving you trouble.
Can you PM me your plugins.js file, so I can check on your parameters settings?

Also, looking through CGMV's code I found nothing that should be interfering with BookMenu, strangely. All it does is create a bunch of new stuff the dev probably uses in his other plugins.

I can try debugging further with your plugins.js file, but the best course would be to setup a clean test project to replicate the problem in a more controlable environment. If you do manage to replicate it, sending me a link to download this test project would reeeeaaaally help me help you hehe :)
C64_Mat

#224 Oct 7, 2021, 09:39 AM Source

taaspider said:
Have you tried setting up a clean test project with only the aforementioned plugins present to see if the issue persists?
I just did that and couldn't replicate the problem on my own.

Maybe if you send me your plugins.js file I can check if there isn't any specific parameters giving you trouble.
Can you PM me your plugins.js file, so I can check on your parameters settings?

Also, looking through CGMV's code I found nothing that should be interfering with BookMenu, strangely. All it does is create a bunch of new stuff the dev probably uses in his other plugins.

I can try debugging further with your plugins.js file, but the best course would be to setup a clean test project to replicate the problem in a more controlable environment. If you do manage to replicate it, sending me a link to download this test project would reeeeaaaally help me help you hehe :)
Understood! Thank you so much for the time you've taken to look into this. The conflict strikes me as odd, too.

I will send you both the file, and a test project if I can recreate it on a new title.

Cheers again!

Mat
C64_Mat

#225 Oct 20, 2021, 12:42 PM Source

Thanks to the incredible help and support of the plugin owner, @taaspider , we now have compatibility!

I was mistaken in my original assessment - it was the CGMV_Toast plugin which was causing the conflict, with the way it handles pup-up windows in game.

However that affected the book menu I'm not sure, but it's been fixed, and @taaspider now has an updated version of their MV Book Menu plugin file. I now have compatibility between my masses of plugins, and I'm very grateful.

So, as for my particular issue, this has now been resolved. Thank you!
taaspider

#226 Oct 20, 2021, 11:37 PM Source

Version 1.6.2 has just been officially released with a compatibility fix for CGMV_Toast! :D
C64_Mat

#227 Oct 24, 2021, 04:21 PM Source

Sorry to be a pain in the arse @taaspider ! It's one quick question about aesthetics in the detached window.

In the Book Menu, my books look like this:

As you can see, I've altered the parameters of the windows so it fits my background image nicely. I'm really happy with this, and it looks and works great!

I've tried to follow a similar approach in the detached book window, but because there isn't a category list there (as there shouldn't be!), I want to have the book title window on the left of the screen half way down, as if it's the first inner page of the book, similar to how Morrowind did it. But because the text window positioning is configured to use the 'zero' Y position to mean directly underneath the title window, I can only get it to look like this:

I could of course use the 'zero' Y position for the title window, but even then it would still leave a gap at the top of the 'reading page' as it were. I've tried using things such as Y equalling -300, but it won't move lower than zero.

Here's an example of a book being read in Skyrim, to show something similar to what I'm trying to achieve!
Solar_Flare

#228 Oct 25, 2021, 05:40 PM Source

Did you try using a negative Y positioning? I'm not sure how reliable that would be but it might get you closer.
C64_Mat

#229 Oct 25, 2021, 06:18 PM Source

Solar_Flare said:
Did you try using a negative Y positioning? I'm not sure how reliable that would be but it might get you closer.
Yes, I did write that in my post. "I've tried using things such as Y equals -300"
Solar_Flare

#230 Oct 25, 2021, 11:23 PM Source

Oh, sorry, I must have missed that somehow…
taaspider

#231 Oct 28, 2021, 10:09 PM Source
C64_Mat said:
Sorry to be a pain in the arse @taaspider ! It's one quick question about aesthetics in the detached window.

In the Book Menu, my books look like this:

View attachment 204822

As you can see, I've altered the parameters of the windows so it fits my background image nicely. I'm really happy with this, and it looks and works great!

I've tried to follow a similar approach in the detached book window, but because there isn't a category list there (as there shouldn't be!), I want to have the book title window on the left of the screen half way down, as if it's the first inner page of the book, similar to how Morrowind did it. But because the text window positioning is configured to use the 'zero' Y position to mean directly underneath the title window, I can only get it to look like this:

View attachment 204823

I could of course use the 'zero' Y position for the title window, but even then it would still leave a gap at the top of the 'reading page' as it were. I've tried using things such as Y equalling -300, but it won't move lower than zero.

Here's an example of a book being read in Skyrim, to show something similar to what I'm trying to achieve!

View attachment 204828
Applying a negative value to the Text Window Y parameter should work. But, I took a look into the code and found a bug that would prevent that from happening as intended... turns out the plugin was completely ignoring this parameter.

I've setup a new version (1.6.3, it's already released on itch) that fixes this issue. For backwards compatibility purposes, the actual window position remains relative to the title window position for the detached scene. So if you want to move the text window to the top of the screen you should subtract the sum of the title Y position and its height. You can do that referencing the actual window settings using this value:
Code:
- this._titleWindow.height - this._titleWindow.y
If you want a fixed Y value not relative to the title window, just add it as a sum to the expression (+150, for example) and you're good to go.

I tested it over here and it has now worked as intended, but let me know if the issue somehow still persists!
C64_Mat

#232 Oct 29, 2021, 02:19 PM Source

@taaspider
I feel really guilty now because this plugin has been all nice and complete, and thanks purely to my using it you've now released two more versions. But I am grateful, of course!

Thank you isn't a big enough word!

Just to confirm - it works perfectly now.
taaspider

#233 Oct 29, 2021, 05:11 PM Source

C64_Mat said:
I feel really guilty now because this plugin has been all nice and complete, and thanks purely to my using it you've now released two more versions. But I am grateful, of course!
Don't worry... there's a ton of parameters on this one... I won't be surprised if people finds more stuff to fix by experimenting with them, or by combining this with other plugins. It's a really complex monster this thing, it's nice to see it getting used by you people and grow a little bit in the process! :D

C64_Mat said:
Thank you isn't a big enough word!

Just to confirm - it works perfectly now.
Glad I could help!
Let me know when your game is complete so I can check it out!! ^^
WoefulWitch

#234 Nov 28, 2021, 12:14 AM Source

@taaspider
I was hoping to use this plugin as a help guide, but for some reason categories aren't showing. All the "books" are showing up in the list, but there are no actual categories to open/close (see picture).

ShowCategories/LoadClosedCategories are both TRUE, and HideUnreadBooks is FALSE. But even if I try changing these values, there's no difference.

The attached image shows the "books" in the list without categories, and the attached text file is my JSON (renamed to .txt just because this site doesn't allow .json files to be uploaded for some reason...)

Am I doing something wrong?
Strife250

#235 Nov 29, 2021, 07:14 PM Source

Hello Everyone!

Has anyone made this plugin work with Luna Engine?

Thanks!
taaspider

#236 Nov 29, 2021, 11:57 PM Source

WoefulWitch said:
@taaspider
I was hoping to use this plugin as a help guide, but for some reason categories aren't showing. All the "books" are showing up in the list, but there are no actual categories to open/close (see picture).

ShowCategories/LoadClosedCategories are both TRUE, and HideUnreadBooks is FALSE. But even if I try changing these values, there's no difference.

The attached image shows the "books" in the list without categories, and the attached text file is my JSON (renamed to .txt just because this site doesn't allow .json files to be uploaded for some reason...)

Am I doing something wrong?
Hello!
I loaded your json file in a test project and it worked fine:

If Show Categories is set to true then they should be visible. Here's my list window settings:

Make sure that Category Text Format is set with the correct substitutions (%2 is replaced by the category name). If you make sure parameters are set correctly and the issue persists, send me your plugins.js file so I can double check your settings, please!

Strife250 said:
Hello Everyone!

Has anyone made this plugin work with Luna Engine?

Thanks!
I am unfamiliar with the Luna Engine, but I'll add an item to my backlog to look into it and check if compatibility is possible.
WoefulWitch

#237 Nov 30, 2021, 08:38 PM Source

@taaspider It seems that a new game is required for it to load properly. Starting a new game makes it work properly, but when I add things again, the new stuff is added the same way as in my picture, outside of any category. My settings look just like what's in your image of the plugin editor.
taaspider

#238 Dec 1, 2021, 12:36 PM Source

WoefulWitch said:
@taaspider It seems that a new game is required for it to load properly. Starting a new game makes it work properly, but when I add things again, the new stuff is added the same way as in my picture, outside of any category. My settings look just like what's in your image of the plugin editor.

You mean the error appears only when loading a saved game?
It shouldn't behave like that, but I'll run some tests later to check this.
Random Panda

#239 Dec 3, 2021, 11:21 AM Source

Hi All,

Maybe someone here can help me. I just updated from 1.3 to 1.6.3 and I load my book from a JSON file. This all worked fine before, but with the new version I get this error when I try to load the game. This also happens in a fresh game for my but not the demo, weirdly enough. Any help would be greatly appreciated. Also @taaspider thank you so much for this plugin, its so good!
taaspider

#240 Dec 3, 2021, 01:11 PM Source

Random Panda said:
Hi All,

Maybe someone here can help me. I just updated from 1.3 to 1.6.3 and I load my book from a JSON file. This all worked fine before, but with the new version I get this error when I try to load the game. This also happens in a fresh game for my but not the demo, weirdly enough. Any help would be greatly appreciated. Also @taaspider thank you so much for this plugin, its so good!
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!