GrabBag

Summary: Collection of miscellaneous commands and listener modules
PocketMine-MP version: 1.7dev API 3.0.0-ALPHA9)
DependencyPlugins:
OptionalPlugins: FastTransfer
Categories: General
Plugin Access: Internet Services, Other Plugins, Manages Permissions, Commands, Data Saving, Entities, Tile Entities, Manages Plugins

Overview

This documentation was last updated for version 2.4.0

A miscellaneous collection of commands and listener modules. All features can be configured to be disabled|enabled so as to co-exist with other plugins.

This plugin is focused more towards commands to help system administration.

Entity Management

entities: entity management

Informational

ops: Shows who are the ops on this server.
players: Shows what players are on-line
showtimings: Shows timing repots as reported by timings
whois: Gives detailed information on players

Inventory Management

clearhotbar: Clear player's hotbar
clearinv: Clear player's inventory
get: obtain an item
gift: give an item to a player
rminv: Remove item from player's Inventory
seearmor: Show player's armor
seeinv: Show player's inventory
setarmor: Sets armor (even in creative)

Player Management

as: run command as somebody else
clearchat: Clears your chat window
fly: Toggle flying ONLY FOR PM >1.5
gma: Change your gamemode to Adventure.
gmc: Change your gamemode to Creative.
gms: Change your gamemode to Survival.
gmspc: Change your gamemode to Spectator.
invis: makes player invisible
nick: Change your display name
perm: temporarily change player's permissions
prefix: prepend prefix to chat lines
reg: Manage player registrations
reop: Let ops drop priviledges temporarily
shield: player is protected from taking damage
skin: manage player's skins

Server Management

after: schedule command after a number of seconds
alias: Create a new command alias
at: schedule command at an appointed date/time
crash: manage crash dumps
opms: sends a message to ops only
pluginmgr: manage plugins
query: query remote servers
rcon: rcon client
rpt: report an issue to ops
servers: Manage peer server connections
servicemode: controls servicemode

Teleporting

dismiss: Dismiss a previously summoned player
follow: Follow a player
follow-off: stop following a player
followers: List who is following who
followme: Make a player follow you
followme-off: stop making a player follow you
ftserver: Travel to remove servers
poptp: Returns to the previous location
pushtp: Saves current location and teleport
spawn: Teleport player to spawn point
summon: Summons a player to your location

Trolling

blowup: explode a player
burn: Burns the specified player
chat-on|chat-off: Allow players to opt-out from chat
freeze|thaw: freeze/unfreeze a player so they cannot move.
heal: Restore health to a player
mute|unmute: mutes/unmutes a player so they can not use chat
slay: Kills the specified player
spectator|unspectator: toggle a player's spectator mode (DEPRECATED)
throw: Throw a player in the air

Modules

blood-particles: Display particles when a player gets hit
broadcast-ft: Broadcast player's using FastTransfer
broadcast-tp: Broadcast player teleports
cmd-selector: Implements "@" command prefixes
join-mgr: Announce joining ops, and show server motd
repeater: Uses !! to repeat command with changes

Documentation

This plugin collects a number of commands and listener plugins that I find useful and wanted to have in a single plugin rather through multiple ones. The available commands and listener modules can be configured. This allows this plugin to co-exist peacefully with other plugins.

Command Reference

The following commands are available:

after: schedule command after a number of seconds

usage: after |list|cancel

Will schedule to run command after seconds. The list sub command will show all the queued commands. The cancel sub command allows you to cancel queued commands.

alias: Create a new command alias

usage: alias [-f] [options]

Create an alias to a command. Use the -f to override existing commands

as: run command as somebody else

usage: as

at: schedule command at an appointed date/time

usage: at [:] _|list|cancel

Will schedule to run command at the given date/time. This uses php's strtotime function so times must follow the format described in Date and Time Formats. The list sub command will show all the queued commands. The cancel sub command allows you to cancel queued commands.

blowup: explode a player

usage: blowup [yield] [magic] [normal]

Explodes player with an explosion with the given yield (a number). If magic is specified no damage will be taken by blocks. The default is normal, where blocks do get damaged.

burn: Burns the specified player

usage: burn [secs]

Sets player on fire for the specified number of seconds. Default is 15 seconds.

chat-on|chat-off: Allow players to opt-out from chat

usage: chat-on|chat-off [player|--list|--server]

Prevents players from sending/receiving chat messages. The following options are recognized:

--list : Lists the players that have chat on/off status
--server : Globally toggles on/off chat.

clearchat: Clears your chat window

usage: clearchat

clearhotbar: Clear player's hotbar

usage: clearhotbar [player]

clearinv: Clear player's inventory

usage: clearinv [player]

crash: manage crash dumps

usage: crash [ls|clean|show]

Will show the number of crash files in the server. The following optional sub-commands are available:

crash count

Count the number of crash files

crash ls [pattern]

List crash files

