WorldInventories
WorldInventories
Discontinued
As of 11/05/2013 I'm no longer working on this project. I haven't played vanilla/Bukkit in a very long time, updates are becoming tedious and break often requiring rewrites, and I'm not enjoying development any more. The last uploaded version for 1.5.1 works fine (aside from the importing), and there's a chance it will also work across updates, but moving to another plugin, such as MultiInv, is highly recommended - you should also be able to import settings in to it.
Description
Switch any of the following player information when teleporting between groups of worlds:
- Inventory,
- Armour,
- Ender Chest contents,
- Potion effects,
- Health,
- Hunger,
- Experience,
- Game mode.
Player information is separated in to small YAML files (that you can edit) based on groups. Designed to be fast, simple and easy to use.
Want to keep existing player information? Use the vanilla import option as outlined in the configuration example. Players will get a blank inventory by default if you don't import data first!
Need to chat, notify me of a bug, suggest a feature or try and get some help? Go to the IRC channel! (information down in Links)
How to use
Simply put WorldInventories in the Bukkit plugins folder, run it once, edit the config file it creates. An example is included below (with an explanation of each configuration option).
Any worlds not included in groups share a "default" group.
Changes in 1.7.0
Importing support for files previous to v5 has been dropped. This was necessary to clean the project up (just look at the GitHub page if you want proof!) and make it easier to maintain. If you need to import previous to this, use 1.6 as a go-between. Vanilla importing still works fine.
Other changes and additions:
- Added message hiding granularity (hide specific message types, on login for example),
- Added language support,
- Massive code cleanup,
- Event priorities changed a bit, should improve compatibility with other mods,
- Built against 1.5.1,
- Added API - tell me if you would like something added to it!
A note about the dev builds: All importing is currently broken. I'm fixing vanilla importing, it will involve using the OpenInv plugin to load offline player inventories. OpenInv is optional and only required when doing the vanilla import.
Language support
As of 1.7.0 a new file, langs.yml, will be created on the first plugin run. A new configuration option, "language: en_GB" will also be generated.
To add a new language:
- Run the new version once, it'll generate lang.yml in the same place as config.yml, and add "language: en_GB" to the config as a default,
- Open lang.yml, copy one of the sections and call it something (preferably the country code),
- Set "language" to whatever you called it, save,
- Either do "/wireload language" or restart the server, check the console to see if there were any errors when trying to load your new language.
If you add a different language please let me know, I can add it to the defaults!
Why no SQL support?
For a plugin like this, it isn't necessary. Files are very, very small (you'd probably hit 10kb for a player with a completely full inventory), load extremely quickly and are fast to copy and backup as they are.
If you disagree with me, provide a performance report to me on IRC (there are lots of plugins to profile performance) and I'll think about it again.
Configuration example (with explanations)
Version 1.7.0
# A "group" is a collection of worlds which will share an inventory. # In this example there are two groups, a creative and a survival group # Each group has an overworld and a nether, which will share an inventory # Inventory switching examples # Scenarios when the inventory will not switch: # creative_overworld to creative_nether # survival_nether to survival_overworld # survival_end to survival_overworld # Scenarios when the inventory will switch: # creative_overworld to survival_end # survival_nether to creative_nether groups: creativegroup: - creative_overworld - creative_nether survivalgroup: - survival_overworld - survival_nether - survival_end # Add a player to the "exempt" collection to make this plugin ignore them completely # No saves, loads or anything else done by this plugin will apply to them until you remove them from the list exempt: - exampleplayer - exampleplayer2 # This is deprecated as of 1.7.0 - use message-hidden at the bottom instead! # donotifications: true # Set this to true to make WorldInventories attempt to import MultiInv data # Automatically sets itself to false when an attempt is made domiimport: false # Set "miimportmode" to the integer identifier of the mode WI should import from (eg, 0 for MI survival) miimportmode: 0 # Set to true to make hearts, food level, experience and such track with inventory dostats: true # If a save interval is specified below, set this to false to stop it from outputting to the console outputtimertoconsole: true # Set to anything above 30 to make inventories/stats save automatically every x seconds saveinterval: 0 # Set "do78import" to true to force a conversion of the pre build 78 files for use in newer versions # Automatically resets itself to false on an attempt do78import: false # Set "do141import" to true to force a conversion of the pre version 1.4.1 files for use in newer versions # Automatically resets itself to false on an attempt do141import: false # Set "dovanillaimport" to true to attempt an import of the items and stats stored in players player.dat file # Set "vanillatogroup" to the group you want to import to. If blank it will use the default group. dovanillaimport: false # When this plugin loads it will automatically try to convert pre build 78 files and add "auto78updated: true" to this file if successful # When this plugin loads it will automatically try to convert pre version 1.4.1 files and add "auto141updated: true" to this file if successful # Set "dogamemodeswitch" to true and add groups to gamemodes as per the example to enforce gamemodes # SURVIVAL, CREATIVE or HARDCORE at the time of writing (follows Bukkit's names) gamemodes: default: SURVIVAL creativegroup: CREATIVE survivalgroup: SURVIVAL dogamemodeswitch: false # Below are 1.7.0 and above # Set language to something stored in lang.yml language: en_GB # To hide a particular message type, set any of these to true message-hidden: died-message: false changed-message: false nochange-message: false loaded-message: false
Commands & Permissions
There are two commands as of 1.5.7:
- /wireload: Reloads the configuration,
- /wiexempt [add/remove] [player]: Add or remove the player from the exemptions list (whether the plugin does anything to their information specifically, e.g. when they switch a world).
In 1.7.0 the reload command changed slightly:
- /wireload [all/language]: Reloads the entire configuration or just the language.
There are also two permissions:
- worldinventories.reload: Allows the use of the /wireload command,
- worldinventories.exempt: Allows the use of the /wiexempt command.
Licenses
This work is distributed under the BSD 2-Clause license. Read the license
This plugin also uses XStream. Read the XStream license
Links / Download
Bukkit require me to include this notice when linking Jenkins builds, like the one below.
Development builds of this project can be acquired at the provided continuous integration server. These builds have not been approved by the BukkitDev staff. Use them at your own risk.
- Source code
- Available in the BukkitDev downloads!
- No beta builds.
- Issues / known bugs
- IRC - EsperNet #worldinventories
- Donate
Use IRC for new build notifications, telling me about issues and getting faster help!
(Only shows stats for version 1.4.1 and above)
@CarrotCodes
I'm also talking to Chaseos, the dev for FirstJoinPlus, but this plugin conflicts with it. You don't spawn with the items FirstJoinPlus adds when using this plugin.
@busterguy
Did you use the import option as outlined in the first paragraph on this page?
You can still get the vanilla information back if you run the importer now.
Thanks.. added this and everyone inv on my server got reset...
I gave up on this plugin and changed to GamemodeInventories since MV switches people's gamemode when they change worlds anyway
Hello!
Is there any chance a version would work with tekkit classic? Tekkit classic is running 1.2.5R4-1-RCPC-SNAPSHOT
One of my players showed me a couple of bugs that are easy to reproduce with this as well, if you have MobArena or pvparena and join the arena, pick a class, and log out (i.e. disconnect) it loses your real inventory and you get just the game inventory instead.
Is there any way to prevent this from happening?
I apparently have players losing inventories quite often, is there any way to help figure out why?
Okay, I think I MAY have found the culprit (ClickSort) so I posted a couple of errors to the developer, once that's fixed I'll let you know if it's still happening.
How can i import multiverse inventories?
@SuperStudMufin
That's odd. I just tried with the latest WorldGuard and WorldInventories and it's working fine here. Make sure overlapping features are only enabled in one of the other, people have had problems with that before.
@Liger_XT5
Ah, thanks for giving the log. This is in fact a Bukkit problem - I can't change anything about it even if I wanted to without breaking other things. Bug them to allow special characters in saves. :(
@Drayshak
I caught one of the random inventory wipes.
As far as I know, it could be due to DiabloDrop's Colored Name features it does for some of the items.
@CarrotCodes
When I put the plugin in my plugins folder, WorldGuard just completely stops working, EX: in one of my regions, i had mob-spawning set to deny and then mobs were spawning, I type /region list and it said unknown command. Therefore, WorldGuard was completely shut down.
@SuperStudMufin
I need more than that to try and help you. What breaks, how does it break, what version of the plugins are you using?
This plugin causes WorldGuard not to work
@TheGoldenCreepr
you have to download the dev build that is on the bottom of the post under links
If i remove the plugin, are the inventories removed too? I dont want to use the plugin anymore (because of compatibility problems with mobarena) and i lost the need of this plugin.
@Liger_XT5
That's odd. Bukkit does all of the saving/loading of inventories (I just tell it when) so there should be an error if it fails to load or save. I log an error too so you'd probably see two.
I've had several instances of people's inventories going missing when the server host has hard drive issues for that load - it sounds simple but it might be worth looking in to it?
Let me know if you manage to reproduce this, other than hosting issues I haven't had any other reports for it. Sorry I can't help more :(
We've been getting reports of players having full inventory wipes upon login. I've thought for a few weeks it was due to some items have enchants over their normal values (such as up as high as 10).
I haven't seen any errors, are there anything I could take a look at?
Is this a plugin where i can make it so everyone doesnt have an inventory in one world?
I copy it in the plugin file but nothing happens :( what can i do?