User Tools

Site Tools


mods:ingameinfoxml

InGame Info XML

Starting with version 2.8.0.58 the variable lists bellow will no longer be updated. Please use the in-game command /igi taglist to get an up to date list of available tags.

About

InGame Info XML was originally created by DaftPVF, known as Ingame Info. DaftPVF went on a hiatus in February 2012. At that time bspkrs took over the development. InGame Info XML development started with Minecraft 1.2.5 (everything was rewritten from scratch) and both versions have been kept up to date with each other up until 1.6.4.

What does InGameInfo XML do? It's essentially a replacement for the vanilla F3 screen with more features. Want to display the name and durability of the item you're currently holding? Maybe you want to see the potion effects outside the inventory? If the answer to these or any similar questions is yes you're in the right place!

Authors

  • DaftPVF, creator or Ingame Info, latest version for Minecraft 1.0
  • bspkrs, maintainer of the text version, versions ranging from Minecraft 1.0 up to 1.6.4
  • Lunatrius, maintainer of the XML version, from Minecraft 1.2.5 on

Commands

/igi reload

Reload the last loaded configuration file. Useful for testing/debugging.

/igi load <filename>

Load the configuration from a file. The file extension determines the format.

/igi save

Save the current configuration to a file. The file extension determines the format.

/igi enable

Disable the GUI.

/igi disable

Enable the GUI.

Configuration

Anything referring to unique names only applies for Minecraft 1.7.2+. If the tag is present in earlier versions you have to use numeric ids.

List of unique names - List of numeric ids

InGameInfoXML.cfg

