Skip to content

zcripted/OBX-Insight

Repository files navigation

OBX Insight

License: MIT Java 25 Paper Gradle Kotlin DSL Build Code Quality: A+

Modern item inspection and debugging for Paper servers.

OBX Insight is a read-only item inspection utility for server owners, administrators, configurators, and developers. Hold an item, run /inspect, and explore what is stored inside it through a clean, categorized interface.

It explains item data instead of merely dumping it, separating inspection results into human-readable summaries, technical metadata, and developer-focused raw data.

Contents

Features

  • One-click item inspection
  • Read-only inspection flow
  • Inventory GUI
  • Overview
  • Appearance
  • Enchantment inspection
  • Attribute inspection
  • Persistent Data Container viewer
  • Data component viewer
  • Specialized item metadata summaries
  • JSON, MiniMessage text, and give-command exports

Commands

Command Description
/insight Enable inventory selection mode.
/insight hand Inspect your main-hand item.
/insight offhand Inspect your off-hand item.
/insight reopen Reopen your previous inspection.
/insight export <format> Export your latest inspection.
/insight reload Reload configuration and messages.
/insight version View plugin and server version details.

Aliases:

Alias Description
/inspect Alias for /insight.

Permissions

Permission Description
obxinsight.use Use OBX Insight and open the inspection menu.
obxinsight.inspect.hand Inspect items held in the main hand or off hand.
obxinsight.inspect.inventory Select and inspect items from the user's inventory.
obxinsight.inspect.components View modern item data components.
obxinsight.inspect.pdc View persistent data container entries.
obxinsight.inspect.specialized View item-type-specific metadata.
obxinsight.inspect.raw View raw and implementation-level item data.
obxinsight.inspect.sensitive View unredacted sensitive values.
obxinsight.inspect.findings View inspection findings.
obxinsight.export Open the export menu and create exports.
obxinsight.export.json Export OBX Insight JSON reports.
obxinsight.export.raw Export raw item data.
obxinsight.export.minimessage Export names and lore as MiniMessage.
obxinsight.export.give Generate a version-specific give command.
obxinsight.reload Reload configuration and messages.
obxinsight.admin Grant every OBX Insight permission.

All permissions default to operators.

Screenshots

Screenshots will be added as development progresses.

Installation

  1. Download the latest OBX Insight jar.
  2. Place it in your server's plugins/ folder.
  3. Start or restart your server.
  4. Edit plugins/OBXInsight/config.yml if needed.
  5. Run /inspect in-game.

Configuration

Configuration lives in:

plugins/OBXInsight/config.yml

The default configuration controls:

  • Inspection
  • Display
  • Exports
  • Security
  • Messages

Support

Roadmap

Future releases may include:

  • Item comparison
  • Custom-item integrations
  • Advanced inspection targets
  • Inspection history
  • Developer API

License

OBX Insight is licensed under the MIT License. See LICENSE.

About

Modern item inspection and debugging.

Resources

Contributing

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages