InfoGuide
InfoGuide
Version: 2.4
If you would like to see this in action, logon to our Minecraft server at: minesrv.almuramc.com
Overview
InfoGuide is designed to be a resource for players to go to find information about about the particular server that they are playing on. Instead of having to go back and forth between the website or looking at the Wiki's for plugin command line information, Server Administrators can use this plugin and post that crucial information into Guides that players can look at when ever they need information.
This plug allows an administrator to Add/Edit/Delete guides in real-time without having to stop/start the server to push new information out to all of your users. Server Administrators also have the ability to cut and copy information directly in the .yml files that this plugin creates for its guides.
Spoutcraft & SpoutPlugin
Get Spoutcraft & Spoutplugin Now! >> Get Spout!
How to Use?
Currently once you install the InfoGuide plugin into your servers plugin directory it will automatically appear when a user logs in. If they close it and wish to see it later you can press F12 to view the guides. This option is configurable in the Spoutcraft/client Controls > Keybind section.
Now With Color Support!!. You can use the color codes in the text fields by using #4 Red. It will accept all the possible color & formatting codes.
Commands:
With the release of version 2.4 we added the ability to call up a specific guide via a command. Example:
/InfoGuide Starter Guide for Newbies
This will open up the infoguide interface with the "Starter Guide for Newbies" being automatically loaded.
Text Formatting:
- BLACK = #0
- DARK_BLUE = #1
- DARK_GREEN = #2
- DARK_AQUA = #3
- DARK_RED = #4
- DARK_PURPLE = #5
- GOLD = #6
- GRAY = #7
- DARK_GRAY = #8
- BLUE = #9
- GREEN = #a
- AQUA = #b
- RED = #c
- LIGHT_PURPLE = #d
- YELLOW = #e
- WHITE = #f
- MAGIC Random Code = #k
- BOLD = #l
- STRIKETHROUGH = #m
- UNDERLINE = #n
- ITALIC = #o
- RESET to Default = #r
Configuration
File: config.yml Options:
- PromptTitle: (Name of your Server?)
- TitleX: (numeric value used to help center your title in the guide window)
- DisplayOnLogin: (Enable or Disable Display on Login Feature)
- Hot_Key: (Configurable Default HotKey to assign to InfoGuide, is changeable client side afterwards in Controls.)
- GUITexture: Set your Custom Texture here or use my default.
- DefaultGuide: (Specify the name of the guide you would like to load first)
- GuestGuide: Specific Guide based on InfoGuide.GuestGuide permission
- MemberGuide: Specific Guide based on InfoGuide.MemberGuide permission
- SuperMemberGuide: Specific Guide based on InfoGuide.SuperMemberGuide permission
- ModeratorGuide: Specific Guide based on InfoGuide.ModeratorGuide permission
File: users.yml
- This is the configuration file we use when you allow users to bypass the InfoGuide screen when they login. Look down further for information regarding permissions nodes.
File: guides.yml (filename is dynamic based on Guide Title) Options:
- Name: (Name Displayed in Title & Drop Down Menu)
- Date: (Date Stamp the last time the guide was modified)
- Nr1: (stores guide information, now with unlimited number of pages)
Permissions
Here's a list of specific permissions nodes for this plugin and what each does.
- infoguide.bypass = Allows the users to set the option to bypass the InfoGuide when they login.
- infoguide.bypassall = Allow admins to force users or groups to bypass the InfoGuide at Login.
- infoguide.edit = Allows the user to make changes to a guide.
- infoguide.create = Allows the user to create new guides.
- infoguide.delete = Allows the user to delete current guides.
- infoguide.admin = Allows a users to do all of the above, also overrides any InfoGuide.hide permission..
- infoguide.view = Allows users to view all guides [Can View All Guides]
- infoguide.view.[guidenamehere] = Allows User to specifically see this guide, also overrides a InfoGuide.hide permission.
- infoguide.hide.[guidenamehere] = Hides this specific guide from specific groups/users.
- infoguide.guestguide = Pre-sets the config.yml default guide.
- infoguide.memberguide = Pre-sets the config.yml default guide.
- infoguide.supermemberguide = Pre-sets the config.yml default guide.
- infoguide.moderatorguide = Pre-sets the config.yml default guide.
Support
Support for this and all other AlmuraDev plugins can be found by joining our chat channel here:
@Schlumpf9
Im aware of this issue, trying to figure out how to write a work around.
@dockter
Hello, I have a little problem with Spoutcraft -.-
When I want to add a color and I press # the guide is closing and the chat window opens with a / in the Chat. The problem by this is that I cant find a key binding for # in the spoutcraft shortcuts... So I can't add colors to the guide, because everytime I press # the guide closes and the Chat opens and after this I can't reopen InfoGuide with f12 again, then just nothing works anymore till I reconnect ?!
Any idea how I can fix that and find the key binding on #?
Added Color Support!!
<<reply 756602="">>
Fixed in version 1.5
@dockter
In my config i have "DisplayOnLogin" : false but the player on login see the guide...
<<reply 752679="">>
Um, no. Vault is an economy API, where as spoutplugin/craft is a client/server mod & plugin.
They are completely different subsystems.
Do you think vault would make this work without spout?
<<reply 752319="">>
Yeah, its listed above as a dependency.
You should really have put Dependency: Spoutcraft. Without that, I thought Spoutcraft just provided the key binding feature.
<<reply 735697="">>
An update is coming soon that will fixed all those resolutions issues.
I'll also clearly define the permissions system.
I'm writing some guides, and I notice some issues / not implemented features:
There's not scroll (not a problem with high resolution like 1920x1200)
Text is left-aligned, not stretch to all width
Some letters are mis-displayed, often if they are on right side of text
Text is limited to 20 lines.
Can you explain read/write permissions per guide?
Thanks!
Ok, figured out a bug. When you grab the guides in the guides file, you grab everything, including dot files. This is bad if you are using SVN which creates a .svn file. Basically, it core dumps the server sometimes, or at least kills the plugin.
Can you filter out dot files for future releases? Cheers.
<<reply 691661="">>
This needs to be done on the SpoutAPI end, I have requested it and been told it coming.
Hey, great work on this plugin.... could you possibly, in a later update, add scroll bars? Some of the text in my guides like goes off the gui thing.
it didn't create a folder with the config and stuff ._.
@dockter
Thanks!
InfoGuide 1.3 seems work fine, server start without errors.
@FRLanc
Im not sure I can, this may be a minecraft limitation introduced in 1.2 from what I have been reading. If you know more about this please send me a link.
@cwingrav
It self-corrupted. I deleted the InfoGuide directory and rebooted. Things worked well. Don't know what fixed. I copied back the guides and all was well. Sorry I can't be more specific.
Regarding versions: I was using 1.2, updated to 1.3. Still no fix so I did the operations above.
Great plugin btw! This was what I was looking for.
Add cyrillic support plz
@Vorahk
Feature Added to 1.3