WhatIsThis - Identify the block or entity being looked at | 1.13 - 1.21.4| Multi-Language support | icon

WhatIsThis - Identify the block or entity being looked at | 1.13 - 1.21.4| Multi-Language support | -----

Displays in local language: supports Slimefun4, Nova, Craftory, Nexo, ItemsAdder & MythicMobs



Minimum Java Version: ________Java 21


The latest version of this plugin requires servers to be running Minecraft/Spigot 1.21.3+

Download version 5.7.of this plugin for servers running Minecraft/Spigot 1.21.1

Download version 5.6.of this plugin for servers running Minecraft/Spigot 1.20.6

Check Dependencies below for the correct version for your server.


What Is This - Identify the block or entity you are looking at
Easily get the name of the block or entity you are looking at and the items it drops

2020-06-30_11.18.42.png

Description
WhatIsThis is a lightweight utility plugin aimed at providing block and entity information directly to the player without the need to open a UI. This plugin was inspired by Forge mods like WAILA (What Am I Looking At) which run client-side to constantly display the name of the block being looked at. This plugin runs server-side, and by simply right-clicking a block or running command /wt while looking at a block, the block type and the items it drops will be displayed. It can also be configured to auto-display the targeted block or entity.

This can be helpful in Survival mode to know what a block is without having to break it first, or while looking at other people's builds in Creative mode, using custom block plugins like Slimefun4 and Nova, or when connected with an older client version to a server using Via* plugins.

Following the Archaeology Update in Minecraft 1.20. it can also be useful to easily and quickly identify Suspicious Sand and Suspicious Gravel blocks.

2023-11-29_19.13.19.png

Starting with version 5.0, the plugin will also identify entities in the same way as blocks.

2022-11-30_23.48.50.png

Enabling 'auto_display' in the config, the display will automatically update just by looking at a different block without the need for commands or clicking. As this runs server side, having 'auto-display' enabled may impact performance depending on the server hardware, software and the number of players online.

The 'auto_display' option is disabled by default, so when the server starts the 'player move' listener is not registered. To enable the 'auto-display' option the server will need to be restarted so that the listener is correctly registered.

A list of blocks to ignore, for example, AIR, WATER, GRASS_BLOCK, can be specified in the config. These blocks will not display any information when targeted by the player.

Simply by right-clicking a block with a STICK (default, can be changed in config) or running command /wt while looking at a block, the block name is displayed briefly on the ActionBar (optionally the items it drops can also be displayed if using the scoreboard). Both options can be used underwater as well as on land.

There is the option to have the block information displayed on the ActionBar, BossBar, Scoreboard or in chat. Using the first two methods, only the name of the block is displayed and not the dropped items. The BossBar will also display the health of the targeted entity.

The ActionBar display is probably the most attractive and least intrusive of the display methods. The text colour can be set in the config.yml file.

The text colour and the colour of the BossBar can be set in the config.yml file.


Dependencies and Supported Plugins
The latest version of this plugin requires servers to be running a minimum of Java 21 and Minecraft/Spigot 1.21.3+.

The versions of the following plugins, which provide a number of custom blocks and entities, are supported by the latest version:


Nexo 0.7.0 by Boy0000/MineInAbyss.

Slimefun4 RC-37 by TheBusyBiscuit.

Nova 0.16 by xenondevs.

ItemsAdder 3.6.3 by LoneDev.

Oraxen 1.164.0 by Uxon/Th0rgal.

MythicMobs 5.6.2 by Xikage.


Version 5.7 is available for servers running Minecraft/Spigot 1.21.1

Version 5.6 is available for servers running Minecraft/Spigot 1.20.6.

Version 5.5 is available for servers running Minecraft/Spigot 1.17.1 -1.20.4 with Java 17.

Version 4.5 is available for servers running Minecraft/Spigot 1.17.1 with Java 16.

Version 3.4 is available for Minecraft/Spigot 1.13.2 through to 1.16.5.

Note: Version 3.4 only supports Slimefun4 custom blocks. Also if you want to have Slimefun4 RC-27+ with this version, you will need to download v3.4.1 from GitHub, due to changes in the Slimefun4 API.

