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

ThreeSixNine

#21 Feb 26, 2019, 02:32 PM Source

This is definitely one of my new favorites! Thank you so much for creating this, I plan to utilize this as much as possible.
Uzuki

#22 Jun 20, 2019, 08:54 PM Source

@taaspider Hello! You've made an amazing plugin and I'm excited to have it in my current project. I've run into a problem with the menu going blank when I select an entry and freezing on that screen. I read about the issue in the OP about the word wrapping, but that didn't help. The only plugins that I'm using that would affect menus are the yanfly plugins. Is there a way I can fix this work around it?

Edit: I found the problem! It seems that there's a compatibility issue with Olivia's StatetooltipDisplay plugin.
taaspider

#23 Jun 24, 2019, 06:46 PM Source

Thanks for the feedback @Uzuki , I'm glad you liked it! :D

I don't know how far you have debugged the issue, but were you able to pinpoint which part of the code is causing issues?
If you wish, send me Olivia's plugin through a PM so I can take a look (don't post it here, since it is a paid plugin... if you share it with me I'll use it for debugging purposes only).

I have a busy week on my day job this week, but I'll take a few days off starting next week and will be happy to extend the plugin's compatibility :)
taaspider

#24 Jul 2, 2019, 03:15 PM Source

If anyone else is having issues with Olivia StateTooltipDisplay plugin, compatibility has been fixed on version 1.3.1 :D
RodrigoAijo

#25 Aug 1, 2019, 09:10 AM Source

Hello. I noticed that the script is not compatible with Mog_MenuCursor.
The book menu closes and the game freezes as I place the cursor over a book.
Can you fix this? Thanks in advance.
taaspider

#26 Aug 2, 2019, 12:53 PM Source

Hi there @RodrigoAijo .
Sure, I'll take a look. It will probably take a few days though. I'll let you know as soon as I have a new version.
taaspider

#27 Aug 9, 2019, 12:53 AM Source

@RodrigoAijo , I think I figured it out. I did some testing and it seems to be fixed, but I would appreciate if you could test it further in your project and let me know as it goes. You can get the beta version here.
I'll wait a few days for your feedback before merging this version to the master branch and updating the main post.

If anyone is interested in the nasty details:
I turned out to be a similar issue to what was found with Olivia's plugin on version 1.3.0, only the same workaround was not possible with MOG's plugin. I may, however, have found a way to prevent future issues with any plugin that creates additional layers over every scene as long as such layers are placed ABOVE the WindowLayer (as is the case in both the plugins I mentioned).
Random Panda

#28 Aug 9, 2019, 05:59 PM Source

@taaspider
Such an amazing Plugin! Thank you so much for making this.

My only issue is a small one that hopefully you might be able to help with. I use the plugin RS_MessageAlign to make it easier to center text in dialog boxes. Unfortunately it seems to make it so I can't utilize the text alignment feature in your book plugin. Do you know of any way I can make a compatibility fix for these two? Any help would be greatly appreciated.

That other question I have is if there is a way to change the color of the titles. I tried putting \c[x] bore the titles but that changes the color in both the list and the title section. Any help from you or anyone else would be greatly appreciated. Again this plugin is so great!!!
taaspider

#29 Aug 11, 2019, 08:31 PM Source

Hi there @Random Panda
I'll take a look at both compatibility with RS_MessageAlign and changing title section text color only.
I'll keep you posted!
Random Panda

#30 Aug 12, 2019, 12:56 AM Source

Thank you so much! If there's any thing I can do to help let me know!
KingGodzilla

#31 Aug 20, 2019, 06:20 PM Source

There's a game breaking issue when there's different "Custom Backgrounds" for several books. It will load the first custom background fine, but clicking on the next book with a different custom background, the picture will be shown over the text, and clicking on a third book will cause both backgrounds to load and it removes the menu entirely, locking you out of all controls and forcing a restart. This even happens in your own demo. What I did to replicate this issue in the demo: Your "Custom Background" book is set to "Sword", so I configured the book above that, "Background Images" to be "Universe", and the one below, "Inline Images", to be "Gates" and then ran the demo. Talked to the first guy, had him show all books, and then read each of those three books, causing the issue.
taaspider

#32 Aug 21, 2019, 12:35 PM Source

