ItemQuery - Lookup items, easy!

Plugins WIP Plugins
1

#ItemQuery - a Sponge plugin
What is ItemQuery?
ItemQuery is a Sponge plugin that gives information about a given item.
Features

  • Text/GUI toggle

  • Fully customizable

  • Show only the features YOU want

  • Item query blacklist

  • Search any allowed item!
    Commands
    /itemquery - Main command for item query (displays help page)
    /itemq - Alias for /itemquery
    /iq - See above
    /itemquery toggle - toggle between text-based query and GUI info
    /itemquery hand - queries the held item
    /itemquery (item name|item id) - queries the specified item
    Whatā€™s the difference - GUI/Text mode?
    In Text mode, your query will look like this:

    /itemquery stone
    ========================== ItemQuery - Stone (id: 1) =============================
    Stone
    Can be mined with: Pickaxe
    Blast resistance: 30
    Hardness: 1.5
    Is transparent: no
    Is stackable: yes (64)
    Crafting:
    1 cobblestone > (furnace) > 1 stone
    In GUI mode, these will be accessible by hovering over an item in a chest (configurable). Crafting will open a crafting table/furnace/brewing stand by clicking on an item.
    Example config file

    #ItemQuery by sam4215
    #Blacklists items from the lookup.
    banned-items:

    • ā€˜AIRā€™
    • ā€˜BARRIERā€™
      #What item shall be the ā€œcraftingā€ icon in GUI mode?
      gui-crafting: ā€˜WORKBENCHā€™
      #What item shall be the ā€œblast resistanceā€ icon in GUI mode?
      gui-blast: ā€˜TNTā€™
      #What item shall be the ā€œhardnessā€ icon in GUI mode?
      gui-hard: ā€˜IRONā€™
      #What item shall be the ā€œtransparencyā€ icon in GUI mode?
      gui-clear: ā€˜GLASSā€™
      #What item shall be the ā€œstackableā€ icon in GUI mode?
      gui-stack: ā€˜REDSTONEā€™
      Permissions

    gui.mode - Allows player to toggle GUI/text mode. default: true
    gui.use - Allows players to lookup items. default: true
    gui.seehidden - Allows players to lookup items on the blacklist. default: false
    GitHub
    Right here!

As always, enjoy!

3 Likes
2

Seems like a good idea. Really helpful in a survival server especially for new players.

1 Like
3

Suggestion 1: add possibility to add custom blocks
Suggestion 2: mention the exact needed tool to mine (thinking wood pickaxe not mining diamonds)

I like this plugin. Will try out soon :slight_smile:

1 Like
4

This will be great for a granite or vanilla server, but for forge we already have WAILA (what am I looking at). You could always look at how it works and probably get some feature inspiration from it :smiley:

@tzk adding the custom blocks is probably unnecessary because of waila. If your adding blocks then the clients have to install mods anyhow, so might as well be throwing waila on the client while your at it.

1 Like
5

I didnā€™t know Waila. Just had a look at it and of course youā€™re right.

1 Like
6

Cool. Does this get the data dynamically or is it hard-coded. Dynamic could be useful for custom plugins.

7

Iā€™m going to attempt to store it dynamically. @tzk Iā€™d add a custom-blocks.yml file that would allow you to do such a thing.
Example:

items:
    CUSTOM_ITEM:
        blast-resist: 25
        hardness: 1
        transparent: false
        crafting:
            top_centre: 'WOOD_PLANKS'
            middle_centre: 'REDSTONE'
8

Why use not use Hocon instead of YAML?

9

@ButterDev
i donā€™t need this functionality but i thought it would be a nice addition :wink:

10

Why is yml suddenly bad?

11

HOCON is poorly documented, and most users arenā€™t familiar with it.

12

configurate library exists.
pretty much makes the usage similar across the two formats; just have a HoconConfigurationLoader or a YAMLConfigurationLoader and load the file in

common argument here in comparison to hocon is that hoconā€™s probably more human-readable and easier to work with, while placing a tab into a YAML file sets the world on fire

2 Likes
13

This plugin would honestly be so helpful? Seeing that crafting heading makes me real happy because I search for the simplest craft recipes, and thatā€™s just me being a scrub.

1 Like
14

Custom item support should just work with sponge anyway. all the blast-resistance stuff should be exposed as block properties.