You can change different settings that apply to all formats in this file. The offsets should be pretty self explanatory (there's one for each of the 9 alignments). Positive values will move the text to the right/bottom, while negative numbers will move it to the left/top.

The filename tells the mod both which file to load and which format will be used to load the file. The filename can be anything, while the file extension can be on of the following (currently supported, from 1.6.4 on):

  • .xml
  • .txt
  • .json

Alignment Tags

Tag Type
topleft string
topcenter string
topright string
middleleft string
middlecenter string
middleright string
bottomleft string
bottomcenter string
bottomright string

Functions

Function Return type Description
Argument Type Argument Description
str string Returns the string passed in.
str string
num number Returns the number passed in. Can be used as a constant in calculations.
num number
var mixed Returns the value of the variable passed into the function.
str string
if mixed Returns a value based on the value of test. If the test was positive return mix1, otherwise return mix2. If mix2 is not specified an empty string is returned.
if (test == true)
  return mix1
if mix2
  return mix2
else
  return ""
test boolean
mix1 mixed
mix2 mixed optional
not boolean Return the negated value of the passed in value.
val boolean
and boolean Returns true if all of the values are true, false otherwise.
if (val1 == true and val2 == true and ...)
  return true
else
  return false
val1 boolean
val2 boolean optional
boolean optional
or boolean Returns true if any of the values is true, false otherwise.
if (val1 == true or val2 == true or ...)
  return true
else
  return false
val1 boolean
val2 boolean optional
boolean optional
xor boolean Returns true if there are an odd amount of matches, false otherwise.
if (val1 == true xor val2 == true xor ...)
  return true
else
  return false
val1 boolean
val2 boolean optional
boolean optional
greater boolean Returns true if the values are sorted in descending order, false otherwise.
if (num1 > num2 > ...)
  return true
else
  return false
num1 number
num2 number optional
number optional
less boolean Returns true if the values are sorted in ascending order, false otherwise.
if (num1 < num2 < ...)
  return true
else
  return false
num1 number
num2 number optional
number optional
equal boolean Returns true if all the values are the same, false otherwise.
if (mix1 == mix2 == ...)
  return true
else
  return false
mix1 mixed
mix2 mixed optional
mixed optional
pct number Return the percentage of the given arguments (num1 / num2 * 100).
return num1 / num2 * 100
num1 number
num2 number
concat string Returns the concatenation of all the given strings.
mix1 mixed
mix2 mixed optional
mixed optional
operation string Returns the first argument that fulfills the condition.
if mix OPERATION mix1
  return mixR1
else if mix OPERATION mix2
  return mixR2
...
else if mixDef
  return mixDef
operation string The operation to perform, supported are: GT (>), LT (<), GE (>=), LE (), EQ (==), NE (!=). First part of the list are values to be compared against, second part is what should be returned. Last argument (if odd amount of arguments) is the default value.
mix mixed Base value used for conditions (mix operation mixN).
mix1 mixed optional
mix2 mixed optional
mixed optional
mixR1 mixed optional
mixR2 mixed optional
mixed optional
mixDef mixed optional
max mixed If num1 is greater then num2 returns val1 (or mix1 if specified), otherwise returns num2 (or mix2 if specified).
if (num1 > num2)
  if mix1
    return mix1
  else
    return num1
else
  if mix2
    return mix2
  else
    return num2
num1 number
num2 number
mix1 mixed optional
mix2 mixed optional
min mixed If num1 is smaller then num2 returns num1 (or mix1 if specified), otherwise returns num2 (or mix2 if specified).
if (num1 < num2)
  if mix1
    return mix1
  else
    return num1
else
  if mix2
    return mix2
  else
    return num2
num1 number
num2 number
mix1 mixed optional
mix2 mixed optional
add number Returns the result of num1 + num2.
return num1 + num2
num1 number
num2 number
sub number Returns the result of num1 - num2.
return num1 - num2
num1 number
num2 number
mul number Returns the result of num1 * num2.
return num1 * num2
num1 number
num2 number
div number Returns the result of num1 / num2.
return num1 / num2
num1 number
num2 number
round number Returns the rounded value of num. If prec is positive the value will be rounded in the decimal part, otherwise the number will be rounded to the closest power of 10 (283.454958,2 ⇒ 283.45; 283.454958,-2 ⇒ 200).
num number
prec number
mod number Returns the remainder between num and mod (real number division).
return num % mod (double)
num number
mod number
modi number Returns the remainder between num and mod (whole number division).
return num % mod (int)
num number
mod number
itemquantity number Returns the amount of items in the player's inventory. If medatata is not specified it will be ignored.
uniquename/itemid string/number
metadata number optional
trans string Returns the translation of the given key to the current locale.
key string
icon image Returns an icon. It accepts 3 sets of arguments. The first is block/item metadata (META) and is only used for these. The other two sets are display information (DISPLAY) and texture information (TEXINFO) and are only used for custom icons.
Short: META OR (DISPLAY AND/OR TEXINFO)
what string The unique name identifier (minecraft:stone) of a block/item OR a texture path.
metadata number META The metadata of a block/item.
x number DISPLAY The relative X coordinate.
y number DISPLAY The relative Y coordinate.
width number DISPLAY The display width.
height number DISPLAY The display height.
iconx number TEXINFO The icon X of the top left corner on the texture.
icony number TEXINFO The icon Y of the top left corner on the texture.
iconwidth number TEXINFO The icon width on the texture.
iconheight number TEXINFO The icon height on the texture.
texwidth number TEXINFO The texture width.
texheight number TEXINFO The texture height.

Time Variables

Variable Type Description
day number Minecraft day, starting from 0.
mctime, mctime24 string Minecraft time (24 hour format).
mctime12 string Minecraft time (12 hour format).
mctimeh number Minecraft hour.
mctimem number Minecraft minute.
rltime, rltime24 string Real time (24 hour format).
rltime12 string Real time (12 hour format).

Player Variables

Variable Type Description
light number Light level at your current position.
lightfeet number Light level at your current position (feet level).
lightnosun number Light level at your current position without sunlight.
lightnosunfeet number Light level at your current position without sunlight (feel level).
score number Player's score.
healthpoints number Player's health points.
armorpoints number Player's armor points.
foodpoints number Player's food points.
foodsaturation number Player's food saturation.
airticks number Player's air ticks.
playerlevel number Player's level.
xpthislevel number Player's experience.
xpuntilnext number Player's experience until level up.
xpcap number Player's required total experience for the current level.
username string Player's username.
underwater, inwater boolean True if the player is underwater, false otherwise.
wet boolean True if the player is wet, false otherwise.
alive boolean True if the player is alive, false otherwise.
burning boolean True if the player is on fire, false otherwise.
riding boolean True if the player is riding, false otherwise.
sneaking boolean True if the player is sneaking, false otherwise.
sprinting boolean True if the player is sprinting, false otherwise.
invisible boolean True if the player is invisible, false otherwise.
eating boolean True if the player is eating, false otherwise.
invulnerable boolean True if the player is invulnerable, false otherwise.
potioneffect0, potioneffect1, … string Name of the specified potion effect.
potionduration0, potionduration1, … string Duration of the specified potion effect in seconds.
potiondurationticks0, potiondurationticks1, … number Duration of the specified potion effect in ticks.
potionicon0, potionicon1, … image Icon of the specified potion effect.
potionlargeicon0, potionlargeicon1, … image Large icon of the specified potion effect.
nearbyplayername0, nearbyplayername1, … string Name of the x-th nearby player.
nearbyplayerdistance0, nearbyplayerdistance1, … string Distance of the x-th nearby player.

Player Position Variables

Variable Type Description
chunkx number Player's X chunk coordinate.
chunkz number Player's Z chunk coordinate.
chunkoffsetx number Player's X chunk offset coordinate (0-15).
chunkoffsetz number Player's Z chunk offset coordinate (0-15).
x number Player's X coordinate.
y number Player's Y coordinate.
yfeet number Player's Y coordinate (feel level).
z number Player's Z coordinate.
xi number Player's X coordinate rounded to the closest whole number.
yi number Player's Y coordinate rounded to the closest whole number.
yfeeti number Player's Y coordinate rounded to the closest whole number (feel level).
zi number Player's Z coordinate rounded to the closest whole number.
speed number Player's speed.
speedx number Player's speed along the x axis.
speedy number Player's speed along the y axis.
speedz number Player's speed along the z axis.
speedxz number Player's speed horizontally.
direction number Player's direction in degrees from -180 to 180.
roughdirection string Rough direction the player is currently facing (South, West, North, East).
finedirection string Fine direction the player is currently facing (South, South West, West, North West, North, North East, East, South East).
abrroughdirection string Abbreviated rough direction the player is currently facing (S, W, N, E).
abrfinedirection string Abbreviated fine direction the player is currently facing (S, SW, W, NW, N, NE, E, SE).
directionhud string A small textual direction HUD.

Player Equipment Variables

Variable Type Description
equippeduniquename string Equipped item's unique name.
equippedname string Equipped item's name.
equippedmaxdamage number Equipped item's max damage.
equippeddamage number Equipped item's damage.
equippeddamageleft number Equipped item's damage left.
equippedicon image Equipped item's icon.
equippedlargeicon image Equipped item's large icon.
helmetuniquename string Helmet's unique name.
helmetname string Helmet's name.
helmetmaxdamage number Helmet's max damage.
helmetdamage number Helmet's damage.
helmetdamageleft number Helmet's damage left.
helmeticon image Helmet's icon.
helmetlargeicon image Helmet's large icon.
chestplateuniquename string Chestplate's unique name.
chestplatename string Chestplate's name.
chestplatemaxdamage number Chestplate's max damage.
chestplatedamage number Chestplate's damage.
chestplatedamageleft number Chestplate's damage left.
chestplateicon image Chestplate's icon.
chestplatelargeicon image Chestplate's large icon.
leggingsuniquename string Leggings' unique name.
leggingsname string Leggings' name.
leggingsmaxdamage number Leggings' max damage.
leggingsdamage number Leggings' damage.
leggingsdamageleft number Leggings' damage left.
leggingsicon image Leggings' icon.
leggingslargeicon image Leggings' large icon.
bootsname string Boots' name.
bootsmaxdamage number Boots' max damage.
bootsdamage number Boots' damage.
bootsdamageleft number Boots' damage left.
bootsicon image Boots' icon.
bootslargeicon image Boots' large icon.
equippedquantity number Quantity of the equipped item (including items of the same type in the inventory).

World Variables

Variable Type Description
worldname string World name.
worldsize number World size.
worldsizemb number World size in MiB.
seed number World seed.
difficulty string World difficulty name.
difficultyid number World difficulty id.
gamemode string Gamemode name.
gamemodeid number Gamemode id.
dimension string Dimension name.
dimensionid number Dimension id.
biome string Biome name.
biomeid number Biome id.
entitiesrendered number Amount of rendered entities.
entitiestotal number Amount of total entities.
loadedchunks number Amount of loaded chunks on the client.
daytime boolean True if it's daytime, false otherwise.
raining boolean True if it's raining, false otherwise.
thundering boolean True if it's thundering, false otherwise.
snowing boolean True if it's snowing, false otherwise.
nextrain string Time until the next rain.
slimes boolean True if the current chunk is a slime chunk, false otherwise.
hardcore boolean True if the world is in hardcore mode, false otherwise.

Color Variables

Variable Type Description
black string Color code 0 (#000000).
darkblue, navy string Color code 1 (#0300AA).
darkgreen, green string Color code 2 (#02AA01).
darkaqua, darkcyan, turquoise string Color code 3 (#05AAAA).
darkred string Color code 4 (#AA0000).
purple, violet string Color code 5 (#AA00AA).
orange, gold string Color code 6 (#FFAA02).
lightgrey, lightgray, grey, gray string Color code 7 (#AAAAAA).
darkgrey, darkgray, charcoal string Color code 8 (#555555).
blue, lightblue, indigo string Color code 9 (#5554FF).
brightgreen, lightgreen, lime string Color code a (#55FF55).
aqua, cyan, celeste, diamond string Color code b (#57FFFF).
red, lightred, salmon string Color code c (#FF5555).
magenta, pink string Color code d (#FF55FF).
yellow string Color code e (#FFFF56).
white string Color code f (#FFFFFF).
random string Color code k (random characters).
bold, b string Color code l (bold text).
strikethrough, strike, s string Color code m (strikethrough text).
underline, u string Color code n (underlined text).
italic, italics, i string Color code o (italics text).
reset, r string Color code r (reset all color/formatting).

Miscellaneous Variables

Variable Type Description
fps number Current FPS.
mouseovername string Name of the entity or block under the cursor, an empty string if there is nothing.
mouseoveruniquename string Unique name of the entity or block under the cursor, an empty string if there is nothing.
mouseoverid number Entity id or block id under the cursor, zero if there is nothing.
mouseovermetadata number Block metadata under the cursor, zero if there is nothing.
mouseoverpowerweak number Weak redstone power of the block, -1 if there is nothing.
mouseoverpowerstrong number Strong redstone power of the block, -1 if there is nothing.
mouseoverpowerinput number Input redstone power of the block, -1 if there is nothing.
resourcepack string Player's resourcepack.
memmax number Amount of maximum memory.
memtotal number Amount of total memory.
memfree number Amount of free memory.
memused number Amount of used memory.
server string Server domain or IP and the port if it's not 25565, localhost if it's a local game.
servername string Server domain, localhost if it's a local game.
serverip string Server IP, 127.0.0.1 if it's a local game.
ping number Player ping, -1 if no data.
pingicon image Player ping icon, blank string if no data.
mods/ingameinfoxml.txt · Last modified: 2015/11/16 01:09 (external edit)