Hi there @KingGodzilla .
I haven't done that specific test during development... thanks for pointing it out!
From your description I think I know what's causing the problem. I just need to figure out how to fix it hehe

I'll probably have some time to mess with the code this week. I still need to check things for Random Panda, but I'll prioritize a game breaking issue :blink:
I'll let you know as soon as I have something.
taaspider

#33 Sep 4, 2019, 12:03 AM Source

@KingGodzilla ,
I have fixed the bug you described. Please download the latest version and check it out.

@Random Panda ,
I have included a new parameter to each book that will allow you to set a custom color for the title that affects the title window only. So you can have default color on the book list and a custom one in the title.
As for RS_MessageAlign compatibility, I haven't got time to take a proper look at it yet. I'll let you know when I do.
taaspider

#34 Oct 6, 2019, 07:47 PM Source

Hello everybody... Version 1.3.4 is out now with a few bug fixes and a new feature added:

Changelog

@Random Panda , I managed to find what's wrong with RS_MessageAlign compatibility. So, I have good, bad and then some more good news.

The first good news is that I found an issue that caused the first line of text never being aligned properly. That is fixed on version 1.3.4.

The bad news is that I believe the issues you were experiencing are caused by a bug on RS_MessageAlign. I found that the way the plugin was written causes it to not work as intended if you mix different alignments on the same text accross multiple lines. To be more precise, it cycles alignment for each new line, so if you change alignment anywhere through your text it will actually be applied at the first line break, not at the precise point you include the alignment tag. I recommend reaching out to the plugin's owner and see if he can fix it.

The other good news is that I found a workaround for you (it won't work with wordwrap active though). If you include an alignment tag at the start of each line of text on your book until the alignment change (do that for blank lines too), the cycling will align the text properly. That won't work with wordwrap because you won't know for sure where the line breaks are and where new lines begin. Not the ideal solution, but it will work if you can't get the plugin fixed.

I hope this helps!
ConfliKt

#35 Oct 23, 2019, 01:05 PM Source

Hey, i tried your plugin, but whenever i tried to boot the game it would say:
"Uncaught TypeError: Cannot read property 'books' of undefined"

so i tried to seek wisdom in your demo, but whenever i would try to open a book it would say
"Imported is not defined"
ThreeSixNine

#36 Oct 23, 2019, 05:14 PM Source

ConfliKt said:
Hey, i tried your plugin, but whenever i tried to boot the game it would say:
"Uncaught TypeError: Cannot read property 'books' of undefined"

so i tried to seek wisdom in your demo, but whenever i would try to open a book it would say
"Imported is not defined"

The very first option under plugin parameters, DataSource Config: DataSource type, is is set to JSON or plugin manager? if it's set to JSON the plugin will attempt to load a separate file in-game. If you set it to plugin manager, you can do all your book creation through the plugin.
ConfliKt

#37 Oct 23, 2019, 05:25 PM Source

xDRAGOONx said:
The very first option under plugin parameters, DataSource Config: DataSource type, is is set to JSON or plugin manager? if it's set to JSON the plugin will attempt to load a separate file in-game. If you set it to plugin manager, you can do all your book creation through the plugin.

I did just that, and now it doesn't crash on startup, however i still get the error:

"Imported is not defined"

whenever i open a book, in both the demo game, and a clean rmmv game with only EISLibrarium.
ThreeSixNine

#38 Oct 23, 2019, 05:36 PM Source

ConfliKt said:
I did just that, and now it doesn't crash on startup, however i still get the error:

"Imported is not defined"

whenever i open a book, in both the demo game, and a clean rmmv game with only EISLibrarium.
Can you upload a screenshot of your plugin parameters menu?
taaspider

#39 Oct 23, 2019, 05:40 PM Source

Hi there @ConfliKt ... @xDRAGOONx beat me to it, I was about to ask you the same thing (your plugin parameters settings)! :D
Also, see if you can open the console (F8) and send a screenshot of that as well.

Edit: Ok, I took a quick glance at the plugin and I think I may know whats happening. It may be an issue inadvertedly introduced on version 1.3.4. Try including the followind on line 11 and running it again (just after "TAA.bm.alias = {};"):

var Imported = Imported || {};
If that works I'll update the code at git later :)
ConfliKt

#40 Oct 23, 2019, 05:43 PM Source