Variable Reference

The wiki has moved!
New Page: https://customhud.dev/v2/variables

(Sorry, will be sorted better later)

Variable	Description	Number Value	Boolean Value	Flags
{stat:<stat>} {stat:<type>:<value>}	Retrieve a stat	value saved in the stat	if value > 0	Precision & Scale, Formatted
{version}	The minecraft version. (Ex: 1.16.2, 20w34a)	length of output	length of output > 0	String
{client_version}	Game Version: (probably fabric)	length of output	length of output > 0	String
{modded_name}	Client Brand Name: (probably Fabric)	length of output	length of output > 0	String
{fps}	Frames per Second	the fps	true	None
{max_fps}	Fps Limit set in the settings. - if set to max	the max fps	false if the limit is set to max, true otherwise	None
{vsync}	If vsync is enabled or not	0 (off), 1 (on)	if vsync is enabled	None
{graphics_mode}	Graphics Quality (Fast, Fancy, or Fabulous)	0 (fast), 1 (fancy), 2 (fabulous)	true	String
{clouds}	Cloud Quality (Off, Fast, Fancy)	0 (off), 1 (fast), 2 (fancy)	if clouds are on	String
{biome_blend}	The player's biome blend setting	the biome blend	if biome blend is enabled	None
{tps}	How many ticks happen every second on the integrated server. Maxes to 20 - Singleplayer Only	the millisecond it takes for a tick	if it can get the value (aka you're in singleplayer)	None
{ms_ticks}	The time it takes for a tick on the integrated server in milliseconds - Singleplayer Only	the millisecond it takes for a tick	if it can get the value (aka you're in singleplayer)	None
{tx} / {packets_sent}	Number of packets sent by the client to the server	number of packets	true	None
{rx} / {packets_received}	Number of packets received by the client from the server	number of packets	true	None
{chunks_rendered}	Number of chunks being rendered	number of chunks	true	None
{chunks_loaded}	Number of chunks in the loaded area	number of chunks	true	None
{chunks_culling}	If Chunk culling is on	0 (off), 1 (on)	if chunk culling is on	None
{slime_chunk}	If the chunk is a slime chunk	0 (false), 1 (true)	if chunk is slime chunk	None
{render_distance}	The player’s render distance setting	render distance	if more than 0	None
{queued_tasks}	Pending chunks to be batched (pC in the F3 screen)	pending chunks	if more than 0	None
{upload_queue}	Pending uploads to video card (pU in the F3 screen)	pending upload	if more than 0	None
{buffer_count}	Available buffers to use in the batching process. (aB in the F3 screen)	available buffers	if more than 0	None
{entities_rendered}	Number of entities being rendered	entities rendered	if more than 0 entities	None
{entities_loaded}	Total entities in the loaded area	total entities	if more than 0 entities	None
{sd} / {simulation_distance}	Simulation Distance set in the settings	simulation distance	true	None
{p} / {particles}	Number of particles visable or loaded (not sure)	number of particles	if more than 0 particles	None
{dimension}	The dimention the player is in. Ex: “Overworld”, “The Nether”, "The End"	length of output	length of output > 0	String
{dimension_id}	The id of the dimension the player is in. Ex: “minecraft:overworld”, “minecraft:the_nether”	length of output	length of output > 0	String
{fc} / {force_loaded_chunks}	Number of forced loaded chunks	number of chunks	number of chunks > 0	None
{x}	The player’s x coordinate, Ex: 320.153	x coordinate	true	Precision & Scale
{y}	The player’s y coordinate, Ex: 80.459	y coordinate	true	Precision & Scale
{z}	The player’s z coordinate, Ex: 1200.963	z coordinate	true	Precision & Scale
{bx} / {block_x}	The x coordinate of the block the player’s feet is at. Ex: 320	x coordinate	true	None
{by} / {block_y}	The y coordinate of the block the player’s feet is at. Ex: 80	y coordinate	true	None
{bz} / {block_z}	The z coordinate of the block the player’s feet is at. Ex: 1200	z coordinate	true	None
{icx} / {in_chunk_x}	The player’s x coordinate inside the chunk (bound between 0-15)	in chunk x	true	None
{icy} / {in_chunk_y}	The player’s y coordinate inside the chunk (bound between 0-15)	in chunk y	true	None
{icz} / {in_chunk_z}	The player’s z coordinate inside the chunk (bound between 0-15)	in chunk z	true	None
{cx} / {chunk_x}	The chunk’s x coordinate (so every 16 blocks in the x direction, this goes up by 1)	chunk x	true	None
{cy} / {chunk_y}	The chunk’s y coordinate (so every 16 blocks in the y direction, this goes up by 1)	chunk y	true	None
{cz} / {chunk_z}	The chunk’s z coordinate (so every 16 blocks in the z direction, this goes up by 1)	chunk z	true	None
{rex} / {region_x}	Region X	the x	if x > 0	None
{rez} / {region_z}	Region Z	the z	if z > 0	None
{rrx} / {region_relative_x}	Region Relative X	the x	if x > 0	None
{rrz} / {region_relative_z}	Regixon Relative Z	the z	if z > 0	None
{facing}	The cardinal direction the player is facing. (North, South, East, West)	length of output	true	String
{facing_short}	The cardinal direction the player is facing, but shorter. (N, S, E, W)	length of output (1)	true	String
{facing_towards_pn_word} OR {facing_towards_pn_sign}	If the player is looking at the positive or negative direction of the axis - Word: positive or negative - Sign: + or -	0 (negative), 1 (positive)	if facing a positive direction (east/south)	String
{facing_towards_xz}	Which horizontal axis the player is facing (x or z)	length of output	true	String
{yaw}	The yaw rotation of the player	the yaw	if the yaw is positive	Precision & Scale
{pitch}	The pitch rotation of the player	the pitch	if the pitch is positive	Precision & Scale
{light} / {client_light}	The total light level of where the player is.	light level	false if can't get info	None
{light_sky} / {client_light_sky}	The light level of where the player is that’s from the sky (reported by the client)	light level from sky	false if can't get info	None
{light_block} / {client_light_block}	The light level of where the player is that’s from blocks (reported by the client)	light level from block	false if can't get info	None
{moon_phase}	The phase of the moon (1-8)	the moon phase	true	None
{moon_phase_word}	The phase of the moon in words	length of output	true	String
{chs}	The Y coordinate of the highest non-air block at the player’s X/Z coordinate. (reported by the client)	the y coordinate	false if can't get info	None
{chm}	The Y coordinate of the highest block at the player’s X/Z coordinate that has a blocking-motion material or is liquid. (reported by the client)	the y coordinate	false if can't get info	None
{shs}	The Y coordinate of the highest non-air block at the player’s X/Z coordinate. (reported by the server)	the y coordinate	false if can't get info	None
{shm}	The Y coordinate of the highest block at the player’s X/Z coordinate that has a blocking-motion material or is liquid. (reported by the server)	the y coordinate	false if can't get info	None
{sho}	The Y coordinate of the highest block at the player’s X/Z coordinate that has a blocking-motion material. (reported by the server)	the y coordinate	false if can't get info	None
{shm}	The Y coordinate of the highest block at the player’s X/Z coordinate that has a blocking-motion material or is liquid. (reported by the server)	the y coordinate	false if can't get info	None
{shml}	The Y coordinate of the highest block at the player’s X/Z coordinate that has a blocking-motion material and is not leaves. (reported by the server)	the y coordinate	false if can't get info	None
{biome}	The biome the player is in. Ex: “Plains", “Desert”	length of output	length of output > 0	String
{biome_id}	The id of the biome the player is in. Ex: “minecraft:plains”, “minecraft:desert”	length of output	length of output > 0	String
{local_difficulty}	Shows the difficulty of the chunk the player is in	the local difficulty	true	Precision & Scale
{clamped_local_difficulty}	Shows the difficulty of the chunk the player is in (clamped)	the clamped local difficulty	true	Precision & Scale
{day}	The number of in-game days the player has been in the world	number of days	true	Precision & Scale
{sc} / {spawn_chunks}	The total amount of spawn chunks in the world (usually 289).	number of spawn chunks	if greater than 0	None
{monsters}	Total amount of monsters in the loaded chunks	number of mobs	if greater than 0	None
{creatures}	The total amount of creatures in the loaded chunks	number of mobs	if greater than 0	None
{ambient_mobs}	The total amount of ambient mobs in the loaded chunks	number of mobs	if greater than 0	None
{axolotls}	The total amount of axolotls in the loaded chunks	number of mobs	if greater than 0	None
{underground_water_creature}	The total amount of underground water creature mobs in the loaded chunks	number of mobs	if greater than 0	None
{water_creatures}	The total amount of water creatures in the loaded chunks	number of mobs	if greater than 0	None
{water_ambient_mobs}	The total amount of ambient water mobs in the loaded chunks	number of mobs	if greater than 0	None
{misc_mobs}	The total amount of miscellaneous mobs in the loaded chunks	number of mobs	if greater than 0	None
{sounds} / {streaming_sounds}	The number of streaming sounds currently playing (like breaking/placing blocks)	number of spawn chunks	if greater than 0	None
{max_sounds} / {max_streaming_sounds}	The max amount of streaming sounds that can play at once	number of mobs	if greater than 0	None
{static_sounds}	The number of static sounds currently playing (ambient sounds)	number of mobs	if greater than 0	None
{max_static_sounds}	The max amount of static sounds that can play at once	number of mobs	if greater than 0	None
{mood}	How close the player is to the next mood ambience sound being played	number of mobs	if greater than 0	None
{java_version}	The version of java	length of output	length of output > 0	None
{java_bit}	If the java running is 32bit or 64bit	32 or 64	true	None
{cpu} / {cpu_usage}	CPU Usage	cpu usage	true	Precision & Scale
{gpu} / {gpu_usage}	GPU Usage	gpu usage	true	Precision & Scale
{memory_used_percentage}	Percentage of used memory to total memory	percentage of used memory	true	Precision and Scale
{memory_used}	Memory being used	memory used	true	None
{memory_total}	Total memory minecraft has access to	total memory	true	None
{memory_allocated_percentage}	Percentage of allocated to total memory	percentage of allocated memory	true	Precision and Scale
{memory_allocated}	Total memory will attempt to use	allocated memory	true	None
{off_heap}	Memory that's off the heap - Shown in F3 when Sodium or Iris is installed - Still works without them though	memory that's off the heap	true	Precision and Scale
{display_width}	Minecraft’s windows width	the width	if greater than 0	None
{display_height}	Minecraft’s windows height	the height	if greater than 0	None
{display_refresh_rate}	Minecraft’s windows refresh rate	the refresh rate	if greater than 0	None
{cpu_name}	The name of the CPU	length of name	length of output > 0	String
{gpu_name}	The name of the GPU	length of name	length of output > 0	String
{cpu_cores}	Minecraft’s windows refresh rate	the refresh rate	if greater than 0	None
{cpu_threads}	Minecraft’s windows refresh rate	the refresh rate	if greater than 0	None
{server_light_sky}	The light level of where the player is that’s from the sky (reported by the server)	light level from sky	false if can't get info	None
{server_light_block}	The light level of where the player is that’s from blocks (reported by the server)	light level from block	false if can't get info	None
{mods}	The amount of mods installed	mods installed	true	None
{ping}	The ping to the server	the ping	if greater than 0	None
{address}	The address (as written in the address field) of the server	length of output	length of output > 0	String
{velocity_xz}	Horizontal (XZ) velocity in blocks per second	the velocity	if greater than 0	Precision & Scale
{velocity_y}	Vertical (Y) velocity in blocks per second	the velocity	if greater than 0	Precision & Scale
{velocity_xyz}	Total (XYZ) velocity in blocks per second	the velocity	if greater than 0	Precision & Scale
{velocity_xz_kmh}	Horizontal (XZ) velocity in kilometers per hour (km/h)	the velocity	if greater than 0	Precision & Scale
{velocity_y_kmh}	Vertical (Y) velocity in kilometers per hour (km/h)	the velocity	if greater than 0	Precision & Scale
{velocity_xyz_kmh}	Total (XYZ) velocity in kilometers per hour (km/h)	the velocity	if greater than 0	Precision & Scale
{hour} / {hour12}	In Minecraft’s time scale	the hour	true	None
{hour24}	In Minecraft’s time scale	the hour	true	None
{minute}	In Minecraft’s time scale	the minute	true	None
{am_pm}	In Minecraft’s time scale	length of output	length of output > 0	String
{real_time:time_format}	Displays the irl time, based on the format in time_format . For formatting look here	length of output	length of output > 0	String
{target_block}	The name of the block the player's looking at	length of output	if the player is looking at a block	String
{target_block_id}	The id of the block the player's looking at	length of output	if the player is looking at a block	String
{tbx} / {target_x} / {target_block_x}	The x coordinate of the block the player’s looking at	x coordinate	if the player is looking at a block	None
{tby} / {target_y} / {target_block_y}	The y coordinate of the block the player’s looking at	y coordinate	if the player is looking at a block	None
{tbz} / {target_z} / {target_block_z}	The z coordinate of the block the player’s looking at	z coordinate	if the player is looking at a block	None
{target_fluid}	The name of the fluid the player's looking at	length of output	if the player is looking at a fluid	String
{target_fluid_id}	The id of the fluid the player's looking at	length of output	if the player is looking at a fluid	String
{tfx} / {target_fluid_x}	The x coordinate of the fluid the player’s looking at	x coordinate	if the player is looking at a fluid	None
{tfy} / {target_fluid_y}	The y coordinate of the fluid the player’s looking at	y coordinate	if the player is looking at a fluid	None
{tfz} / {target_fluid_z}	The z coordinate of the fluid the player’s looking at	z coordinate	if the player is looking at a fluid	None
{target_entity}	The name of the entity the player's looking at	length of output	if the player is looking at a entity	String
{target_entity_id}	The id of the entity the player's looking at	length of output	if the player is looking at a entity	String
{tex} / {target_entity_x}	The x coordinate of the entity the player’s looking at	x coordinate	if the player is looking at a entity	None
{tey} / {target_entity_y}	The y coordinate of the entity the player’s looking at	y coordinate	if the player is looking at a entity	None
{tez} / {target_entity_z}	The z coordinate of the entity the player’s looking at	z coordinate	if the player is looking at a entity	None
{item}	Name of item in player's main hand	length of output	length of output > 0	String
{item_id}	Id of item in player's main hand	length of output	length of output > 0	String
{item_dur} / {item_durability}	Durability of item in player's main hand	durability	if greater than 0	None
{item_max_dur} / {item_max_durability}	Max durability of item in player's main hand	max durability	if greater than 0	None
{item_dur_per} / {item_durability_percent}	Percentage of durability left of item in player's main hand	durability %	if greater than 0	Precision & Scale
{item_has_dur} / {item_has_durability}	If the item in the player's main hand can have durability	0 (false), 1 (true)	can have durability	None
{oitem} / {offhand_item}	Name of item in player's offhand	length of output	length of output > 0	String
{oitem_id} / {offhand_item_id}	Id of item in player's offhand	length of output	length of output > 0	String
{oitem_dur} / {offhand_item_durability}	Durability of item in player's offhand	durability	if greater than 0	None
{oitem_max_dur} / {offhand_item_max_durability}	Max durability of item in player's offhand	max durability	if greater than 0	None
{oitem_dur_per} / {offhand_item_durability_percent}	Percentage of durability left of item in player's offhand	durability %	if greater than 0	Precision & Scale
{oitem_has_dur} / {offhand_item_has_durability}	If the item in the player's offhand can have durability	0 (false), 1 (true)	can have durability	None

If Sodium is installed:

Variable	Description	Num Value	Bool Value	Flags
{sodium_version}	Sodium Version	length of output	length of output > 0	None
{sodium_chunk_arena_allocator}	Sodium Chunk Arena Memory Allocater	length of output	length of output > 0	None
{sodium_staging_buffers}	Sodium Staging Buffers	staging buffers	if greater than 0	None
{sodium_buffer_objects}	Sodium Device Buffer Objects	buffer objects	if greater than 0	None
{sodium_memory_used}	Sodium Device Memory Used	memory used	if greater than 0	None
{sodium_memory_allocated}	Sodium Device Memory Allocated	memory allocated	if greater than 0	None

If Iris is installed:

Variable	Description	Num Value	Bool Value	Flags
{iris_version}	Iris Version	length of output	length of output > 0	None
{iris_shaderpack}	Shaderpack file loaded	length of output	length of output > 0	None
{iris_shaderpack_profile}	Shaderpack profile loaded	length of output	length of output > 0	None
{iris_shaderpack_changes}	How many changes the user made to the profile	number of changes	number of changes > 0	None