In-Game Manual

[atreyoray]

In-Game Manual
by Atreyo Ray​

Introduction
Allows you to create a scene that works like an in-game manual, and reads its contents from a text file.

Features
- You can create multiple manuals. (*new*)
- You can show and hide entries using plugin commands. (*new*)
- Offers LOADS of visual customization.
- Setup difficulty varies from easy to medium-hard, depending on the amount of customization you plan to use.
- You can change the background.
- You can load it with a simple Script or Plugin Command, or include it in the Main Menu.
- There are 3 windows in the Scene:

Spoiler

* Entry List Window:

- Lists current manual entries.
- You can set subentries for each entry, so that when you press OK or click the entry, it will show its subentries instead.
- You can use individual icons for each entry.
- You can set the font (including size, color, and outline color).
- You can set its position (left or right).
- You can set its width.
- You can change its windowskin.

* Navigation Window:

- Shows you how far you are in the manuals entries chain (along with listing previous ones).
- You can set the color of the current entry.
- You can set the color of the previous entries.
- You can set the separator to whatever you prefer.
- You can set the font (including size and outline color).
- You can change its position (top or bottom).
- You can disable (hide) it.
- You can change its windowskin.

* Details Window:

- Shows the title of the entry (may be different from the name of the entry).
- You can change the title's font (including size, italic, color, and outline color).
- Shows a gradient line below the title that covers 2/3 of the Details Window.
- You can change the colors of this line.
- Shows an information text telling the user if there are subentries to this entry.
- You can change this information text.
- You can change this information text position (center, left, or right).
- You can chance this information text font (including size, color, and outline color).
- Shows a picture set to the entry.
- You can change this picture position (center, left, or right).
- You can have the details text be shown over the image or after it.
- Shows the details text set to the entry.
- You can include escape characters to the text (\c[1] or \i[30], for example).
- You can set the details text font (including size and outline color).
- You can change this window skin.

Screenshots
Standard Game Manual on a 1280x720 resolution:

Fully customized:

Spoiler

An example of an entry in the text file:

That can be shown like this:

How to Use
Please dowload and read the tutorial to learn how to create your in-game manual:
Dropbox or attached to this post.

To learn how to install a plugin: https://youtu.be/ym_qA6hO5d0 (by Yanfly)
To have an idea on how to make a custom background (if you want to use one), watch this video by Echo607 https://youtu.be/2MGzdXs9pzk
Any other instruction can be found in the help of the plugin.

Download
Dropbox
or attached to this post.

FAQ
Q: Can you implement *what I want or add a functionality*?
A: Well, if it's something that might be of interest to a number of other people, AND is still on the purpose of the plugin, AND it's easy to implement (i.e. takes little time to do) I MIGHT do it.
Otherwise, you're free to try modifying the code to suit your needs (or ask someone else to do so). Anyway, asking for it never hurts.

Q: Can I use this plugin for anything else that is not a manual?
A: Yes, of course!

Q: There's something wrong with my manual/I'm getting an error. What should I do?
A: Unless you've found a bug, there's a very high chance that the problem is with your Manual.txt file. Please send me a copy of it so I can check it for you.

Credit
- Please credit me (Atreyo Ray) for this plugin.
- You're free to use it on free or commercial games.

Author's Notes
- You're free to modify this plugin or improve it.
- The "handwriting" font that appears on some the screenshots is called Parisienne (under SIL OPEN FONT LICENSE at Google Fonts).
- Please tell me if you have any questions.

Change log

Spoiler

