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

ConfliKt

#41 Oct 23, 2019, 05:57 PM Source

taaspider said:
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 :)
Great, it seems to work like a charm, apart from your demo missing the graphics for "fancyA_45x38px.png", but i doubt that will have any effect on my project. :)
taaspider

#42 Oct 23, 2019, 06:04 PM Source

Sweet!

I'll fix the file on git later (will also remove reference to that file, it shouldn't be there... thanks for the headsup hehe).
Enjoy the plugin! :D
aelwhin

#43 Nov 1, 2019, 03:22 AM Source

Is there a way to update or add new entries without having to start the game from scratch? I'm making a game that will be updated on a constant basis, but the new entries I add don't show up in saved files and will only show up after starting a new game. Is there any way to work around this?

Thank you so much!
taaspider

#44 Nov 1, 2019, 07:33 PM Source

It will require a bit of coding, but it is possible.

I'm out of town for a few days, but I'll take care of it sometime next week! :)
aelwhin

#45 Nov 2, 2019, 01:03 PM Source

Thank you, that would be amazing!
EseQueL

#46 Nov 5, 2019, 09:10 AM Source

taaspider said:
If a book's text has too many line breaks (like, over 85 or so), there's some issue with the pixi filter I couldn't figure out that makes it crash and show the text window completely black, with no text. It will only happen for the books in this condition. However, I've tested it along with wordwrapping functions from other plugins, like Yanfly's Message Core for example, and I can have longer texts displayed without issue. So there's the workaround :D
Sadly, this workaround is not applicable to mobile. Furthermore, I don't know the minimum but the bug already exist at 18 lines. Rendering this plugin useless for mobile if you want to include long texts.
taaspider

#47 Nov 5, 2019, 01:36 PM Source

@EseQueL , have you tried the suggested workaround of using it along another plugin that provides wordwrapping functions?

As there is a workaround already mapped for the issue I wasn't planning on tackling it (as I also strongly recommend using wordwrap on your books). If the workaround is somewhat not working I may consider giving this issue more attention though.
EseQueL

#48 Nov 6, 2019, 05:25 AM Source

I only tried with Yanfly and I'm not willing to replace it just to make this plugin work though as I will lose a lot of the other great features from her message core and also might ran into incompatibility issues if I use other plugins aside from Yanfly's. It works on PC very well but not in mobile.
taaspider

#49 Nov 6, 2019, 12:39 PM Source

I see. I have tested it quite a bit with Yanfly Message Core on PC, and as far as I can tell it should be working on mobile as well.

Can you PM me with one or more books you're using that are causing the issue so I can try to replicate the issue here? A printscreen would be helpful too, if possible.
I'll see if I can fix it. I'll probably release a new version to fix the issue raised by aelwhin first, though, as it is quite simple.
taaspider

#50 Nov 10, 2019, 11:42 PM Source

@aelwhin , just uploaded version 1.3.5 with some changes to allow reloading book list when loading a save file. I've run some tests and it should be working, but let me know if something goes wrong.

Just a warning though: be careful not to change category names, order or ids, nor book names, otherwise you may have issues when loading your save file. If you're just adding more stuff you should be fine.
KingGodzilla

#51 Nov 12, 2019, 02:18 PM Source

Hey, thanks again for this plugin, just have a small suggestion: Can we have a setting in the plugin parameters that makes it where book categories start collapsed? When there's multiple entries for a bunch of categories, they all start expanded and man that's a lot of scrolling or collapsing. Categories starting minimized/closed would be a great option for this.
taaspider

#52 Nov 12, 2019, 04:45 PM Source

That's a nice idea, and rather simple to implement...
I'll get into that later. I'll let you know when it's done! :D

EDIT: @KingGodzilla , just released version 1.3.6, introducing the parameter "Load Closed Categories" in the List Window parameters. Update your plugin version and you're good to go!
Now I'll try to focus on EseQueL issue... which may take some time :|
manofrain

#53 Nov 15, 2019, 05:54 AM Source

Colossal work. Very few plugins for working with arrays of text. This plugin for RMMV is a breath of clean air.

(Can I load large blocks of text from an external *.txt files with basic formatting using this plugin? If someone knows, tell me this way, please.)
KingGodzilla

#54 Nov 16, 2019, 02:37 AM Source

taaspider said:
That's a nice idea, and rather simple to implement...
I'll get into that later. I'll let you know when it's done! :D

EDIT: @KingGodzilla , just released version 1.3.6, introducing the parameter "Load Closed Categories" in the List Window parameters. Update your plugin version and you're good to go!
Now I'll try to focus on EseQueL issue... which may take some time :|

I keep getting an error whenever I have the new "Load Closed Categories" set to on. The error is: TypeError $dataBooks._categoryList.splice is not a function.

I've even tried this in a brand new game with nothing but this plugin loaded and it still gives the same error. However, there's no error when the new setting is turned off, only when it's turned on.
taaspider

#55 Nov 16, 2019, 04:18 PM Source

KingGodzilla said:
I've even tried this in a brand new game with nothing but this plugin loaded and it still gives the same error. However, there's no error when the new setting is turned off, only when it's turned on.

That's strange... I made a few more tests and I did find a bug, but could not replicate the issue you describe. Just in case both have the same root cause, try this test version. If it doesn't work, can you PM me your plugins.js file (so I can load your plugin configurations)? If you're using a JSON file as an external datasource I'm gonna need that too.

manofrain said:
Colossal work. Very few plugins for working with arrays of text. This plugin for RMMV is a breath of clean air.

(Can I load large blocks of text from an external *.txt files with basic formatting using this plugin? If someone knows, tell me this way, please.)

What did you have in mind exactly?
You mean referencing txt files as a book text and loading it when the book is requested?

I did not plan on adding that, as you can just insert your text in a JSON file (basic formating would have to be escaped, but you can do that with a simple find and replace on notepad++, replacing line breaks with \n, for example).
KingGodzilla

#56 Nov 16, 2019, 04:59 PM Source

Just to make sure, I created a new project with the most recent plugin only (and also tried your test version), but this new project doesn't even make it to the title screen. It's an immediate: Error - Uncaught Error: There was an error loading the file 'undefined. This happens in both the most recent version and the test version. What I said before was just me turning off all other plugins except the book plugin, this time is a brand new game with just the plugin.
taaspider

#57 Nov 16, 2019, 05:33 PM Source

Are you able to run the demo project?
Also, what is your current steam version?
KingGodzilla

#58 Nov 16, 2019, 05:43 PM Source

Steam version is most up to date.

I was able to get the demo to work without getting an error, however... the new "Closed Category" parameter just doesn't work. Whether "Load Closed Categories" is set to true or false, the categories are always expanded when I go to main menu -> Books.
taaspider

#59 Nov 16, 2019, 05:49 PM Source

I just commited a few changes that may fix that behvior on the demo project. Can you update the plugin and try again please?
To speed things up, here's the link for the plugin only.
KingGodzilla

#60 Nov 16, 2019, 05:55 PM Source

I can confirm that your update there has your demo working properly.

I tried putting this file into my game, and while I'm no longer getting the error first reported, I'm getting a different one now. The categories still aren't closed by default (even with the parameter set to True), and when I try to close the category myself, I get this error: TypeError: this._closedBookCategories.push is not a function