crash clean [pattern]

Delete crash files

show [pattern]

Shows the crash file ##

dismiss: Dismiss a previously summoned player

usage: dismiss [message]

entities: entity management

usage: entities [subcommand] [options]

By default it will show the current entities. The following sub-commands are available:

entities ls [world]

Show entities in [world] (or current world if not specified).

entities tiles [world]

Show tile entities in [world] (or current world if not specified).

entities info [e#|t#]

Show details about one or more entities or tiles.

entities rm [e#]

Removes one or more entities.

entities signN [t#] message text

Changes the text line N in the tile/sign identified by t#.

entities count

Show a count of the number of entities on the server.

entities nuke [all|mobs|others]

Clear entities from the server.

Additionally, tiles can be specified by providing the following:

t(x),(y),(z)[,world]

fly: Toggle flying ONLY FOR PM >1.5

usage: fly

follow: Follow a player

usage: follow

follow-off: stop following a player

usage: follow-off

followers: List who is following who

usage: followers

followme: Make a player follow you

usage: folowme

followme-off: stop making a player follow you

usage: followme-off

freeze|thaw: freeze/unfreeze a player so they cannot move.

usage: freeze|thaw [ player | --hard|--soft ]

Stops players from moving. If no player specified it will show the list of frozen players.

If --hard or --soft is specified instead of a player name, it will change the freeze mode.

ftserver: Travel to remove servers

usage: ftserver

Teleport to servers defined with the /servers command.

get: obtain an item

usage: get [count]

This is a shortcut to give that lets player get items for themselves. You can replace item with more and the current held item will be duplicated.

gift: give an item to a player

usage: gift [player] [count]

This is a re-implementation of give command.

gma: Change your gamemode to Adventure.

usage: gma

gmc: Change your gamemode to Creative.

usage: gmc

gms: Change your gamemode to Survival.

usage: gms

gmspc: Change your gamemode to Spectator.

usage: gmspc

heal: Restore health to a player

usage: heal [player] [ammount]

Heals a player. If the amount is positive it will heal, if negative the player will be hurt. The units are in 1/2 hearts.

invis: makes player invisible

usage: invis This will toggle your invisibility status.

mute|unmute: mutes/unmutes a player so they can not use chat

usage: mute|unmute [player]

Stops players from chatting. If no player specified it will show the list of muted players.

nick: Change your display name

usage: nick

opms: sends a message to ops only

usage: opms [msg]

Sends chat messages that are only see by ops. Only works with ops that are on-line at the moment. If you no ops are on-line you should use the rpt command.

ops: Shows who are the ops on this server.

usage: ops

perm: temporarily change player's permissions

usage: perm <dump|permission> [true|false]

This can be used to temporarily change player's permissions. Changes are only done in-memory, so these will revert if the disconnects or the server reloads. You can specify a permission and it will show it's value or if true|false is specified it will be changed. If you specify dump, it will show all permissions associated to a player.

players: Shows what players are on-line

usage: players

pluginmgr: manage plugins

usage: pluginmgr

Manage plugins. The following sub-commands are available:

pluginmgr enable

Enable a disabled plugin.

pluginmgr disable

Disables an enabled plugin.

pluginmgr reload

Disables and enables a plugin.

pluginmgr info

Show plugin details

pluginmgr commands

Show commands registered by plugin

pluginmgr permissions

Show permissions registered by plugin

pluginmgr load

Load a plugin from file path (presumably outside the plugin folder.)

pluginmgr dumpmsg [lang]

Dump messages.ini.

pluginmgr uninstall

Uninstall plugin.

pluginmgr feature [[-|+]feature]

For plugins that have a features table in config.yml this will let you change those settings.

poptp: Returns to the previous location

usage: poptp

prefix: prepend prefix to chat lines

usage: prefix [-n]

This allows you to prepend a prefix to chat lines. To stop enter /prefix by itself (or prefix at the console). Usage examples:

Send multiple /as player commands in a row.
Start a private chat /tell player with another player.
You prefer commands over chat: /prefix -n /

When prefix is enabled and you one to send just one command without prefix, prepend your text with <.

pushtp: Saves current location and teleport

usage: pushtp [target]

query: query remote servers

usage: query [list|info|plugins|players|summary] [opts]

This is a query client that you can use to query other remote servers.

Servers are defined with the servers command.

Options:

query list

List players on all configured query connections.

query info

Return details from query

query players

Return players on specified server

query plugins

Returns plugins on specified server

query summary

Summary of server data

rcon: rcon client

usage: rcon

This is an rcon client that you can used to send commands to other remote servers identified by id.

You can specify multiple targets by separating with commas (,). Otherwise, you can use --all keyword for the id if you want to send the commands to all configured servers.

Use the servers command to define the rcon servers.

reg: Manage player registrations

usage: reg [subcommand] [options]

By default it will show the number of registered players. The following sub-commands are available:

count

default sub-command. Counts the number of registered players.

list [pattern]

Display a list of registered players or those that match the wildcard pattern.

Removes player registration.

since

Display list of players registered since a date/time.

reop: Let ops drop priviledges temporarily

usage: reop [player]

Will drop op priviledges from player. Player can get op back at any time by enter reop again or by disconnecting.

rminv: Remove item from player's Inventory

usage: rminv [player] [quantity]

rpt: report an issue to ops

usage: rpt [message|read|clear <all|##>]

Logs/reports an issue to server ops. These issues are stored in a a file which can be later read by the server operators. Use this when there are no ops on-line. If there are ops on-line you should use the opms command.

The following ops only commands are available:

rpt read [##]

reads reports. You can specify the page by specifying a number.

rpt clear <all|##>

will delete the specified report or if all, all the reports.

seearmor: Show player's armor

usage: seearmor

seeinv: Show player's inventory

usage: seeinv

servers: Manage peer server connections

usage: servers <add|rm|ls> [options]

This is used to manage the peer server definitions used by the RCON and QUERY modules.

Options:

servers add [port] [--rcon-port=port] [--rconpw=secret] [# comments]

adds a new connection with id

servers rm

Removes peer id.

servers ls

List configured peers.

servicemode: controls servicemode

usage: servicemode [on|off [message] ]

If on it will activate service mode. In service mode new players can not join (unless they are ops). Existing players can remain but may be kicked manually by any ops.

setarmor: Sets armor (even in creative)

usage: setarmor [player] [part]

This command lets you armor up. It can armor up creative players too. If no player is given, the player giving the command will be armored.

Part can be one of head, body, legs, or boots.

Quality can be one of none, leather, chainmail, iron, gold or diamond.

shield: player is protected from taking damage

usage: shield

This will toggle your shield status.

showtimings: Shows timing repots as reported by timings

usage: timings [t#]

If nothing specified it will list available reports. These are of the form of timings.txt or timings1.txt.

To specify a report enter t for timings.txt or t1 for timings1.txt.

skin: manage player's skins

usage: skin [player] [save|load|ls] [name]

Manipulate player's skins on the server. Sub-commands:

skin ls

List all available skins on the server. Default command.

skin [player] save

Saves player's skin to name.

skin [player] load

Loads player's skin from name.

slay: Kills the specified player

usage: slay [messsage] Kills a player with an optional message.

spawn: Teleport player to spawn point

usage: spawn

spectator|unspectator: toggle a player's spectator mode (DEPRECATED)

usage: spectator|unspectator [player]

This command will turn a player into an spectator. In this mode players can move but not interact (i.e. can't take/give damage, can't place/break blocks, etc).

If no player was specified, it will list spectators.

summon: Summons a player to your location

usage: summon [message]

throw: Throw a player in the air

usage: throw [force]

whois: Gives detailed information on players

usage: whois

Commands scheduled by at and after will only run as long as the server is running. These scheduled commands will not survive server reloads or reboots. If you want persistent commands, it is recommended that you use a plugin like TimeCommander

blood-particles

Display particles when a player gets hit

broadcast-ft

Broadcast player's using FastTransfer

This listener module will broadcast when a player uses FastTransfer

broadcast-tp

Broadcast player teleports

This listener module will broadcast when a player teleports to another location. It also generates some smoke and plays a sound.

cmd-selector

Implements "@" command prefixes

Please refer to the CommandSelector section

join-mgr

Announce joining ops, and show server motd

This listener module will broadcast a message for ops joining a server.

Also, it will show the server's motd on connect.

repeater

Uses !! to repeat command with changes

If you want to repeat a previous command enter !! without any "/" in front. This works for commands and chat messages.

You can optionally append additional text to !! to do certain things:

!! number

Will let you paginate output. For example, entering:
/mw ls
!!2
!!3
This will start showing the output of /mw ls and consecutive pages.

!! /

if you forgot the "/" in front, this command will add it. Example:
help
!!/

!! text

Will append text to the previous command. For example:
/gamemode
!! survival john
This will show the usage of survival, the next line will change the gamemode of john to survival.

!! str1 str2

Will repeat the previous command replacing str1 with str2 Example:
/give player drt
!!drt dirt
This will change drt into dirt.

!!^ text

Will insert text at the beginning of the command.

Command Selectors

This adds "@" prefixes for commands. See

Command Prefixes

for an explanation on prefixes.

This only implements the following prefixes:

@a - all players
@e - all entities (including players)
@r - random player/entity

The following selectors are implemented:

c: (only for @r),count
m: game mode
type: entity type, use Player for player.
name: player's name
w: world

Configuration

Configuration is through the config.yml file. The following sections are defined:

broadcast-tp

world: world broadcast setting. If true, will broadcast teleports accross worlds.
local: local broadcast setting. This will broadcast teleports that go beyond this number.

cmd-selector…