mirror of
https://github.com/Jikoo/OpenInv.git
synced 2026-11-08 10:15:28 -05:00
Jikoo
d35fc6713b
Some are still pending approval that probably won't happen until Monday, but oh well.
66 lines
2.4 KiB
Markdown
66 lines
2.4 KiB
Markdown
## About
|
|
|
|
OpenInv is a Bukkit plugin which allows users to open and edit anyone's
|
|
inventory or ender chest - online or not!
|
|
|
|
Downloads are available on [GitHub](https://github.com/Jikoo/OpenInv/releases), [DBO](https://dev.bukkit.org/projects/openinv)/[CurseForge](https://www.curseforge.com/minecraft/bukkit-plugins/openinv), [Modrinth](https://modrinth.com/plugin/openinv), and [Hangar](https://hangar.papermc.io/jikoo/OpenInv).
|
|
|
|
## Features
|
|
|
|
- **OpenInv**: Open anyone's inventory, even if they're offline.
|
|
- Read-only mode! Don't grant edit permission.
|
|
- Cross-world support! Allow access only from the same world.
|
|
- No duplicate slots! Only armor is accessible when opening self (if allowed at all)!
|
|
- Drop items as the player! Place items in the dropper slot in the bottom right. Can be disabled via permission!
|
|
- Allow any item in armor slots! Configurable via permission.
|
|
- **OpenEnder**: Open anyone's ender chest, even if they're offline.
|
|
- Allow access only to own ender chest! Don't grant permission to open others.
|
|
- Read-only mode! Don't grant edit permission.
|
|
- Cross-world support! Allow access only from the same world.
|
|
- **SilentContainer**: Open containers without displaying an animation or making sound.
|
|
- **AnyContainer**: Open containers, even if blocked by ocelots or blocks.
|
|
- **Resource Pack Support**: Personalize view using resource pack tricks like custom fonts and characters. See [the wiki](https://github.com/Jikoo/OpenInv/wiki/Customizing-Inventories) for details.
|
|
|
|
## Commands
|
|
|
|
See [the wiki](https://github.com/Jikoo/OpenInv/wiki/Commands).
|
|
|
|
## Permissions
|
|
|
|
See [the wiki](https://github.com/Jikoo/OpenInv/wiki/Permissions)
|
|
|
|
## For Developers
|
|
|
|
### As a Dependency
|
|
|
|
The OpenInv API is available via [JitPack](https://jitpack.io/).
|
|
|
|
```xml
|
|
<repositories>
|
|
<repository>
|
|
<id>jitpack.io</id>
|
|
<url>https://jitpack.io</url>
|
|
</repository>
|
|
</repositories>
|
|
```
|
|
|
|
```xml
|
|
<dependencies>
|
|
<dependency>
|
|
<groupId>com.github.Jikoo</groupId>
|
|
<artifactId>OpenInv</artifactId>
|
|
<version>${openinv.version}</version>
|
|
</dependency>
|
|
</dependencies>
|
|
```
|
|
|
|
Note that since JitPack only builds the API now, the "full" OpenInv jar on JitPack is actually the openinvapi artifact.
|
|
This is a change from previous dependency declaration that I hope to revert.
|
|
|
|
### Compilation
|
|
|
|
Execute the gradle wrapper:
|
|
`./gradlew build`
|
|
|
|
If you encounter issues with building the Spigot module, try running BuildTools manually.
|