Configuration

Configuration

Configuring PerWorldInventories is quite easy. This guide will thoroughly explain what each option does.

Config.YML

Configure Gamemodes allows you to set whether or not you will use different gamemodes per world, and set a player's gamemode when they enter a world.

configure-gamemodes: false

If this is set to true, then a player will have different gamemode inventories. This allows for in one world a player to have three different inventories (survival, adventure, creative)

seperate-gamemode-inventories: true

If you set this to true, then any worlds that you don't configure in this plugin, will share the same inventories (will still have different inventories for each gamemode if 'seperate-gamemode-inventories' is set to true

share-if-unconfigured: false

Set this if you'd like to send metrics to bstats.org. Note that this only saves number details (groups, worlds, players)

metrics:
  # Choose whether or not to enable metrics sending.
  # See https://bstats.org/getting-started for details.
  enable: true
  # Send the number of configured groups.
  # No group names will be sent!
  send-number-of-groups: true
  # Send the total number of worlds on the server.
  send-number-of-worlds: true

These next attributes are obvious and self-explanatory:

# All settings for players are here:
player:
  # Save and Load players' economy balances. Requires Vault!
  economy: false
  # Load players' ender chests
  ender-chest: true
  # Load players' inventory
  inventory: true
  # All options for player stats are here:
  stats:
    # Load if a player is able to fly
    can-fly: true
    # Load the player's display name
    display-name: false
    # Load a player's exhaustion level
    exhaustion: true
    # Load how much exp a player has
    exp: true
    # Load a player's hunger level
    food: true
    # Load if a player is flying
    flying: true
    # Load what gamemode a player is in. This is shadow-set to false if
    # 'manage-gamemodes' is true, to stop infinite loop
    gamemode: false
    # Load how much health a player has
    health: true
    # Load what level the player is
    level: true
    # Load all the potion effects of the player
    potion-effects: true
    # Load the saturation level of the player
    saturation: true
    # Load a player's fall distance
    fall-distance: true
    # Load the fire ticks a player has
    fire-ticks: true
    # Load the maximum amount of air a player can have
    max-air: true
    # Load the current remaining air a player has
    remaining-air: true

This is how often the inventories are saved per world, per player, and per gamemode (if 'seperate-gamemode-inventories' is true)

# Configure the amount of time between saves, in seconds
# Default is 5 minutes (300 seconds)
save-interval: 300

This will log data. It is generally beneficial. [TODO: Clarify]

# Attempt to figure out which world a player last logged off in
# and save/load the correct data if that world is different.
# REQUIRES MC 1.9.2 OR NEWER
load-data-on-join: false

Check this if you are getting errors/server crash/plugin disables. Post the related logs from the console on a GitHub issue, and I'll try and help you fix your error.

# Print out debug messages to the console for every event that happens in PWI
debug-mode: false

If this is enabled, OPs, All Staff, etc, will have different inventories per world, and per gamemode(if 'seperate-gamemode-inventories' is true)

# Disables bypass regardless of permission
# Defaults to false
disable-bypass: false

Worlds.YML

Pretty straightforward, turning the options to false will cause that item to not be loaded on world change. The option 'manage-gamemodes' is set to false by default to not interfere with other plugins that you may have to manage GameModes.

The groups are groups of worlds that share the same gamemode/inventories.

groups:
  world1:
    worlds:
    - world1
    - world1_nether
    - world1_the_end
    default-gamemode: SURVIVAL
  world_2:
    worlds:
    - world_2
    default-gamemode: CREATIVE