In-Game Manual

Roguedeus

It's never too late to procrastinate...
Veteran
Joined
Mar 19, 2013
Messages
527
Reaction score
106
First Language
English
Primarily Uses
N/A
No worries. It was my fault I didn't take more time reading your instructions. I was juggling it, and two other new plugins, as well as prepping lunch. So my impatience a (and subsequent stupidity) was a total waste of my time and yours. :D I'll do my best not to repeat it.

By the way. I love this plugin. It will make my overly complex mechanics a little easier for new players to grasp; having an in game reference.
 

atreyoray

Veteran
Veteran
Joined
Mar 16, 2013
Messages
38
Reaction score
87
First Language
Portuguese
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 ?
I was thinking about it, and while I have no intention of making a way to duplicate the manual, I've thought of a clunky way to get around it.
First, you create your manual with only two main entries (one called Manual, and the other Diary). Also, name your manual to something like Game Info.


This way, when a player need to access any of those, they'd go do Game Info and you'd have both there.


Make your Game Manual entries subentries to the Manual entry, and likewise, subentries to the Diary entry.


When I release the next version, you'll be able to add or remove your Diary and Manual entries during gameplay.


It's not the best of answers, but I hope it helps.
 

atreyoray

Veteran
Veteran
Joined
Mar 16, 2013
Messages
38
Reaction score
87
First Language
Portuguese
No worries. It was my fault I didn't take more time reading your instructions. I was juggling it, and two other new plugins, as well as prepping lunch. So my impatience a (and subsequent stupidity) was a total waste of my time and yours. :D I'll do my best not to repeat it.


By the way. I love this plugin. It will make my overly complex mechanics a little easier for new players to grasp; having an in game reference.
Nice! I'm looking forward to seeing your game! (I'm a sucker for overly complex games XD)
 

atreyoray

Veteran
Veteran
Joined
Mar 16, 2013
Messages
38
Reaction score
87
First Language
Portuguese
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:

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?
Hey JohnnyR! Thanks for asking!

You just have to type the name of the subentries (they should be exactly as they are declared in their respective entry).

If you're getting a "cannot read property 'icon' of null", press F8 before you close your game to open the console. If there's a line stating 'Error trying to read current entries. Manual entry not found: ', then it's probably because you've typed a subentry name that does not exist, or forgot to separate them with a semicolon ( ; ), or didn't use capital letters accordingly, or forgot to place a tag for <icon> even if you're not using one in your subentry.

That last case will be solved in the next version, btw.

Try checking that out and please let me know what happens.

PS.: I remember thinking about it while I was implementing the code, but can you also try to remove the last semicolon in the subentries? And, for this version, do not indent or use blank spaces before each tag.

Edit: I forgot to answer you question:

what "exactly" are these subentries and how should one define them.
Imagine you have an entry in your manual called Characters. When you have it selected, it will show a brief of the main characters of your game.

Now, let's say this entry has as subentries an entry for each of your main characters and antagonists.

So, basically, when you press the confirm button on 'Characters' it'll clean your entry list window and then show you an entry list with your main characters and antagonists (that is, 'Characters' subentries), also, your Navigation window will be shown like this: Game Manual > Characters

It seems confusing, but I promise it's not XD - I'll make sure to make it clear on the tutorial.
 
Last edited by a moderator:

Heartbreak61

Wandering Noob
Veteran
Joined
Sep 5, 2012
Messages
188
Reaction score
88
First Language
Indonesian
Primarily Uses
RMMV
You sadists, you... like to make me suffer...

Alright already... I promisse to think about it and give you an answer later. *sigh*
Nice!

*hugs*

EDIT:

so far, I managed to show this

<main entries> This<name> This<icon> 84<title> Just This<picture><subentries> Foo<text>A single line text<end entry>
But when I choose "This", it throw me an error about "Manual entry not found: Foo"

Then I try

<main entries> This<name> This<icon> 84<title> Just This<picture><subentries> Foo<name> Foo<icon> 85<title> Just Foo<picture><text>Another text<end entry><text>A single line text<end entry>
It suddenly throw me an error about "Manual entry not found: This"

I'm a bit confused about subentry and how I should wrap my text with <end entry>. From my point of view, I should consider subentries as a child from main entries, hence I should wrap every single of them with <end entry> but seems that it doesn't work that way.

Suggestion:

1. Include an example, or

2. Change it to JSON syntax, which I believe many user will get familiar with, even beginner one.

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 ?
That was my intention from the beginning, to make a diary. I'll help you with this once atreyoray make this dynamic  :guffaw:  

don't tell atreyoray about my real intention  :p  
@Helyx & @atreyoray

Oh God, just wait until Shaz or other moderator warn you about double posting  :guffaw:
 
Last edited by a moderator:

atreyoray

