mcipm(1)                    General Commands Manual                   mcipm(1)



NAME
       mcipm - Minecraft Interprocess Management

SYNOPSIS
       mcipm [<global-options>] entitystat <selector-option> [<selector-option> ...] [<other-options>]
       mcipm [<global-options>] kill <world> <entity-id> [<entity-id> ...]
       mcipm [<global-options>] version

DESCRIPTION
       This tool perform management tasks on a running Minecraft server
       instance that has mcipm mod installed.

       The versions between the mcipm mod and this tool must be match, or the
       behavior is unpredictable.

   Global options:
       -S, --socket-path <path>
              Specify the path of an Unix domain socket that the server is
              listening on. Default is mcipm (thus in current working
              directory).

       --version
              Display version, copyright and licensing information of this
              tool. The program will exit afterward.

   Subcommands:
       entitystat <selector-option> [<selector-option> ...] [<other-options>]

           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.

           Selector options:

           -A, --all
                  Select all entities in all worlds.

           -W, --world <world-id-name>
                  Select all entities in specified world.

           -i, --entity-id <entity-id>
                  Select entity by a numeric ID.

           -t, --entity-type <entity-type>
                  Select specified <entity-type> of entities.


           Other options:

           -o, --format <colum>[=<title>|,<colum>[...]]
                  Display entities information according to the colums
                  specified here. If this option being specified multiple
                  times, later specified colums are appended to already
                  specified colums.

                  Available colum names are:

                  world id type name location rotation state width height
                  chunk uuid ticks maxhealth health phealth idletime
                  attacktarget growingage itemage itempickupdelay owner
                  thrower itemdamage itemlifespan itemcount

                  The default colums set is world,id,location,type,name.

           --sort [+|-]<colum>[,[+|-]<colum>[...]]
                  Sort the output lines based on specified colums; + or -
                  character specifies the sorting direction of given colum,
                  default is +. The colum names are same as what describes for
                  -o or --format option.

           -w     By default if the last colum is name 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.

       kill <world> <entity-id> [<entity-id> ...]

           Kill one or more entities by <entity-id> in <world>. The specified
           entities will be killed in a way that similar to the in-game
           command kill.

       version

           Query version information of the Minecraft server, this may include
           MCIPM mod version, Minecraft Forge version and Minecraft version.


EXAMPLES
       List all chickens with their entity ID, world, location and growing
       age:

         mcipm entitystat -t minecraft:chicken -o id,world,location,growingage


       List all entities in overworld:

         mcipm entitystat -W overworld -o id,type,name


VERSION
       This man page describes version 1.0 of the mcipm tool.

BUGS
       It may wait for the server reply forever if the Minecraft server side
       failed to reply after request; in this case, press ^C to interrupt this
       program.




BSD                                                                   mcipm(1)