v1.00 - First release (Nov, 27, 2015)
v1.10 - (Dec, 02, 2015)
- You don't need to write down tags you'll not use in an entry.
- You can now indent comments (#) in your manual data file.
- You can now create multiple manuals.
- You can now hide and show entries using Plugin Commands.
- A detailed illustrated tutorial now comes with the plugin.
- Removed 'Manual Name' parameter.
- Added 'Manual Names' parameter.
- Changed how 'Show in Menu' parameter works.

ARP_InGameManual.zip

 

[SweetieAshe]

I can respect that something like this wouldn't be dynamic since it's reading from a .txt file, but I don't think it's out of the scope of the plug-in to want it to be dynamic? I'm thinking like... if you don't want certain game systems to be in the manual right from the start of the game, but to add them as the tutorials show up. Like if you had a class change system or a skill learning system that the player doesn't have access to until later in the game.

But still definitely a nice plug-in for those who have everything unlocked from the start of the game.

 

[Myst Desdemona]

I second what SweetieAshe said. It would be great if it can show things after they happen. For example, if we have a poison debuff and its entry is in the manual, it would be great to be able to show it there after they player actually gets hit by it.

Other than that, it's a very nice plug-in.

 

[atreyoray]

I can respect that something like this wouldn't be dynamic since it's reading from a .txt file, but I don't think it's out of the scope of the plug-in to want it to be dynamic? I'm thinking like... if you don't want certain game systems to be in the manual right from the start of the game, but to add them as the tutorials show up. Like if you had a class change system or a skill learning system that the player doesn't have access to until later in the game.


But still definitely a nice plug-in for those who have everything unlocked from the start of the game.

Yea, I thought about it while I was thinking about the concept of the plugin before creating it. I considered the dynamic option (it's kind of easy to implement), but since I was making this one for my project, I also considered that I had a lot of entries to use in the manual (mine's around 90). So it was clear to me that making something not dynamic was going to be easier.
You can kind of avoid this issue simply by making tutorials in your game when systems become available, which is what I'm doing. I mean, the manual will be there since the begining, but not all the systems will.


Also, as I stated before, anyone is free to modify the code to suit his or her need.

 

[Heartbreak61]

I third what SweetieAshe said.

Please atreyoray, give an option to make this dynamic  BD

 

[Roguedeus]

Before I go diving into isolating whats causing this, I just want to make sure... (As there is no functional example or demo)

This entry should work correct?

 <name> NAME <title> TITLE <subentries> SUBENTRY <text> Stuff here... <end entry>

 

[atreyoray]

Please atreyoray, give an option to make this dynamic BD

You sadists, you... like to make me suffer...
Alright already... I promisse to think about it and give you an answer later. *sigh*

 

[atreyoray]

Before I go diving into isolating whats causing this, I just want to make sure... (As there is no functional example or demo)

This entry should work correct?

<name> NAME <title> TITLE <subentries> SUBENTRY <text> Stuff here... <end entry>

Hey, Roguedeus. Thanks for asking!

As I've stated in the help:

** Optional tags are still required to be written, but you may leave their

values with nothing.

So, to make sure it'll work use it like this:

<name> NAME <icon> <title> TITLE <picture> <subentries> SUBENTRY <text> Stuff here... <end entry>Also, I'll have it fixed in the next version, but I guess as it is right now you have to write those tags without any whitespace BEFORE them (I forgot to check if it works).I know that there's a lot to read on the help, so ask away if you have any questions!

 

[Sol Rising]

This is a great plugin for any game! I 4th what sweetie Ashe said

 

[atreyoray]

Ok, so I thought about a way to turn it dynamic optionally.


There will be an option to add entries by script or plugin commands. Would you also like an option to remove entries?


So, as far as I'm concerned, to the next version:


* Allow dynamic manuals


* Allow tags indentation in the entries file.


* Allow optional tags not to be required to be written.


* When you press OK or select an entry with no subentries, it should make no sound.


Anything else?


@Roguedeus: please tell me if you could fix the issue you were having!

 

[DavidFoxfire]

I might be interested in using this as a sort of notebook, where the main character adds or deletes entries as he/she progresses through the game.  Does this script have that feature, or will it be implemented soon (by either you or another editor?)

 

[atreyoray]

I might be interested in using this as a sort of notebook, where the main character adds or deletes entries as he/she progresses through the game.  Does this script have that feature, or will it be implemented soon (by either you or another editor?)

Though not part of the first concept, I'll have it implemented to the next version. Hopefully it will be ready in the next 4 days or so.

 

[Roguedeus]

Sorry for the delay. I had to do something else for a while...

I am currently using this.

<name>NAME <icon> <title>TITLE <picture> <subentries>SUBENTRY <text> Stuff here... <end entry>I've double checked the parameters pointing to the file and the file name. Even the encoding. All good.

And I am still getting a blank Manual.

I will being isolating the plugins.

 

[Helyx]

Thanks for this plugin !!

Is it possible to duplicate it?

I'll like to have one as an in game manual, and the other one as a diary ?

 

[Helyx]

Thanks for this plugin !!

Is it possible to duplicate it?

I'll like to have one as an in game manual, and the other one as a diary ?

 

[Roguedeus]

Here is a screen shot of the setup... As proof.

I can't see what I am doing wrong.

edit:

I was told once by another plugin author that one of the reasons the plugin didn't work for me was they had not considered file locations with spaces in their names and they didn't know how to get around it yet... Might that be the issue? Because from what I am looking at. I shouldn't be having this problem.

 

[atreyoray]

And I am still getting a blank Manual.

I guess you forgot to use the <main entries> tag in your file? (it's step 3 in the help)

Thanks for this plugin !!


Is it possible to duplicate it?


I'll like to have one as an in game manual, and the other one as a diary ?

As it is right now you can't duplicate your manual, Helyx. This requires more work to be implemented. Maybe if you ask another person to do it for you (you're free to modify the plugin).

 

[Roguedeus]

I guess you forgot to use the <main entries> tag in your file? (it's step 3 in the help)

That did the trick. I appreciate your patience with this.

Would you be willing to add a sample Manual.txt to your zip? That way idiots like me can start at a sprint? It may also save you the frustration of repeating yourself in answering our stupid questions.

 

[atreyoray]

That did the trick. I appreciate your patience with this.


Would you be willing to add a sample Manual.txt to your zip? That way idiots like me can start at a sprint? It may also save you the frustration of repeating yourself in answering our stupid questions.

Don't think of your questions (or of yourself) as lowly as that! =D
I'm thinking of including an illustrated step by step tutorial or video along with the next version (and a sample Manual.txt file).

 

[JohnnyR]

So, to make sure it'll work use it like this:

<name> NAME <icon> <title> TITLE <picture> <subentries> SUBENTRY <text> Stuff here... <end entry>I know that there's a lot to read on the help, so ask away if you have any questions!

Well, I have a question, what "exactly" are these subentries and how should one define them. I mean, should I copy the default stuff below it? Like this:

<main entries> Basic Controls; <name> Basic Controls <icon> 83 <title> Basic Controls <picture> <subentries> This; <name> This <icon> 83 <title> That <picture> <subentries> <text> Nothing to see here... <end entry> <text> Stuff here... <end entry>Or maybe there's another way? I didn't really get it.. Since just typing something at subentries right now, makes it possible to "click" on the current entry I'm on, but it causes a bug that says "cannot read property 'icon' of null", so I assume there's more configuration needed to make it work?