SimpleReport (tf)

* Migrated from: https://dev.bukkit.org/projects/tf-simplereport

What is it?
SimpleReport is a plugin that provides useful, simple server information in an instant. Minecraft/Bukkit/Spigot has no ingame command for listing info about entities on the server - that problem is what this plugin grew out of. Filling this gap, SimpleReport will provide handy info on the entities, players, and worlds of your server.

Basic example of SimpleReport in action:


------------------------

Built for CraftBukkit/Spigot 1.12.X. It should be compatible with all 1.9+ versions.

------------------------

Setup

• Download the JAR to your plugins directory. Self explanatory for GUIs. For those using an Ubuntu/Debian terminal, use "wget jarurl" with the url to the jar file (go to the Files tab) in quotes. If you don't have access to the terminal the host is managing, you can try to use an FTP program to connect via SFTP and upload the jar file.

Configuration

• The only file in the data folder is the standard config.yml
• Config is very basic because it is virtually unneeded. You can use it to enable or disable certain types of information reporting.

Commands/How to Use

• /srep <ents|players|offlineplayers|worlds> [opt:selector] [opt:flags]
  • Outputs the information you requested to your chat or console
  • Perm node: simplereport.srep (default is OP)
• /srepReload
  • Reloads the configuration in memory from the config.yml file
    
  • Perm node: simplereport.reload (default is OP)

How to use the /srep command:
There are 3 distinct parts to the /srep command: /srep (1: choice of info) (2: object selector) (3: flags & filters). The (2) and (3) parts are optional, used to narrow down the information reported.

(1) Choice of Info:
SimpleReport can inform you of entities, players, offline players, and worlds. Thus, the options here are :
> entities (or ents for short)
> players
> offlineplayers (or offline for short)
> worlds

(2) Single Object Choice:
Select a more specific, single target for information.
> You can select a world by name by using /srep worlds worldname

(3) Flags & Filters:
Flags add more information to your report and filters limit what is reported so that you can focus in on the data you need. Only the players and ents choices allow flags & filters.

To use a flag, add it to the end of your command with a dash symbol, like so: /srep players -all
To use a filter, add it to the end of your command with a plus symbol, like so: /srep ents world +villager

You can use as many flags and filter in a single command as you want, in any order (it does not matter), but they all must be at the end of the command!

List of flags:

• -all
  • Works with: ents, players
  • Reports objects individually, instead of as generalized groups. By default (without the -all flag), objects are reported in groups to save chat space.
• -dist
  • Works with: ents, players
  • Tells how far an object is from you when you execute your command.
• -vitals
  • Works with: ents
  • Tells an object's health and maxhealth if it has such properties.
• -extra
  • Works with: ents
  • Tells an object's status on: invulnerability, aliveness, and vehicle occupation
• -perms
  • Works with: players
  • Tells all the effective permissions a player has. BE VERY CAREFUL WITH THIS AS IT MAY COMPLETELY FILL YOUR CHAT!
• -bed
  • Works with: players, offlineplayers
  • Tells the location of a player's bed (if the have one) or "never" if they have never slept in a bed.
• -seen
  • Works with: players, offlineplayers
  • Tells the date & time that a player was first seen & last seen on your server. The date is formatted as per your server's timezone and other localization info.
• -uuid
  • Works with: players, offlineplayers
  • Tells the UUID of a player

List of filters:

• +ENTITY_TYPE
  • Works with: ents
  • When used, your command will only show entities of the specified type. Replace ENTITY_TYPE with the type of entity you wish. You can use this filter multiple times in one command (for a group of entity types).
• +PLAYERNAME or +PLAYERUUID
  • Works with: players and offlineplayers
  • When used, your command will report info on the players that match the provided name or UUID. See the example below for a clearer picture on how to use this. You can use this filter multiple times in one command (to provide info on multiple specific players).

Example usages:

• /srep worlds gives a summary of all worlds
• /srep worlds world gives details on the world named "world"
• /srep players world_nether gives a summary of all players in the world "world_nether"
• /srep players -all -dist gives individual details on all players across all worlds, including their distance to the command executor
• /srep players world -bed gives info on all players in the world "world", including the position of their bed
• /srep players -all -dist +anthony.noobface.2007 [email protected] gives info on the players "anthony.noobface.2007" and "[email protected]"
• /srep offlineplayers -uuid gives info on all offline players, including their UUID
  
• /srep offline +Goldendark131 -seen gives info on the offline player "Goldendark131", including when they were first and last on the server
  
• /srep entities gives a summary of all entities
• /srep entities world gives a summary of entities in the world "world"
• /srep ents world +zombie +skeleton -all -vitals gives information on each individual zombie and skeleton in world "world", including health info
• /srep ents world +cow +pig +sheep +rabbit +chicken -all -vitals -dist -extra gives individual details on every cow, pig, sheep, rabbit, and chicken, including their health, distance to the command executor, and extra entity properties

_________________________________________
This plugin is provided under the MIT license. The jar file you download is yours to do practically anything with.