[INACTIVE] [MECH/DEV] SpoutBackpack v2.3.6_3 - Give your players a Backpack [1317]

Please now use BukkitInventoryTools which contains SpoutBackpack.

This thread is now useless, please don't post any longer on it.

-----------------------

You can find the Bukkit Dev' thread HERE.

Please use it, this thread will no longer be updated.

------------------------

SpoutBackpack v2.0.1

Give your players a Backpack w/ Spout.

Because pictures / video are always better than thousand words:

(Unofficial video by [USER]IAMWIN[/USER] but outdated: v1.9.5)

Features:

• Pressing a key to open your backpack ;
• Economy widget if you want it ;
• Not just backpack, workbench too ;
• Drop on death (configurable) ;
• Permissions and economy plugins support ;
• Allow your players to expand their Backpack ;
• Restictions of upgrades & commands ;
• Multiworld support with different Backpacks ;
• Hooks into WorldGuard, MobArena and Jail ;
• Key and name can be customized ;
• API for developers ;
• Backpacks are saved on server ;
• Works even on reload.

Requirements:

• Spout and Spoutcraft - Required to launch and use the plugin.
  Tested with RB #1.0.5.227 of Spout and RB #1.0.5.256 of Spoutcraft.
• (OPTIONAL) Permissions - Required if you want to customize the size or upgrade.
• (OPTIONAL) PermissionsBukkit - Required if you want to customize the size or upgrade.
• (OPTIONAL) PermissionsEx - Required if you want to customize the size or upgrade.
• (OPTIONAL) GroupManager - Required if you want to customize the size or upgrade.
• (OPTIONAL) iConomy - Required if you want to upgrade.
• (OPTIONAL) BOSEconomy - Required if you want to upgrade.
• (OPTIONAL) Essentials Economy - Required if you want to upgrade.
• (OPTIONAL) MultiCurrency - Required if you want to upgrade.
• (OPTIONAL) WorldGuard - Not required but compatible.
• (OPTIONAL) MobArena - Not required but compatible.
• (OPTIONAL) Jail - Not required but compatible.

Configuration:

Code:

Widget:
    PositionY: 5
    PositionX: 3
    Enabled?: true
Permissions:
    UseGroupManager?: false
    UsePermissions?: true
    UsePermissionsBukkit?: false
    UsePermissionsEx?: false
Backpack:
    Name: Backpack
    Key: B
    Price:
        '45': 40.0
        '36': 30.0
        '18': 10.0
        '54': 50.0
        '27': 20.0
    RegionWhereBackpacksAreDisabled:
    - region1
    - region2
    world:
        Administrators:
            UpgradeSize: 54
            Size: 54
        Players:
            UpgradeSize: 27
            Size: 9
        Guests:
            UpgradeSize: 0
            Size: 0
        InventoriesShare?: true
        Moderators:
            UpgradeSize: 45
            Size: 27
        Joueurs:
            UpgradeSize: 36
            Size: 18
Workbench:
    Enabled?: true
    Key: W
    NeededInInventory?: false
Saves:
    Log?: false
    Interval(InMinutes): 5

For PermissionsBukkit and PermissionsEx, you need to add permissions backpack.worldname.groupname. You also need to order your groups in the configuration file (eg. Admins, then Mods, then Players and then Guests). I'm sorry of this but those two plugins doesn't have the methods I need.

Permissions:

• backpack.workbench : Allow the player to open a virtual workbench.
  
• backpack.nodrop : No drop of the items in the Backpack on death.
• backpack.clear : Allow the player to clear his own Backpack.
• backpack.clear.other : Allow the player to clear others inventories.
• backpack.info.other: Allow the player to show info about others.
• backpack.upgrade.other: Allow the player to upgrade others' Backpack.
• backpack.open.other : Open other players' Backpack.
• backpack.reload : Allow the use of the /backpack reload command.
• NOTE: If you use OP system, size for not-Op players will be 9 and 54 for OP players.

Commands:

• /backpack clear (Player) : Clear your / player's inventory.
• /backpack info (Player): Show information about your / player's Backpack.
• /backpack open [Player] : Open player's Backpack.
• /backpack upgrade [Player]: Upgrade your /player's Backpack.
• /backpack reload : Reload Backpack's configuration.
• NOTE: /backpack's alias is /bp.

Downloads:

• SpoutBackpack v2.0.1 - Download the .JAR
• SpoutBackpackLite v1.1 - Download the .JAR
• Source code - Go on GitHub!

Highly recommended:

• SortInventory v1.4 - Go on the thread!

Credits:

• The portage from BukkitContrib to Spout of this plugin was made by [USER]kazimir[/USER]!
• All credits go to [USER]captainawesome7[/USER] for his awesome BCBackpack plugin!

TO-DO:

