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

taaspider

#141 Jun 14, 2020, 06:56 PM Source
Solar_Flare said:
Looks like that fixes ReadBook, and my localization plugin also properly picks up my library now without any modifications to your code. The only other thing is if using files as a source (whether JSON or BookFiles) the timing might cause it to sometimes notice it and sometimes miss it. For my purposes I've added this code to my local copy of BookFiles:

JavaScript:
const old_isLoaded = DataManager.isDatabaseLoaded; DataManager.isDatabaseLoaded = function() { if($dataBooks && $dataBooks._source === 'Book Files' && !$dataBooks._doneLoading) return false; return old_isLoaded.call(this); };

You might consider doing something similar for the JSON source. Obviously it's not needed with the Plugin Manager source.

This means that if it takes a long time to load the books, the game will display "Now Loading..." until it's finished. I guess you can decide whether you actually want this; the books aren't needed at the title screen, after all.
Probably most of the time delaying title screen before all books are loaded may not be needed. As you pointed out, they usually are not needed at the title screen. But, I can add a parameter for those who do need it that way. I'll probably hold on to that feature for now though, wait for more features before releasing a new version.
PLUEVNR said:
Thanks for the tips !

I sent you my JSON.
everything is working fine except the

Code:
LibraryData UnreadBooks show
I'll take a look there. If it's something on your file I'll answer through PM, otherwise I'll reply here in case someone stumbles into the same issue.

EDIT: Well, it turned out PLUEVNR's issue was a well hidden bug :/
So, I ended up releasing version 1.4.2 to fix it, and also included Solar_Flare suggestion with a parameter to enable / disable loading all book data before hitting the title screen.
spec3

#142 Jun 20, 2020, 06:33 AM Source

Wow! I just tested it and this plugin is great! I was making a "system" of files (like those of Resident Evil) all on the basis of variables and common events. Which, although it works, would be a monstrous work to sort due to the large amount of files.

I have many, many applications for your plugin. Now it's going to be so much easier!
Thank you so much! :LZSjoy:

On other hand, my game changes the skin of the window according to the character or according to the situation they find themselves in. Is it possible to change the window skin in a variable way? I mean, for example:

example
If situation A =
book menu list skin A
book menu title skin A
book menu text skin A
If situation B =
book menu list skin B
book menu title skin B
book menu text skin B
If situation C =
book menu list skin A
book menu title skin B
book menu text skin A

I got that effect with every window in the game. I wonder if there's a way to do it with this plugin. The windows I'm hoping to change are those in the attachment. Could somebody point the direction for me?
harvvvvv

#143 Jun 20, 2020, 03:06 PM Source

How difficult would it be to have the categories in a separate window that you can switch between? I'm imagining above the main content window similar to how inventory works with items/weapons/armour/etc.
taaspider

#144 Jun 21, 2020, 01:42 AM Source

spec3 said:
I got that effect with every window in the game. I wonder if there's a way to do it with this plugin. The windows I'm hoping to change are those in the attachment. Could somebody point the direction for me?
I'm not sure how it's working for other windows, but I could add a plugin command to change window skin, maybe?

harvvvvv said:
How difficult would it be to have the categories in a separate window that you can switch between? I'm imagining above the main content window similar to how inventory works with items/weapons/armour/etc.
That would require a decent amount of work to create a new window and scene structure. Unfortunately, I'm not planning nothing like it in the near future.
spec3

#145 Jun 21, 2020, 02:13 AM Source

taaspider said:
I'm not sure how it's working for other windows, but I could add a plugin command to change window skin, maybe?

Oh, I don't want to be annoying to you, if there is a way I could do it without giving you more work would be great. But if a command is possible it would be awesome.
I've been using Hime's window skin changer, in which we do script calls with the name of the window, but it does not affect yours unfortunately.
Solar_Flare

