[INACTIVE][INFO] Help 0.2: The smart /help menu [531]

Discussion in 'Inactive/Unsupported Plugins' started by tkelly, Feb 28, 2011.

Search this thread
Advanced search...
Page 4 of 9
     
  1. Offline

    tkelly

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Help v0.2
    Download Help v0.2
    Download Help (Static Jar)
    Help Source Code
    Suggest Features

    Help has support for both GroupManager and Permissions, so you can use either one. You can also use neither if you so choose. Help will not force you to any which one.

    What is Help?
    Help is a clean and advanced /help menu. Help separates "main" commands from secondary ones, allowing you to have a clean initial menu, but still able to dig down and get access to every possible command.

    It is also the first /help menu to take into account permissions; some commands simply aren't applicable to all users, so those commands should clearly not be visible to those users. Now, default users' help menus won't be cluttered with commands for admin tools they have no way of using.

    Scroll down for a preview, or see below for how to hook into Help :)

    Help Commands
    /help (#) : Shows the /help menu.
    /help [plugin] (#): Shows all the help entries for [plugin].
    /help plugins : Shows a list of all the plugins with Help entries.
    /help search [query] : Searches for [query] within it' entries.
    /help reload : Reloads the entries from ExtraHelp.yml.

    Plugin Support
    Help requires that plugins tell Help about the commands they use. This makes sure that the commands and permissions are accurate and precise (rather than trying to auto fetch commands). Because it's ridiculous to assume that all plugins will instantly jump up and support Help (we can dream can't we? :D), server admins can mimic this behavior by supplying...

    Custom ExtraHelp/
    In the Help.zip download, I include a Help/ folder with a sample extra helps inside the ExtraHelp folder. This shows you how you can add custom commands to the /help menu. I'll also cover how to do that here.

    Each command has a "name", this name is only for you, as Help doesn't care about it (they just need to be unique names). In the following example the names are 'versions', 'pluginversions', 'kick' and 'essentialswho'. Within these Nodes you need 3 things: command, description, and plugin. These should be self-explanatory. The two optional pieces are "main" and "permissions".

    If you specify a "main", you can choose whether or not the command is important enough to show up on the main /help menu; if you leave it blank or skip it, it will default to 'false'.

    If you specify a "visible", you can specify whether the command shows up at all. This is useful for overriding other plugins' built-in Help support (in case you don't want all the commands); if you leave it blank or skip it, it will default to 'true'.

    If you specify a "permissions", you can choose what is necessary for the user to see the command; and leaving it blank will allow all to see. So in the case of /version, all users can use it, so no permissions. But with /who, you have to have essentials.list, so that was specified. There is also a special permission case, "OP". By specifying this, this will require the user to be an OP to use the command (as is the case with Minecraft's built-in /kick command).
    Code:
    versions:
    command: version
    description: Show the version of Minecraft and CB
    plugin: CraftBukkit
    main: true
pluginversions:
    command: version [plugin]
    description: Shows the version of [plugin]
    plugin: CraftBukkit
kick:
    command: kick [player]
    description: Kicks [player] from the server
    plugin: Minecraft
    main: true
    permissions: OP
essentialswho:
    command: who
    description: Show who's one the server
    plugin: Essentials
    main: true
    permissions: essentials.list
    How To Hook into Help.
    Hooking into Help is extremely easy, and very similar to hooking into any permission-plugin. When your plugin is starting up, just grab the Help plugin and register your commands with Help's registerCommand() method; that's it! Here's the API and some examples. If you'd like a concrete example, check out the relevant source code from MyHome and BigBrother.

    Help API
    Code:
    /**
 * Registers the given command, description, and plugin.
 * There are no permissions, so all users can see it.
 * It is also not a "main" help entry.
 * @return Whether or not it was successful
 */
public boolean registerCommand(String command, String description, Plugin plugin);

/**
 * Registers the given command, description, and plugin.
 * There are no permissions, so all users can see it.
 * You can set whether the plugin is a "main" entry or not
 * @return Whether or not it was successful
 */
public boolean registerCommand(String command, String description, Plugin plugin, boolean main);

/**
 * Registers the given command, description, and plugin.
 * You can specify one or more permissions.
 * If a user has permissions for at least (1) of them, he can see this command
 * It is also not a "main" help entry.
 * @return Whether or not it was successful
 */
public boolean registerCommand(String command, String description, Plugin plugin, String... permissions);

/**
 * Registers the given command, description, and plugin.
 * You can specify one or more permissions.
 * If a user has permissions for at least (1) of them, he can see this command
 * You can set whether the plugin is a "main" entry or not
 * @return Whether or not it was successful
 */
public boolean registerCommand(String command, String description, Plugin plugin, boolean main, String... permissions);
    Basic Example
    Code:
    // plugin is the instance of your Plugin registering the commands
Plugin test = plugin.getServer().getPluginManager().getPlugin("Help");
if (test != null) {
    Logger log = Logger.getLogger("Minecraft");
    Help helpPlugin = ((Help) test);
    // Registers a main command. But all users will be able to see it
    helpPlugin.registerCommand("home help", "Help for all MyHome commands", plugin, true);
    // Registers a secondary command to our plugin (MyHome), but the user has to have the permission to see it
    helpPlugin.registerCommand("home", "Go home young chap!", plugin, "myhome.home.basic.home");
    log.log(Level.INFO, "'Help' support enabled.");
} else {
    Logger log = Logger.getLogger("Minecraft");
    log.log(Level.WARNING, "'Help' isn't detected. No /help support.");
}
    Slightly More Advanced Example
    Code:
    Help helpPlugin = ((Help) test);
String[] permissions = new String[]{"bb.admin.watch", "bb.admin.info", "bb.admin.rollback", "bb.admin.cleanse"};
// If a user has any one of those permissions, they'll be able to see /bb help. A main command
helpPlugin.registerCommand("bb help", "Help for all BigBrother commands", plugin, true, permissions);
// If a user has "bb.admin.watch" they'll be able to see /bb watch [player]. A secondary command
helpPlugin.registerCommand("bb watch [player]", "Toggle the watch on [player]", plugin, permissions[0]);
    Plugins with Help Support
    Here's a quick list of plugins (and version) that have built in Help support.
    - MyHome v1.9.2+
    - MyWarp v1.10.3+
    - BigBrother v1.6.4+
    - Citizens v1.0+
    - General 3.1+
    - TelePlus 1.6+
    - Pixl 1.3+
    - Vampire 1.3+

    ExtraHelp Packs
    FabianN put together a repository of entries for your ExtraHelp/ that represent other plugins' commands. It's really awesome and was helped put together by others from the community.

    Preview
    [IMG]
    [IMG]


    Changelog

    Help v0.2 [531]
    Released 15 Mar, 2011
    - Built with latest recommend build (531)
    - Multiline support. Descriptions of commands can now be as long as you'd like.
    - Separated ExtraHelp.yml into separate YML files (for each plugin, etc).
    - Plugin overriding. Don't like how a plugin has their Help support? Completely customize their entries.

    Help v0.1.1 [493]
    Released 6 Mar, 2011
    - Built with latest recommend build (493)
    - Updated for GroupManager 1.0

    Help v0.1 [440]
    Released 28 Feb, 2011
    - Intial Release
    tkelly, Feb 28, 2011
    #1
    Catscratch, John Paul, FrozenGhast and 11 others like this.
    2.  
  2. Offline

    Celtic Minstrel

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Post your GroupManager version?
    Celtic Minstrel, Mar 13, 2011
    #91
  3. Offline

    Metalcat

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Here's my ExtraHelp entries for Essentials, EssentialsSpawn, TPack, Magic Carpet, iConomy, iConomyChestShop, nSpleef and MoveCraft. Feel free to copy and paste them to your ExtraHelp.yml [IMG] (And also edit them if you want)
    Essentials:
    Code:
    who:
    command: who
    description: Show who's on the server
    plugin: Essentials
    main: true
    permissions: essentials.list
depth:
    command: depth
    description: Shows how deep down you are
    plugin: Essentials
    main: false
    permissions: essentials.depth
getpos:
    command: getpos
    description: Displays your current position
    plugin: Essentials
    main: false
    permissions: essentials.getpos
compass:
    command: compass
    description: Displays your current bearing in the world
    plugin: Essentials
    main: false
    permissions: essentials.compass
top:
    command: top
    description: Teleports you to the highest block
    plugin: Essentials
    main: false
    permissions: essentials.top
jump:
    command: jump
    description: You jump to the block you're looking at
    plugin: Essentials
    main: true
    permissions: essentials.jump
back:
    command: back
    description: Teleports you back after using a teleport command
    plugin: Essentials
    main: false
    permissions: essentials.back
world:
    command: world [worldname]
    description: Teleports you to [worldname]
    plugin: Essentials
    main: false
    permissions: essentials.world
msg:
    command: msg [player][message]
    description: Sends a message to [player]
    plugin: Essentials
    main: true
    permissions: essentials.msg
afk:
    command: afk [message]
    description: Shows you as afk
    plugin: Essentials
    main: true
    permissions: essentials.afk
rules:
    command: rules [page]
    description: Displays the rules on the server
    plugin: Essentials
    main: true
    permissions: essentials.rules
motd:
    command: motd
    description: Displays the message of the day
    plugin: Essentials
    main: true
    permissions: essentials.motd
me:
    command: me [emote message]
    description: Allows you to emote
    plugin: Essentials
    main: false
    permissions: essentials.me
mail:
    command: mail [player][message]
    description: Send and read mails or clear your inbox
    plugin: Essentials
    main: true
    permissions: essentials.mail.send
helpop:
    command: helpop [message]
    description: Requests help from online gods
    plugin: Essentials
    main: true
    permissions: essentials.helpop
whois:
    command: whois [nick|playername]
    description: Allows you to see who someone is
    plugin: Essentials
    main: false
    permissions: essentials.whois
essentials:
    command: essentials
    description: Reloads the Essentials configuration
    plugin: Essentials
    main: false
    permissions: essentials.essentials
rel:
    command: rel
    description: reloads all plugins
    plugin: Essentials
    main: false
    permissions: essentials.reloadall
gc:
    command: gc
    description: Displays chunk, memory, and world information
    plugin: Essentials
    main: false
    permissions: essentials.gc
plugin:
    command: plugin
    description: Allows you to enable, disable, or reload [plugin]
    plugin: Essentials
    main: false
    permissions: essentials.plugin
spawnmob:
    command: spawnmob [mob]
    description: Spawns [amount][mob]
    plugin: Essentials
    main: false
    permissions: essentials.spawnmob
clearinventory:
    command: clearinventory [player name]
    description: Clears the inventory
    plugin: Essentials
    main: false
    permissions: essentials.clearinvenory
broadcast:
    command: broadcast [message]
    description: Broadcasts a message to all players
    plugin: Essentials
    main: false
    permissions: essentials.broadcast
antioch:
    command: antioch
    description: B00m!
    plugin: Essentials
    main: false
    permissions: essentials.antioch
kill:
    command: kill [player]
    description: Kills [player]
    plugin: Essentials
    main: false
    permissions: essentials.kill
nick:
    command: nick [player][nickname|off]
    description: Give [player] the specified nickname or turn it off
    plugin: Essentials
    main: false
    permissions: essentials.nick
ping:
    command: ping
    description: Pong!
    plugin: Essentials
    main: false
    permissions: essentials.ping
give:
    command: Give [player][item][amount]
    description: give [player] the specified item
    plugin: Essentials
    main: false
    permissions: essentials.give
item:
    command: item [item][amount]
    description: Give yourself the specified item
    plugin: Essentials
    main: true
    permissions: essentials.item
kit:
    command: kit [kit name]
    description: Gives you a kit
    plugin: Essentials
    main: false
    permissions: essentials.kit
time:
    command: time [day|night]
    description: Changes the time to day/night
    plugin: Essentials
    main: true
    permissions: essentials.time
tree:
    command: tree [tree|birch|redwood]
    description: Spawns a tree
    plugin: Essentials
    main: false
    permissions: essentials.tree
bigtree:
    command: bigtree [tree|redwood]
    description: Spawns a big tree
    plugin: Essentials
    main: false
    permissions: essentials.bigtree
tptoggle:
    command: tptoggle
    description: Toggles the teleport ability
    plugin: Essentials
    main: false
    permissions: essentials.tptoggle
tpa:
    command: tpa [player]
    description: Asks [player] to teleport to him/her
    plugin: Essentials
    main: false
    permissions: essentials.tpa
tp:
    command: tp [player]
    description: Teleports you to [player]
    plugin: Essentials
    main: false
    permissions: essentials.tp
tpo:
    command: tpo [player]
    description: WIll teleport you to [player]
    plugin: Essentials
    main: false
    permissions: essentials.tpo
tpahere:
    command: tpahere [player]
    description: Asks [player] to teleport to you
    plugin: Essentials
    main: false
    permissions: essentials.tpahere
tphere:
    command: tphere [player]
    description: Teleports [player] to you
    plugin: Essentials
    main: false
    permissions: essentials.tphere
tpohere:
    command: tpohere [player]
    description: Ignores tptoggle and teleports [player] to you
    plugin: Essentials
    main: false
    permissions: essentials.tpohere
tppos:
    command: tppos [cordinates]
    description: Teleports you to [cordinates]
    plugin: Essentials
    main: false
    permissions: essentials.tppos
home:
    command: home
    description: Teleports you to your home
    plugin: Essentials
    main: true
    permissions: essentials.home
sethome:
    command: Sethome
    description: Sets your home to your current position
    plugin: Essentials
    main: true
    permissions: essentials.sethome
warp:
    command: warp [warpname]
    description: Teleport to [warp]
    plugin: Essentials
    main: true
    permissions: essentials.warp
setwarp:
    command: setwarp [warpname]
    description: Sets a warp to your current position
    plugin: Essentials
    main: false
    permissions: essentials.setwarp
delwarp:
    command: delwarp [warpname]
    description: Deletes [warpname]
    plugin: Essentials
    main: false
    permissions: essentials.delwarp
ban:
    command: ban [player]
    description: Bans [player] from the server
    plugin: Essentials
    main: false
    permissions: essentials.ban
banip:
    command: banip [name|IP]
    description: Bans the [IP] from the server
    plugin: Essentials
    main: false
    permissions: essentials.banip
mute:
    command: mute [player]
    description: Mutes [player]
    plugin: Essentials
    main: false
    permissions: essentials.mute
kick:
    command: kick [player]
    description: Kicks [player] from the server
    plugin: Essentials
    main: false
    permissions: essentials.kick
burn:
    command: burn [player][seconds]
    description: Sets [player] on fire
    plugin: Essentials
    main: false
    permissions: essentials.burn
ext:
    command: ext [player]
    description: Extinguishes [player]
    plugin: Essentials
    main: false
    permissions: essentials.
kickall:
    command: kickall [reason]
    description: Kicks all player from the server
    plugin: Essentials
    main: false
    permissions: essentials.kickall
unban:
    command: unban [player]
    description: Unbans [player]
    plugin: Essentials
    main: false
    permissions: essentials.unban
unbanip:
    command: unbanip [player|IP]
    description: Unbans [IP]
    plugin: Essentials
    main: false
    permissions: essentials.unbanip
tjail:
    command: tjail [player][jailname]
    description: Sends [player] to [jailname]
    plugin: Essentials
    main: false
    permissions: essentials.togglejail
setjail:
    command: setjail [jailname]
    description: Sets a jail at your current position
    plugin: Essentials
    main: false
    permissions: essentials.setjail
    Essentials Spawn:
    Code:
    spawn:
    command: spawn
    description: Teleports you to the spawn
    plugin: EssentialsSpawn
    main: true
    permissions: essentials.spawn
setspawn:
    command: setspawn [group]
    description: Sets the spawn to your position
    plugin: EssentialsSpawn
    main: false
    permissions: essentials.setspawn
    TPack:
    Code:
    boomstick:
    command: boomstick
    description: Gives your stick incredible power!
    plugin: TPack
    main: true
    permissions: tpack.boomstick
cuboid:
    command: cuboid
    description: Toggles cuboid mode
    plugin: TPack
    main: true
    permissions: tpack.cuboid
cfill:
    command: cfill [block]
    description: Fills the selected area with [block]
    plugin: TPack
    main: false
    permissions: tpack.cuboid
cdel:
    command: cdel
    description: Deletes all blocks in the selected area
    plugin: TPack
    main: false
    permissions: tpack.cuboid
cselect:
    command: cselect [co 1][co 2]
    description: Selects the given cordinates
    plugin: TPack
    main: false
    permissions: tpack.cuboid
listcuboid:
    command: listcuboid
    description: Shows the cordinates of the two points
    plugin: TPack
    main: false
    permissions: tpack.cuboid
time?:
    command: time?
    description: Shows what time it is
    plugin: TPack
    main: false
.:
    command: .
    description: Spawns a shelter around you
    plugin: TPack
    main: false
    permissions: tpack.snap
    Magic Carpet:
    Code:
    mc:
    command: mc [size]
    description: Spawns a glass carpet under your feet
    plugin: MagicCarpet
    main: true
    permissions: magiccarpet.mc
    iConomy:
    Code:
    moneyhelp:
    command: money help
    description: Shows money commands
    plugin: iConomy
    main: true
    permissions: iConomy.*
    iConomyChestShop:
    Code:
    sell:
    command: sell
    description: Switches to sell mode
    plugin: iConomyChestShop
    main: true
    permission: iConomyChestShop.shop.sell
buy:
    command: buy
    description: Switches to buy mode
    plugin: iConomyChestShop
    main: true
    permission: iConomyChestShop.shop.sell
    nSpleef:
    Code:
    spleef define:
    command: spleef define [arena]
    description: Defines the selected arena
    plugin: nSpleef
    main: false
    permissions: nSpleef.admin
spleef game:
    command: spleef creategame [game][arena]
    description: Creates a game
    plugin: nSpleef
    main: false
    permissions: nSpleef.member
spleef delgame:
    command: spleef deletegame [game]
    description: Deletes [game]
    plugin: nSpleef
    main: false
    permissions: nSpleef.member
spleef join:
    command: spleef join [game]
    description: Joins [game]
    plugin: nSpleef
    main: false
    permissions: nSpleef.member
spleef leave:
    command: spleef leave
    description: Leaves the spleef game
    plugin: nSpleef
    main: false
    permissions: nSpleef.member
spleef list:
    command: spleef list
    description: Lists all arenas and games
    plugin: nSpleef
    main: false
    permissions: nSpleef.member
    MoveCraft:
    Code:
    craft:
    command: <craft>[command]
    description: Takes control over the [craft] you're on
    plugin: MoveCraft
    main: false
    permissions: movecraft.*
craftrelease:
    command: <craft> release
    description: Releases the controlled craft
    plugin: MoveCraft
    main: false
    permissions: movecraft.*
craftremote:
    command: <craft> remote
    description: Toggles the remote controller
    plugin: MoveCraft
    main: false
    permissions: movecraft.*
craftsize:
    command: <craft> size
    description: Shows the size of the craft
    plugin: MoveCraft
    main: false
    permissions: movecraft.*
crafttypes:
    command: movecraft types
    description: Shows the available crafts
    plugin: MoveCraft
    main: false
    permissions: movecraft.*
craftlist:
    command: movecraft list
    description: Lists all controlled crafts
    plugin: MoveCraft
    main: false
    permissions: movecraft.*
    Metalcat, Mar 13, 2011
    #92
  4. Offline

    kartman314

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Is there anyway to disable a plugin from providing its help information?

    I have General installed, but it is showing commands in /help General I dont use or need and I cant seem to overload/adjust it using ExtraHelp.yml
    kartman314, Mar 13, 2011
    #93
  5. Offline

    FabianN

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    FabianN, Mar 13, 2011
    #94
  6. Offline

    Paradox460

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    @Taeir I'm helping code it right into the plugin, so as commands get updated, the help files get updated too.

    @tkelly do the registerHelp calls need to be called directly via init, or can they be called outside, i.e. through a helper?

    The way worldedit's structure works is classes are annotated as a command, then registered as commands. Each annotation has data about the command, including descriptions, permissions, etc. The commands are registered through a class that is called on plugin init. If i put the call to register the help methods in the class that is called at init, it should percolate down, right?

    To make it simpler, here is what is called.

    Plugin load -- call -> WorldEdit.java (registers commands) -- call -> HelpHelper (loads commands).
    Paradox460, Mar 13, 2011
    #95
  7. Offline

    FabianN

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Question, pulling from the ExtraHelp.yml file, how does the plugin decide what order to list the help commands in?
    FabianN, Mar 13, 2011
    #96
  8. Offline

    tkelly

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Right now, it's alphabetical (in order of command). But this will probably be changed in the future..
    tkelly, Mar 13, 2011
    #97
  9. Offline

    Celtic Minstrel

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    @Paradox460 - I heard you were working on Help integration into WorldEdit... will you be using the ExtraHelps posted here as a basis?
    Celtic Minstrel, Mar 14, 2011
    #98
  10. Offline

    FabianN

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Damn, can't use that to fake multiple lines...

    Well I added this to the suggestions site you suggest to use, but I'll just repeat it here incase any other members have input to this idea.

    How about having the lists sorted by the name? Currently you say they are not used.
    If we can sort via the names and then are able to make entries with no command, just a description then we could fake two-line descriptions. It's not perfect and admins would have to watch out for the two entries being split over multiple pages, but to me that's an adequate method until real multi-line support is added.

    Would that be an easy thing to do?
    FabianN, Mar 14, 2011
    #99
  11. Offline

    Celtic Minstrel

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Personally, I'd rather wait for true multi-line support.
    Celtic Minstrel, Mar 14, 2011
    #100
  12. Offline

    Gun_Asylem

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    just a question
    is it possible to specify the Order that the cmd's show up. i noticed they are alphabetical, but is it possible to put them in a specified order..
    Gun_Asylem, Mar 14, 2011
    #101
  13. Offline

    Bjourk

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Would you please add support for Essentials and Group Manager? That's a lot of commands to enter into ExtraHelp.yml manually!
    Bjourk, Mar 14, 2011
    #102
  14. Offline

    lazy_architect

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    I may just be slow here but can you change this line. Spent like 20min working on the reason Quickbelt extrahelp would only show the last of the three commands. I had done a Copy and paste and the name was the same so help only showed 1 command.
    lazy_architect, Mar 14, 2011
    #103
  15. Offline

    Celtic Minstrel

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Take that up with the authors of Essentials and GroupManager.
    Celtic Minstrel, Mar 14, 2011
    #104
  16. Offline

    Taeir

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Taeir, Mar 14, 2011
    #105
  17. Offline

    Bjourk

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    @Taeir
    Thanks for pointing this out.
    @FabianN
    Awesome job so far! I'll attach my ExtraHelp.yml for your archive.
    Included is my work on:
    -AdminChat
    -BackToBody
    -bFlight
    -Cake
    -ColorMe
    -Essentials (broken into groups, but incomplete)
    -FindMe
    -FishPeople
    -FlyRidgeFly!
    -Group Manager
    -iConomy
    -iConomy BankAccount
    -LightVote
    -Lockette
    -MagicCarpet
    -MeasuringTape
    -PrivateWarp
    -QuickBelt
    -TimeShift

    Thanks again! I might borrow some Essentials and GroupManager extras from your page.
    Bjourk, Mar 14, 2011
    #106
  18. Offline

    Richard Robertson

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    You featured my plugin. :D
    Richard Robertson, Mar 14, 2011
    #107
  19. Offline

    Bjourk

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    What does this mean and how can I fix it?
    Code:
    2011-03-14 18:20:19 [SEVERE] [HELP] Error!
unacceptable character #FFFD special characters are not allowed
in "<reader>", position 28653
    at org.yaml.snakeyaml.reader.StreamReader.checkPrintable(StreamReader.java:68)
    at org.yaml.snakeyaml.reader.StreamReader.update(StreamReader.java:159)
    at org.yaml.snakeyaml.reader.StreamReader.peek(StreamReader.java:117)
    at org.yaml.snakeyaml.scanner.ScannerImpl.scanPlain(ScannerImpl.java:1569)
    at org.yaml.snakeyaml.scanner.ScannerImpl.fetchPlain(ScannerImpl.java:860)
    at org.yaml.snakeyaml.scanner.ScannerImpl.fetchMoreTokens(ScannerImpl.java:348)
    at org.yaml.snakeyaml.scanner.ScannerImpl.checkToken(ScannerImpl.java:183)
    at org.yaml.snakeyaml.parser.ParserImpl$ParseBlockMappingValue.produce(ParserImpl.java:592)
    at org.yaml.snakeyaml.parser.ParserImpl.peekEvent(ParserImpl.java:163)
    at org.yaml.snakeyaml.parser.ParserImpl.checkEvent(ParserImpl.java:148)
    at org.yaml.snakeyaml.composer.Composer.composeNode(Composer.java:132)
    at org.yaml.snakeyaml.composer.Composer.composeMappingNode(Composer.java:230)
    at org.yaml.snakeyaml.composer.Composer.composeNode(Composer.java:160)
    at org.yaml.snakeyaml.composer.Composer.composeMappingNode(Composer.java:230)
    at org.yaml.snakeyaml.composer.Composer.composeNode(Composer.java:160)
    at org.yaml.snakeyaml.composer.Composer.composeDocument(Composer.java:122)
    at org.yaml.snakeyaml.composer.Composer.getSingleNode(Composer.java:105)
    at org.yaml.snakeyaml.constructor.BaseConstructor.getSingleData(BaseConstructor.java:124)
    at org.yaml.snakeyaml.Yaml.load(Yaml.java:264)
    at me.taylorkelly.help.HelpLoader.load(HelpLoader.java:26)
    at me.taylorkelly.help.Help.onEnable(Help.java:29)
    at org.bukkit.plugin.java.JavaPlugin.setEnabled(JavaPlugin.java:118)
    at org.bukkit.plugin.java.JavaPluginLoader.enablePlugin(JavaPluginLoader.java:451)
    at org.bukkit.plugin.SimplePluginManager.enablePlugin(SimplePluginManager.java:217)
    at org.bukkit.craftbukkit.CraftServer.loadPlugin(CraftServer.java:83)
    at org.bukkit.craftbukkit.CraftServer.loadPlugins(CraftServer.java:61)
    at net.minecraft.server.MinecraftServer.e(MinecraftServer.java:204)
    at net.minecraft.server.MinecraftServer.a(MinecraftServer.java:191)
    at net.minecraft.server.MinecraftServer.d(MinecraftServer.java:131)
    at net.minecraft.server.MinecraftServer.run(MinecraftServer.java:246)
    at net.minecraft.server.ThreadServerApplication.run(SourceFile:366)
    Bjourk, Mar 15, 2011
    #108
  20. Offline

    Celtic Minstrel

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Uh, it actually looks like the file is being interpreted as the wrong encoding or something... :/ You could try putting quotes around any help entries that contain special characters, though.
    Celtic Minstrel, Mar 15, 2011
    #109
  21. Offline

    Bjourk

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    What does YAML consider special characters? Almost every entry has "<" and ">" in it. Are slashes special? Parentheses? Brackets?
    Bjourk, Mar 15, 2011
    #110
  22. Offline

    Richard Robertson

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Just putting quotes around all strings may help.
    Richard Robertson, Mar 15, 2011
    #111
  23. Offline

    Bjourk

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    No friggin' way.
    Does anyone know how to find "<reader>" position 28660?
    Bjourk, Mar 15, 2011
    #112
  24. Offline

    Richard Robertson

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    It really is the recommended way to do strings anyway.

    I'm pretty sure a file wide regular expression replacement would be fine.
    Richard Robertson, Mar 15, 2011
    #113
  25. Offline

    Bjourk

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Are you suggesting that there's a way to use Find and Replace to add quotations in every paragraph around everything after "command:" or "description:"?
    Bjourk, Mar 15, 2011
    #114
  26. Offline

    Richard Robertson

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Yes that's exactly what I proposed. I also did it for you.
    Richard Robertson, Mar 15, 2011
    #115
    Bjourk likes this.
  27. Offline

    tkelly

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Help 0.2
    Release 15 Mar, 2011
    - Built w/ latest recommended build (531)
    - Multiline support! Command descriptions can now be as long as you'd like.
    - ExtraHelp.yml split into many YML files (more info below)
    - Built-in Help overriding (more info below)

    So, what I like about Help is that it was (and still is) an empty slate, that I can form into whatever direction the community was wanting it to go. So with 0.2, I was able to see how you guys were interacting with it, and try to make your lives a little easier.

    ExtraHelp.yml -> ExtraHelp/
    I've noticed that you guys have been really taking advantage of the ExtraHelp.yml. The sharing of files, and creating repositories for them is exactly what I wanted. Hopefully this change'll make it easier for this.

    I've gotten rid of the ExtraHelp.yml and added an ExtraHelp folder. Any .yml files you place in here will be loaded as if they were part of the ExtraHelp.yml. So you can have a separate file for each plugin, or a separate file for the different levels of permissions, whatever you'd like. This'll also help in hunting down the errors in the .yml files ;)

    When you upgrade to 0.2, Help will auto-convert your ExtraHelp.yml into the separate ones (and rename them to be <plugin>.yml), and you can continue on seamlessly. You can feel free to rename them, change them, whatever you'd like.

    Overriding Plugins with Built-In Support
    As more plugins add Help support, you might not like how they add support. Before 0.2, you just had to accept their entries. But now, you can override them. When another plugin registers itself with Help, Help will generate a .yml file for it, called plugin_orig.yml (where "plugin" is the name of the plugin registering).

    You should not change this file. This is never read, and will be overwritten when the plugin starts up again. This just shows you the exact format of the plugin's Help entries.

    What you can do is take this, and pull out the entries, and save them to your own .yml file. Any changes you make will take priority over the plugins.
    tkelly, Mar 15, 2011
    #116
  28. Offline

    Celtic Minstrel

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    I'm not entirely sure, but I think anything not a letter, number, hyphen, or underscore is risky.



    tkelly, what about colouring for optional arguments? Oh, and for plugins like WorldEdit that have a huge number of commands it would be useful for the plugin to be able to divide them up into sections.
    Celtic Minstrel, Mar 15, 2011
    #117
  29. Offline

    Bjourk

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Cool, thanks! Unfortunately it still didn't work.
    Turns out the main issue was that I had entries where I had left "permissions:" blank, which caused an error to occur. With the individual ExtraHelp ymls I was able to narrow down the problems and fix them all except for GroupManager, which I replaced with tyderion's for the win.

    Included are the first 10. I added the "spawn" and "setspawn" entries to Essentials, as they aren't listed under any sub-plugin.
    Bjourk, Mar 16, 2011
    #118
  30. Offline

    Bjourk

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Here are the rest of my plugins.
    Thanks to everyone who helped troubleshoot!
    Bjourk, Mar 16, 2011
    #119
  31. Offline

    Richard Robertson

    dev.bukkit.org profile:
    CFUSERNAME
    My Plugins (CFCOUNT)
    Yeah, blank values are invalid in YAML. You just need to not include the line if you don't have data.

    I didn't even notice because the file is huge. :p
    Richard Robertson, Mar 16, 2011
    #120
Page 4 of 9

Share This Page