| .TH mcipm 1 |
| .SH NAME |
| mcipm - Minecraft Interprocess Management |
| .SH SYNOPSIS |
| .nf |
| .\"mcipm [\fI<global-options>\fR] entitystat [-Aw] [-W \fI<world>\fR] [-i \fI<entity-id>\fR] [-t \fI<type>\fR] [-o \fI<colum>\fR[,\fI<colum>\fR[\fI...\fR]|=\fI<name>\fR]] |
| mcipm [\fI<global-options>\fR] entitystat \fI<selector-option>\fR [\fI<selector-option>\fR \fI...\fR] [\fI<other-options>\fR] |
| mcipm [\fI<global-options>\fR] kill \fI<world>\fR \fI<entity-id>\fR [\fI<entity-id>\fR \fI...\fR] |
| mcipm [\fI<global-options>\fR] version |
| .fi |
| .SH DESCRIPTION |
| .PP |
| This tool perform management tasks on a running Minecraft server instance that has \fImcipm\fR mod installed. |
| .PP |
| The versions between the \fImcipm\fR mod and this tool must be match, or the behavior is unpredictable. |
| .SS Global options: |
| .TP |
| .B "-S, --socket-path <path>" |
| Specify the path of an Unix domain socket that the server is listening on. Default is \fImcipm\fR (thus in current working directory). |
| .TP |
| .B --version |
| Display version, copyright and licensing information of this tool. The program will exit afterward. |
| .RE |
| .SS Subcommands: |
| entitystat \fI<selector-option>\fR [\fI<selector-option>\fR \fI...\fR] [\fI<other-options>\fR] |
| .sp |
| .RS 4n |
| Display various data structures about entities in a Minecraft server, selected by one or more selector options. At least one selector option must be specified; if more than one selector options are specified, entities will be selected by matching at least one of specified selector. |
| .sp |
| Selector options: |
| .TP |
| .B "-A, --all" |
| Select all entities in all worlds. |
| .TP |
| .B "-W, --world <world-id-name>" |
| Select all entities in specified world. |
| .TP |
| .B "-i, --entity-id <entity-id>" |
| Select entity by a numeric ID. |
| .TP |
| .B "-t, --entity-type <entity-type>" |
| Select specified \fI<entity-type>\fR of entities. |
| .sp |
| .LP |
| Other options: |
| .TP |
| .B "-o, --format <colum>[=<title>|,<colum>[...]]" |
| Display entities information according to the \fIcolums\fR specified here. If this option being specified multiple times, later specified colums are appended to already specified colums. |
| .sp |
| Available colum names are: |
| .sp |
| .I world |
| .I id |
| .I type |
| .I name |
| .I location |
| .I rotation |
| .I state |
| .I width |
| .I height |
| .I chunk |
| .I uuid |
| .I ticks |
| .I maxhealth |
| .I health |
| .I phealth |
| .I idletime |
| .I attacktarget |
| .I growingage |
| .I itemage |
| .I itempickupdelay |
| .I owner |
| .I thrower |
| .I itemdamage |
| .I itemlifespan |
| .I itemcount |
| .sp |
| The default colums set is \fIworld,id,location,type,name\fR. |
| .TP |
| .B -w |
| By default if the last colum is \fIname\fR and stdout is a terminal, the entity name may get truncated to fit terminal window width; specify this option to disable truncation of entity names. |
| .RE |
| |
| kill \fI<world>\fR \fI<entity-id>\fR [\fI<entity-id>\fR \fI...\fR] |
| .sp |
| .RS 4n |
| Kill one or more entities by \fI<entity-id>\fR in \fI<world>\fR. The specified entities will be killed in a way that similar to the in-game command \fBkill\fR. |
| .RE |
| |
| version |
| .sp |
| .RS 4n |
| Query version information of the Minecraft server, this may include MCIPM mod version, Minecraft Forge version and Minecraft version. |
| .RE |
| |
| .SH EXAMPLES |
| .LP |
| List all chickens with their entity ID, world, location and growing age: |
| .sp |
| .in +2 |
| .nf |
| mcipm entitystat -t minecraft:chicken -o id,world,location,growingage |
| .fi |
| .in -2 |
| .sp |
| .LP |
| List all entities in overworld: |
| .sp |
| .in +2 |
| .nf |
| mcipm entitystat -W overworld -o id,type,name |
| .fi |
| .in -2 |
| |
| .SH VERSION |
| This man page describes version 1.0 of the \fBmcipm\fR tool. |
| .SH BUGS |
| It may wait for the server reply forever if the Minecraft server side failed to reply after request; in this case, press \fI^C\fR to interrupt this program. |
| |