#146 Jun 21, 2020, 02:26 AM Source
spec3 said:
I've been using Hime's window skin changer, in which we do script calls with the name of the window, but it does not affect yours unfortunately.
It's because BookMenu overrides the function that Hime uses to set the windowskin on a window. If you always want the same window skin for the book window, you can just set it in the BookMenu plugin parameters. If you want to be able to swap window skins on the fly with Hime's functions, you can just find this function in BookMenu and delete it:
JavaScript:
Window_BookList.prototype.loadWindowskin = function() { var windowSkin = TAA.bm.Parameters.MenuListWindow['Window Skin']; TAA.log(2, "Window Skin: " + windowSkin); this._windowskin = ImageManager.loadSystem(windowSkin); };
Of course, this means that the window skin specified in BookMenu's parameters will now be ignored.
spec3

#147 Jun 21, 2020, 03:10 AM Source
Solar_Flare said:
It's because BookMenu overrides the function that Hime uses to set the windowskin on a window. If you always want the same window skin for the book window, you can just set it in the BookMenu plugin parameters. If you want to be able to swap window skins on the fly with Hime's functions, you can just find this function in BookMenu and delete it:

JavaScript:
Window_BookList.prototype.loadWindowskin = function() { var windowSkin = TAA.bm.Parameters.MenuListWindow['Window Skin']; TAA.log(2, "Window Skin: " + windowSkin); this._windowskin = ImageManager.loadSystem(windowSkin); };
Of course, this means that the window skin specified in BookMenu's parameters will now be ignored.
As soon as possible I will test it out. Thank you, Solar_Flare!

edit:

So, I put // before the lines in Window_BookList.prototype.loadWindowskin, Window_BookTitle.prototype.loadWindowskin and Window_BookText.prototype.loadWindowskin and their functions and it works like a charm.
Thanks again, Solar_Flare for the input and taaspider for the plugin! :LZSjoy:
kietemoi

#148 Sep 24, 2020, 06:39 PM Source

hello! thank you for such a great plugin!

I was wondering if it is possible to show variables in these books? I read that text code is supported but I tried to add a variable with " \v[0] " in the plugin manager but I received an error. The source is set to "Plugin Manager".

Would be great to be able to add variable information and show the players progress.
ThreeSixNine

#149 Sep 25, 2020, 06:45 AM Source

kietemoi said:
hello! thank you for such a great plugin!

I was wondering if it is possible to show variables in these books? I read that text code is supported but I tried to add a variable with " \v[0] " in the plugin manager but I received an error. The source is set to "Plugin Manager".

Would be great to be able to add variable information and show the players progress.
Try a variable other than zero
kietemoi

#150 Sep 25, 2020, 09:40 AM Source

xDRAGOONx said:
Try a variable other than zero

sorry that was a poor example, I didn't actually write zero - I had tried \v[5] \v[6] etc. but it gives me an error. I wonder if anyone else is able to write variables or if its just me that can't.
taaspider

#151 Sep 25, 2020, 01:29 PM Source

kietemoi said:
sorry that was a poor example, I didn't actually write zero - I had tried \v[5] \v[6] etc. but it gives me an error. I wonder if anyone else is able to write variables or if its just me that can't.

Can you print and send me the error you're getting?
I'm wrapping up a new version (1.5.0) and I just tested variable test codes in the demo project, and it works like a charm using both JSON files and Plugin Manager books:
kietemoi

#152 Sep 25, 2020, 01:50 PM Source

Hello!

The top row is with the variable and the bottom row is when I take the variable out. I also turned the plugins off that are causing the error but instead of an error showing up it removes the book menu completely if I have a variable written in, and then goes back to normal as soon as I take it out.
taaspider

#153 Sep 25, 2020, 02:57 PM Source

It seems to be some compatibility issue with Yanfly's plugins, since it works perfectly in my demo project.
I'll run some tests here and see if I can replicate the issue.

EDIT: @kietemoi , I wasn't able to reproduce the issue. However, the error you sent implies something has gone wrong with YEP_MainMenuManager. Can you send me how the book menu is configured in YEP_MainMenuManager (specially the show menu parameter, which seems to be the issue)?

