/OpenInv

Open anyone's inventory as a chest, real-time!

Primary LanguageJavaGNU General Public License v3.0GPL-3.0

About

OpenInv is a Bukkit plugin which allows users to open and edit anyone's inventory or ender chest - online or not!

Features

  • OpenInv: Open anyone's inventory, even if they're offline.
    • Read-only mode! No edits allowed! Don't grant the permission OpenInv.editinv
    • Cross-world support! Don't grant OpenInv.crossworld
    • No self-opening! Don't grant OpenInv.openself
    • Drop items as the player! Place items in the unused slots to the right of the armor to drop them
  • OpenEnder: Open anyone's ender chest, even if they're offline.
    • Read-only mode! No edits allowed! Don't grant OpenInv.editender
    • Cross-world support! Don't grant OpenInv.crossworld
    • No opening others! Don't grant OpenInv.openenderall
  • SilentContainer: Open containers without displaying an animation or making sound.
  • AnyContainer: Open containers, even if blocked by ocelots or blocks.

Commands

See the wiki.

Permissions

Node Description
OpenInv.* Gives permission to use all of OpenInv.
OpenInv.openinv Required to use /openinv.
OpenInv.openself Required to open own inventory.
OpenInv.editinv Required to make changes to open inventories.
OpenInv.openonline Allows users to open online players' inventories. For compatibility reasons this is granted by the nodes OpenInv.openinv and OpenInv.openender.
OpenInv.openoffline Allows users to open offline players' inventories. For compatibility reasons this is granted by the nodes OpenInv.openinv and OpenInv.openender.
OpenInv.openender Required to use /openender.
OpenInv.editender Required to make changes to open ender chests.
OpenInv.openenderall Allows users to open others' ender chests. Without it, users can only open their own.
OpenInv.exempt Prevents the player's inventory being opened by others.
OpenInv.override Allows bypassing of the exempt permission.
OpenInv.crossworld Allows cross-world usage of /openinv and /openender.
OpenInv.search Required to use /searchinv and /searchender.
OpenInv.searchenchant Required to use /searchenchant.
OpenInv.anychest Required to use /anychest.
OpenInv.any.default Cause AnyContainer to be enabled by default.
OpenInv.silent Required to use /silentcontainer.
OpenInv.silent.default Cause SilentContainer to be enabled by default.
OpenInv.spectate Allows users in spectate gamemode to edit inventories.

For Developers

As a Dependency

The OpenInv API is available via JitPack.

  <repositories>
    <repository>
      <id>jitpack.io</id>
      <url>https://jitpack.io</url>
    </repository>
  </repositories>
  <dependencies>
    <dependency>
      <groupId>com.github.jikoo.OpenInv</groupId>
      <artifactId>openinvapi</artifactId>
      <version>${openinv.version}</version>
    </dependency>
  </dependencies>

Compilation

To compile, the relevant Spigot jars must be installed in the local repository. As OpenInv is compiled against Mojang's mappings, you must run BuildTools with the --remapped argument:
java -jar BuildTools.jar --remapped --rev $serverVersion
$serverVersion is the version of the server, i.e. 1.18.1

To compile for a single version, specify the module you are targeting:
mvn -pl $moduleName -am clean install
$moduleName is the name of the module, i.e. internal/v1_18_R1.

To compile for a set of versions, use a profile. Select a profile using the -P argument:
mvn clean package -am -P all
The only provided profile is all. The final file is target/OpenInv.jar
For more information, check out the official Maven guide.