• Permissions support ; DONE IN 1.3
• Configuration of the key ; DONE IN 1.3
• Multiple chest sizes ; DONE IN 1.4
• iConomy integration ; DONE IN 1.6
• MobArena hook ; DONE IN 1.6.1
• BOSEconomy support ; DONE IN 1.6.2
• PermissionsBukkit support ; DONE IN 1.6.3
• Multiworld support ; DONE IN 1.7
• Separate inventories ; DONE IN 1.7
• WorldGuard regions support ; DONE IN 1.7.1
• GroupManager support ; DONE IN 1.7.2
• Workbench ; DONE IN 1.8
• Jail support ; DONE IN 1.8.1
• Add an option to disable workbench ; DONE IN 1.8.2
• Restriction on Workbench ; DONE IN 1.8.4
• Support of Essentials economy ; DONE IN 1.8.5
• Economy widget ; DONE IN 1.9
• Command to clear Backpack ; DONE IN 1.9
• Restrictions on upgrades ; DONE IN 1.9
• API ; DONE IN 1.9
• Setting for the widget position ; DONE IN 1.9.2
• Lookup in others' Backpack ; DONE IN 1.9.2
• Support for PermissionsEx ; DONE IN 2.0
• Handle deaths without Spout client ; DONE IN 2.0
• Upgrade other players' Backpack ; DONE IN 2.0
• Furnaces.

Notes:

• If you put something in your Backpack and close Minecraft by clicking the "X" without closing your backpack, all items you put in since opening your Backpack are lost. That's not a bug - It's a feature to prevent duping.

API:
You want to hook into SpoutBackpack? Fine, I have what you need.

1. Import SpoutBackpack.jar as a library in your project ;
2. Import me.neatmonster.spoutbackpack.SBHandler ;
3. In your main class, add this object creation :
   
   Code:

       public SBHandler spoutBackpackHandler;

4. Somewhere on your onEnable, add this line :
   
   Code:

           setupSpoutBackpack();

5. So, this is the setupSpoutBackpack function :
   
   Code:

       private void setupSpoutBackpack() {
                                                   if (spoutBackpackHandler != null) {
                                                       return;
                                                   }
                                                   Plugin spoutBackpackPlugin = this.getServer().getPluginManager().getPlugin("SpoutBackpack");
                                                   if (spoutBackpackPlugin == null) {
                                                       return;
                                                   }
                                                   spoutBackpackHandler = new SBHandler();
                                                   return;
                                                   }

6. To check somewhere in your code if SpoutBackpack is enabled, use :
   
   Code:

           if (spoutBackpackHandler != null) {
                                         return;
                                  }

7. And finally to use a method of SpoutBackpack :
   
   Code:

           spoutBackpackHandler.theMethodYouWant();

   You can find all the methods HERE.
8. If you need more methods, or if I made a mistake, do not hesitate to contact me.

Changelog:
Version 2.0.1

• PermissionsBukkit & PermissionsEx fix.

Version 2.0

• Improved Backpacks' save system ;
• PermissionsBukkit full support ;
• PermissionsEx full support ;
• Bug fix when client doesn't use Spoutcraft ;
• Upgrade other players' Backpack.

Version 1.9.5

• Added methods for the API.

Version 1.9.4

• Fixed API.

Version 1.9.3

• Removed debug messages.

Version 1.9.2

• Setting for the position of the widget ;
• Command to open other players' Backpack.

Version 1.9.1

• New method added to the API.

Version 1.9

• Economy widget when you opens your Backpack ;
• Commands to clear Backpack(s) ;
• Restrictions on updates ;
• Creation of an API ;
• Bug fixes with economy.

Version 1.8.5

• Support of Essentials Economy ;
• Support of MultiCurrency.

Version 1.8.4

• Option to only use workbench if you have one in inventory.

Version 1.8.3

• No more saves when nobody is online ;
• Fixed bug on upgrade.

Version 1.8.2

• Workbench toggle in the config.

Version 1.8.1

• Jail support.

Version 1.8

• Now with you can give your players a virtual workbench ;
• You can close the workbench with the same key ;
• Now the workbench will not appear when typing in the chat.

Version 1.7.3

• GroupManager full support.

Version 1.7.2

• GroupManager support ;
• Permission for drop on death.

Version 1.7.1

• You can specify WorldGuard region where Backpacks will be disabled ;
• More, more, more and more keys.

Version 1.7

• New multiworld support ;
• Separate inventories ;
• Common inventories ;
• Reload command ;
• Smart detection of plugins you've installed ;
• Some code rewrite = more proper code.

Version 1.6.3

• Added PermissionsBukkit support with configuration options.

Version 1.6.2

• Support for BOSEconomy, no configuration needed ;
• More anti-cheat messages and information for users.

Version 1.6.1

• Hooks in MobArena : when a player is inside an arena, I can't open his BackPack ;
• For more security, it checks if iConomy is installed.

Version 1.6

• Added iConomy support & /backpack commands, which allow your players to expand their Backpack by paying some iConomy money (configurable in config.yml) ;
• Minor bug fixes & code cleanup.

Version 1.5

• Added support for multiword (see in config.yml).
• More and more help in the config.yml.

Version 1.4

• New permissions for different sizes.

Version 1.3

• Closing you backpack will now saves his content.
• Permissions support.
• You can now change the key used to open the backpack in the configuration.

Version 1.2

• Original version.