2021-10-31_12.20.20.png

2022-11-30_22.56.20.png

2019-10-02_00.45.27.png


Using the plugin




The above is a quick 90 second video showing the plugin in use in the nether.

You must have a clear view of the block being looked at when running the /wt command. The range is currently set to 10 blocks.

The ability to right-click with an item can be toggled OFF and ON using the /wt toggleclick command, or disabled in the config.yml if not required.

The item used to select the block is also configurable. The default item is a STICK. Any item can be used, including an empty hand, although the plugin does not cancel any events that might be triggered by right-clicking with the item such as a "block place" event or opening a door or chest, so it doesn't interfere with the normal mechanics of the game.

If using the scoreboard or chat display options, the name and number of items dropped is also displayed. Where the drops are variable (e.g. the number of SEEDS dropped by WHEAT) it returns the range (e.g. 0 -> 3) of what could be dropped by breaking the block.


Video Showcase
Thanks to ericbarbwire for creating this video of the plugin.






Commands & Permissions
/wt - identifies the block or entity being looked at
/wt info - information about the plugin
/wt reload - reload the config file (requires whatisthis.admin permission)
/wt toggleclick - toggle right-click ON/OFF (requires whatisthis.admin permission)

whatisthis.use - default true
whatisthis.admin - default op

2021-10-31_12.19.57.png


Multi-Language Options
All Minecraft languages are supported. The player's own language (which is set locally in the Minecraft launcher) is used to automatically display the name of the block and the items it drops when broken. The text for the word "Drops" can be changed from English by manually changing the text in the config.yml.

If you know that you will only need certain language files, then those required can be set in the config.yml - see example config below.

As the Scoreboard has a limit of 40 characters, item names which are too long will be truncated to fit.

If the name has not been set in the local language file, then it will revert to "en_us" and display the English equivalent.

composter.png

Configuration
Below is the fully documented default configuration file. Options that aren't required should be disabled, and the language files loaded limited to only those required.
Code (YAML):
# Check for new version of the plugin.
check_for_update
: true
# Allow right-click with item.  Use AIR or NONE for no item.
use_right_click
:
  enabled
: true
  item
: STICK
# Translatable text (used in scoreboard and chat display options).
text
:
  drops
: Drops
# To enable the loading of specific languages only, add them to a list as follows:
#LoadLanguage = [en_us, es_es]
# Or
#LoadLanguage:
#- en_us
#- es_es
# If you want to load all the languages, add "all" to the list:
LoadLanguage
:
- all
# Enable only if you want to use the placeholders
PlaceholderAPI
:
  enabled
: false
# Enable only if you want to use the custom.yml file
CustomData
:
  enabled
: false
# Enable only if you want to display the content of an item frame
ItemFrame
:
  display_content
: false
# Enable only if you want to display the growth percentage of crops
Crops
:
  display_growth
: false
# Enable only if you want to display the facing direction and open state of trapdoors.
Trapdoor
:
  display_state
: false
# Choose the method(s) to display the block/entity info by enabling the preferred option(s).
# If the method is enabled and 'on_sneak' is also true, the info is only displayed if
# the player is 'sneaking' (holding down the Shift key).
# The prefix and actionbar text can be coloured using any of the following formats:
#    textcolor: yellow
#    textcolor: '&b&l'
#    textcolor: <#ff00ff>
Display
:
  # Enable to display the info simply by looking at the block or entity
  auto_display
: false
  # If enabled is true the custom block name will be prefixed by the name of the plugin providing the custom block.
  # Each plugin can have a different coloured prefix by specifying a prefix separately as in the examples below.
  #prefix_custom_blocks:
  #  enabled: true
  #  prefix: '&7[&f{PREFIX}&7] '
  #  Slimefun: '&7[<#ff00ff>{PREFIX}&7] '
  #  MythicMobs: '&7[&bMM&7] '
  prefix_custom_blocks
:
    enabled
: true
    prefix
