chaseoes / FirstJoinPlus

Customize all aspects of new players joining for the first time.
http://dev.bukkit.org/bukkit-plugins/firstjoinplus/
11 stars 16 forks source link

Documentation of items #11

Closed GrumpyChunks closed 10 years ago

GrumpyChunks commented 11 years ago

I'm having a problem trying to understand the syntax used for giving players items when they first join.

I don't see this is as a code issue, I see it as a documentation issue.

The documentation states you can use the format:

57.1.0 which gives a diamond block

But the example config.yml, uses a name rather than an ID, plus it uses colons instead of full stops:

BREAD:5

I can't find any info in the documentation about where the names come from (e.g. WOODEN_PICK - why not WOOD_PICK? I don't care which, but it would be nice to have a definitive list of names, as it feels like a guessing game, hence why I've resorted to IDs, which is fine, but not as intuitive when you need to make changes.

The dotted number format seems simple enough, but I get the error "An internal error occurred whilst performing this command". I've tried using colons instead of full stops, but when I reload fjp it messes up the values in the file.

I've double checked my IDs (below), and I'm confident they are correct.

  give-items:
    enabled: true
    items:
    - 17.8.0
    - 265.1.0
    - 264.3.0
    - 263.8.0
    - 35.3.0
    - 297.8.0

Please can the documentation be updated to make this clear? Apologies if it is clear and I'm not seeing it, but I've searched all over looking for answers to this, or enhance the example config.yml to include some items added by ID?

chaseoes commented 11 years ago

Official item nams names can be found here: http://jd.bukkit.org/rb/apidocs/org/bukkit/Material.html

Both the item name and item ID should work. The format it should be in should follow the default configuration, like this: id:amount:data

With optionally just the ID/name and amount: id:amount

Or, default to an amount of 1: id

If an error pops up or something goes wrong, make sure they're wrapped in single quotes, like this: - 'id:amount:data'

GrumpyChunks commented 11 years ago

@chaseoes Thanks for the link, that would be really handy to include in the docs, plus I don't see a reference to id:amount:data in the docs, only id.amount.data.

chaseoes commented 10 years ago

I feel the configuration is at the point where it is self-documenting.