Veteran
Veteran
Joined
Mar 16, 2013
Messages
38
Reaction score
87
First Language
Portuguese
@Heartbreak61: Your manual text file should look like this:

<main entries> This<name> This<icon> 84<title> Just This<picture><subentries> Foo<text>A single line text<end entry><name> Foo<icon> 85<title> Just Foo<picture><subentries><text>Another text<end entry>Entries are supposed to be separated from each other. Thanks for showing that. ;)   I'll include it in the tutorial.
I've tried making it JSON at first, but then it forces the user to write the text in a single line, which I don't really want here >.<
 
 
Last edited by a moderator:

Heartbreak61

Wandering Noob
Veteran
Joined
Sep 5, 2012
Messages
188
Reaction score
88
First Language
Indonesian
Primarily Uses
RMMV
@Heartbreak61: Your manual text file should look like this:

<main entries> This<name> This<icon> 84<title> Just This<picture><subentries> Foo<text>A single line text<end entry><name> Foo<icon> 85<title> Just Foo<picture><subentries><text>Another text<end entry>Entries are supposed to be separated from each other. Thanks for showing that. ;)   I'll include it in the tutorial.

I've tried making it JSON at first, but then it forces the user to write the text in a single line, which I don't really want here >.<
{"Foo":

{"name": "Just Foo",

"text": ["First line",

Second line"]

}

}

Maybe it could be done exactly by reversing how you do line split.

Foo.text.join('\n');

BD
 

atreyoray

Veteran
Veteran
Joined
Mar 16, 2013
Messages
38
Reaction score
87
First Language
Portuguese
{"Foo":

{"name": "Just Foo",

"text": ["First line",

Second line"]

}

}

Maybe it could be done exactly by reversing how you do line split.

Foo.text.join('\n');

BD
Yea... but then I'd have to include information on how to write JSON files, which is ok for most of us, but not for the people who don't know how to program.

I mean, it looks complicated the way I made with tags, but that's because I haven't included an example or tutorial. I wanted to see people's first impressions and common mistakes before writing one.

I promise I'll make it real simple ;)
 

JohnnyR

Dungeon Master
Restaff
Joined
Mar 27, 2013
Messages
275
Reaction score
135
First Language
English
Primarily Uses
RMMV
It seems confusing, but I promise it's not XD - I'll make sure to make it clear on the tutorial.
Suuuuure.... :D

Anyway, Heartbreak61 accidentally answered my question. lol

What I wanted to know was how to make the subentries, but seeing what he did made me think on how stupid the mistake was.. lol (I mean, I could have tried to add a new entry and just call it as a sub entry. Duh, obviously. :p )

Also, I did what you asked. In fact, I was doing it already, like, I totally forgot to use the semicolon at the end of the subentries, and no problems appeared. Oh, and I AM using a blank space before each tag and no problems either. Lucky me, I guess. 

Btw, I totally forgot to say, but awesome script! Keep up the good work! :)
 

atreyoray

Veteran
Veteran
Joined
Mar 16, 2013
Messages
38
Reaction score
87
First Language
Portuguese
Oh, and I AM using a blank space before each tag and no problems either. Lucky me, I guess.
Thank you for reporting on this! I guess this is because of how regular expresions work. I'm using them to read the tags. I'll never master regex... really ;_;
 

atreyoray

Veteran
Veteran
Joined
Mar 16, 2013
Messages
38
Reaction score
87
First Language
Portuguese
So... I guess I'm not double posting (since 72hrs have already passed? Haven't they? O_O)

Updated to version 1.10!