Also, there's something wrong with you Plugin Manager Books parameter. The editor is not showing the structure option to visualize the parameter contents:

That usually means the parameter is not setup correctly. I suggest deleting everything, clicking "ok", then opening it up again and configuring the book again using the structure parameter view.
Solar_Flare

#154 Sep 26, 2020, 04:52 AM Source

It looks like @kietemoi is using a version of MV older than 1.5. If you want to use TAA_BookMenu, I would suggest either updating your MV to at least 1.5 (which as I recall is the version that improved the plugin manager) or use JSON files instead as your book source.

Just for the record, it will probably still work with what you have if you add an extra \, but it can't be fun editing those parameters without the structured editor...
kietemoi

#155 Sep 26, 2020, 10:28 AM Source

taaspider said:
It seems to be some compatibility issue with Yanfly's plugins, since it works perfectly in my demo project.
I'll run some tests here and see if I can replicate the issue.

EDIT: @kietemoi , I wasn't able to reproduce the issue. However, the error you sent implies something has gone wrong with YEP_MainMenuManager. Can you send me how the book menu is configured in YEP_MainMenuManager (specially the show menu parameter, which seems to be the issue)?

Also, there's something wrong with you Plugin Manager Books parameter. The editor is not showing the structure option to visualize the parameter contents:
View attachment 161824

That usually means the parameter is not setup correctly. I suggest deleting everything, clicking "ok", then opening it up again and configuring the book again using the structure parameter view.

sorry for the delay, I didn't update MV since the plugin was working with my older version (just not the variable issue). I just updated MV (1.6.2) to see if that is the root of the problem. But now I'm getting errors even with the demo project >.<. Could the issue be that previously my version was too old and now it is too new haha?

I'm going to see if I can bring my version down to 1.5.0 and see if everything works fine.

EDIT : I'm on V1.5.1 and I created a new project with just the BookMenu plugin. I haven't changed or added anything. No errors but the menu doesn't show up. I then tried to add a book to see if that was the reason why but same issue again. I then tried the "OpenBookMenu" plugin command and still no luck. I've tried so many different things that I'm not even sure what the problem is anymore >.<
taaspider

#156 Sep 26, 2020, 02:10 PM Source

The demo is running on 1.6.2 over here. As long as your version is at least 1.5.0, there shouldn't be compatibility issues.

Can you PM me a zip of your test project?
That way I can take a better look and see if I can find out what's happening.
Unfeant

#157 Sep 30, 2020, 10:38 PM Source

Hello, the plugin is very well incorporated into my game, however I can't make it show the categories anywhere.

I used MV.
taaspider

#158 Oct 1, 2020, 03:17 AM Source

Unfeant said:
Hello, the plugin is very well incorporated into my game, however I can't make it show the categories anywhere.

I used MV.

Check in the menu list parameters, there's one param to enable categories. I think it might disabled. That would explain the behavior you describe.
Unfeant

#159 Oct 1, 2020, 03:46 AM Source

Hola, pensé que podría solucionar el problema si empezaba un nuevo juego, sin embargo no funcionó, por el contrario el problema era peor.

Ahora ni siquiera muestra lo que escribo en las categorías y libros.

Capturas de pantalla adjuntas de mi configuración.
taaspider

#160 Oct 1, 2020, 11:26 AM Source

Unfeant said:
Hola, pensé que podría solucionar el problema si empezaba un nuevo juego, sin embargo no funcionó, por el contrario el problema era peor.

Ahora ni siquiera muestra lo que escribo en las categorías y libros.

Capturas de pantalla adjuntas de mi configuración.

I can see on your print that Show Categories is set to true now. What I think is happening is that Hide Unread Books is probably set to true (which is its default value).
You can change it to false (you can find this parameter inside the Menu List Window Config), or you can create an event and call the ReadBook or Learn plugin commands, which will mark the book as read.

Also, I think it would be a good idea for you to take a look at the demo project. It may help you understand better how to work with the plugin.