: '&7 [&f {PREFIX }&7 ] '
  scoreboard
:
    enabled
: true
    on_sneak
: false
    # Maximum number of ticks that scoreboard remains visible (default 60 = 3 seconds)
    timeout
: 60
  actionbar
:
    enabled
: false
    textcolor
: WHITE
    on_sneak
: false
  bossbar
:
    enabled
: false
    textcolor
: WHITE
    on_sneak
: false
    # For available bar colors see https://hub.spigotmc.org/javadocs/spigot/org/bukkit/boss/BarColor.html
    barcolor
: GREEN
    # Maximum number of ticks that bossbar remains visible (default 60 = 3 seconds)
    timeout
: 60
    # Style refers to the number of segments the bar is divided into. Valid options are 1, 6, 10, 12 and 20.
    style
: 1
  chat
:
    enabled
: false
    name_color
: GREEN
    drop_color
: RED
    show_drops
: true
    on_sneak
: false
# List of worlds where the plugin should be disabled.
#BlacklistedWorlds:
#- world
BlacklistedWorlds
: [ ]

# If you have custom block or entity plugins installed that you want this plugin to ignore,
# for example Nova now has its own version of WAILA, set the plugin name here.
#IgnorePlugins:
#-Nova
IgnorePlugins
: [ ]

# List of common blocks that will be ignored by the plugin.
IgnoreBlocks
:
- AIR
- CAVE_AIR
- WATER
- GRASS_BLOCK
- NETHERRACK

# List of common entities that will be ignored by the plugin.
IgnoreEntities
:
- COW
- PIG
- CHICKEN

# List of custom blocks and entities that will be ignored by the plugin.
#Ignore:
#  Slimefun:
#  - Ancient Altar
#  Nova: []
#  Oraxen: []
#  ItemsAdder: []
#  MythicMobs:
#  - Skeleton King
#
Ignore
: [ ]

Placeholders
To use these placeholders, you require plugin PlaceholderAPI to be installed.
Code (Text):
%whatisthis_blockname%                           : name of the targeted  block
%whatisthis_entityname%                          : name of the targeted entity
%whatisthis_resourcename%                        : name of the resource providing the block
%whatisthis_location%                            : the location of the block
%whatisthis_locationX%                           : the X coordinate of the location of the block or entity
%whatisthis_locationY%                           : the Y coordinate of the location of the block or entity
%whatisthis_locationZ%                           : the Z coordinate of the location of the block or entity
%whatisthis_version%                             : version number of plugin

Installation
  1. Download WhatIsThis.jar
  2. Copy to your server's 'plugins' folder
  3. Restart your server

size test.png


Metrics

This plugin uses bstats to collect anonymous plugin metrics. The data is collected once every 30mins and is submitted asynchronously to the bstats server. The plugin doesn't collect any custom data, just the default bstats data which is listed on bstats.org. The metrics class is also open source and can be viewed here, or in the plugin source on GitHub.

Metrics can of course be disabled on your server but I would appreciate it if it was left enabled as the information it provides gives me an idea of how many servers are using the plugin, what versions are in use, etc. and is an incentive for me to put more of my time into development of my plugins.

[​IMG]

The pretty graphs and data from the plugin can be viewed here:
https://bstats.org/plugin/bukkit/WhatIsThis

2019-02-15_18.15.49.png


Issues and support

Join our Discord server to make it easier to discuss issues and share information.
[​IMG]

If you have a question about the plugin, use the search function on Discord -there is a good chance the question has already been answered. Any issues or suggestions can be raised on the Issues tab in the GitHub repository, or on the Spigot Discussion tab.

Please don't attempt to use the Review section to ask for help or additional features. Use one of the options listed above and provide as much information as possible. It's just not possible to diagnose and resolve a problem in the review space. Thank you.
Resource Information
Author:
----------
Total Downloads: 24,543
First Release: Feb 20, 2019
Last Update: Dec 19, 2024
Category: ---------------
All-Time Rating:
13 ratings
Version -----
Released: --------------------
Downloads: ------
Version Rating:
----------------------
-- ratings