New Features:
- 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.
(Now you'd better make those dynamic manuals or I'll have your heads on a stick! D:< Just kidding. They'll be served on a plate :p )
- A detailed illustrated tutorial now comes with the plugin. Get it here.

For those updating from the previous version:
- Removed 'Manual Name' parameter.
- Added 'Manual Names' parameter.
- Changed how 'Show in Menu' parameter works.

So make sure you reconfigure those parameters!
 

Chrispy

Veteran
Veteran
Joined
Oct 24, 2015
Messages
64
Reaction score
44
First Language
English
I told myself for weeks that I will write my own scripts for my game. But you know what...screw that! This is at least three times as awesome as the in-game journal I was halfway through writing.

Nice work, I will definitely be using this!
 

atreyoray

Veteran
Veteran
Joined
Mar 16, 2013
Messages
38
Reaction score
87
First Language
Portuguese
I told myself for weeks that I will write my own scripts for my game. But you know what...screw that! This is at least three times as awesome as the in-game journal I was halfway through writing.

Nice work, I will definitely be using this!
Thank you, Chrispy. But let me propose you a better idea. Instead of letting my plugin (or any other) hinder the creation of your own plugins, let it serve you as a motivation to make your own. And then, when you feel confident enough, maybe you could share some of them here in the Maker Community.

I mean, the greatest thing about RPG Maker is its sharing capacity. You don't need to make complex things, and I'm sure people will love it. BD :rock-right:
 

Ghost of Christmas Kloe

Ghost of a Princess Seagull
Veteran
Joined
Nov 15, 2015
Messages
1,504
Reaction score
913
First Language
English
Primarily Uses
N/A
Yay!!! Thank you!!

EDIT: Urgh... I wish I could get this to work... I've been lookingthrought the manual copying code, trying, trying again and I still cant get it working...  :(  

Also I got an error but it may just be my own stupidity... 

TypeError: Cannot read property 'length' of undefinedat Window_ManualEntryDetails.refresh (ARP_InGameManual.js:579)
at Window_ManualEntryDetails.setDetails (ARP_InGameManual.js:542)
at Window_ManualEntryDetails.setEntry (ARP_InGameManual.js:552)
at Scene_GameManual.update (ARP_InGameManual.js:827)
at Function.SceneManager.updateScene (rpg_managers.js:1673)
at Function.SceneManager.updateMain (YEP_CoreEngine.js:808)
at Function.SceneManager.update (YEP_CoreEngine.js:797)
 
Last edited by a moderator:

Jrrkein

Insert Witty Title Here
Veteran
Joined
Apr 20, 2014
Messages
131
Reaction score
17
First Language
Indonesia
Primarily Uses
RMMV
I wish I can scroll the window on the right, because there no option to scroll
 

DangDut

Narratell Studios
Veteran
Joined
Jun 1, 2015
Messages
37
Reaction score
6
First Language
Indonesian
Primarily Uses
I try to change some parameters, but it seem it not used. I keep get the default ones.
 

atreyoray

Veteran
Veteran
Joined
Mar 16, 2013
Messages
38
Reaction score
87
First Language
Portuguese
Yay!!! Thank you!!

EDIT: Urgh... I wish I could get this to work... I've been lookingthrought the manual copying code, trying, trying again and I still cant get it working...  :(  

Also I got an error but it may just be my own stupidity... 

TypeError: Cannot read property 'length' of undefinedat Window_ManualEntryDetails.refresh (ARP_InGameManual.js:579)

at Window_ManualEntryDetails.setDetails (ARP_InGameManual.js:542)

at Window_ManualEntryDetails.setEntry (ARP_InGameManual.js:552)

at Scene_GameManual.update (ARP_InGameManual.js:827)

at Function.SceneManager.updateScene (rpg_managers.js:1673)

at Function.SceneManager.updateMain (YEP_CoreEngine.js:808)

at Function.SceneManager.update (YEP_CoreEngine.js:797)
It seems like it's trying to read an undeclared entry.

Could I take a look at your manual.txt? (If so, please send it on a personal message)

I wish I can scroll the window on the right, because there no option to scroll
I'm sorry about it, but unless there's another person writing a code for scrollable windows, I don't plan to use it here.

For now, if the contents details are larger then the size of your window, split them across two or more entries. Just make sure you name them differently.

I try to change some parameters, but it seem it not used. I keep get the default ones.
Could you please give more details, like which parameters are you trying to change, and to which values?
 
Last edited by a moderator:

Ghost of Christmas Kloe

Ghost of a Princess Seagull
Veteran
Joined
Nov 15, 2015
Messages
1,504
Reaction score
913
First Language
English
Primarily Uses
N/A
It seems like it's trying to read an undeclared entry.

Could I take a look at your manual.txt? (If so, please send it on a personal message)
I sorta deleted it and tried again and got it to work without errors, but thanks for... um... being happy to help? I guess! Just thank you for this awesome plugin?!  BD
 

SilverDash

Veteran
Veteran
Joined
Oct 11, 2015
Messages
395
Reaction score
156
First Language
Dutch
Primarily Uses
RMMV
This is so handy.
 

atreyoray

Veteran
Veteran
Joined
Mar 16, 2013
Messages
38
Reaction score
87
First Language
Portuguese
I sorta deleted it and tried again and got it to work without errors, but thanks for... um... being happy to help? I guess! Just thank you for this awesome plugin?!  BD
I'm always glad to help people willing to use any of my plugins :D

Good to know you got it fixed up.
 

Users Who Are Viewing This Thread (Users: 0, Guests: 3)

Latest Threads

Latest Posts

Latest Profile Posts

Is the "2 status updates per 24h" still in effect?
My first attempt at Pixel Art :blink::) (I have no idea what I'm doing but I'm doing it)
Plugin instructions: *exists*
Plugin: What did he say? *error*
I feel like it's about time I share all the result of my experiment project here. But there's a lot of it.
Me and brother have an ongoing rivalry. We constantly fight for the High Score in Galaga on our arcade cabinet. Today I take back the top with 239,000. He'll be back. (No-Fire glitch is banned)

Forum statistics

Threads
93,724
Messages
914,938
Members
123,330
Latest member
Rikuto
Top