Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/misterpemodder/shulkerboxtooltip
What's in my shulker box?
https://github.com/misterpemodder/shulkerboxtooltip
fabricmc minecraft minecraft-mod mod
Last synced: 3 days ago
JSON representation
What's in my shulker box?
- Host: GitHub
- URL: https://github.com/misterpemodder/shulkerboxtooltip
- Owner: MisterPeModder
- License: mit
- Created: 2019-02-15T23:34:01.000Z (almost 6 years ago)
- Default Branch: 1.21.x
- Last Pushed: 2024-12-06T09:26:50.000Z (19 days ago)
- Last Synced: 2024-12-21T19:08:23.325Z (3 days ago)
- Topics: fabricmc, minecraft, minecraft-mod, mod
- Language: Java
- Homepage:
- Size: 2.1 MB
- Stars: 103
- Watchers: 5
- Forks: 33
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- Changelog: changelog.txt
- License: LICENSE
Awesome Lists containing this project
README
Shulker Box Tooltip
[](https://maven.misterpemodder.com/libs-release/com/misterpemodder)
[](https://minecraft.curseforge.com/projects/shulkerboxtooltip)
[](https://modrinth.com/mod/shulkerboxtooltip)
[](https://github.com/MisterPeModder/ShulkerBoxTooltip/actions?query=workflow%3AMain)
[](https://crowdin.com/project/shulkerboxtooltip)
=========================
This mod allows you to see a preview window of a shulker box contents when hovering above it in an inventory by pressing shift.
**[Help translate ShulkerBoxTooltip on Crowdin!](https://crowdin.com/project/shulkerboxtooltip)**
[Please vote for this to be included in vanilla!](https://feedback.minecraft.net/hc/en-us/community/posts/360074507051-shulker-boxes-should-have-the-new-bundle-interface)
## Developers
### List of artifacts
- **com.misterpemodder:shulkerboxtooltip-common**: Platform-agnostic API (with Yarn/intermediary mappings)
- **com.misterpemodder:shulkerboxtooltip-common-mojmap**: Platform-agnostic API (with official Mojang mappings)
- **com.misterpemodder:shulkerboxtooltip-fabric**: Fabric Implementation
- **com.misterpemodder:shulkerboxtooltip-forge**: Forge-specific API + Implementation
- **com.misterpemodder:shulkerboxtooltip-neoforge**: NeoForge-specific API + Implementation
### Declaring the dependency (Fabric Loom/Architectury Loom)
```gradle
repositories {
maven { url "https://maven.misterpemodder.com/libs-release/" }
}
dependencies {
// Change to 'shulkerboxtooltip-forge', 'shulkerboxtooltip-neoforge', or 'shulkerboxtooltip-common' depending on the artifact
modImplementation("com.misterpemodder:shulkerboxtooltip-fabric:VERSION") { transitive false }
}
```
### API
To use the API, implement the `ShulkerBoxTooltipApi` interface on a class and register it as a plugin.
On Fabric, add your plugin class as an entry point of type `"shulkerboxtooltip"` in your `fabric.mod.json` as such:
```json
"entrypoints": {
"shulkerboxtooltip": [
"com.example.mymod.MyShulkerBoxTooltipPlugin"
]
}
```
On NeoForge, register your plugin by adding an extension point in your mod's initialization code:
```java
ModLoadingContext.get().registerExtensionPoint(ShulkerBoxTooltipPlugin.class,
() -> new ShulkerBoxTooltipPlugin(MyModShulkerBoxTooltipPlugin::new));
```
On Forge, register your plugin by adding an extension point in your mod's initialization code:
```java
FMLJavaModLoadingContext context = /* get instance from your mod's constructor */
context.registerExtensionPoint(ShulkerBoxTooltipPlugin.class,
() -> new ShulkerBoxTooltipPlugin(MyModShulkerBoxTooltipPlugin::new));
```
See [api source](https://github.com/MisterPeModder/ShulkerBoxTooltip/blob/1.19/common/src/main/java/com/misterpemodder/shulkerboxtooltip/api/ShulkerBoxTooltipApi.java) for documentation.