Commands/debug

This article is about command. For other uses, see Debug.

debug

Permission level required	3
Restrictions	No command blocks

Starts or stops a debugging session. While active, includes notifications about potential performance bottlenecks in the console. When stopped, creates a profiler results file in the folder "debug".

Syntax

debug start

Starts a new debug profiling session.

debug stop

Stops the active debug profiling session.

debug report

Used to get more detailed information while debugging performance. Saves information in the .minecraft\debug folder in the form of a zip file.

Result

Command	Trigger	Java Edition
/debug start	a debug profiling session has already been started	Failed
/debug stop	there's no debug profiling session running.
any	On success	Starts/stops the debug profiling, or get more detailed information.

Output

Command	Edition	Situation	Success Count	/execute store success ...	/execute store result ...
any	Java Edition	On fail	N/A	0	0
/debug start		On success	N/A	1	0
		On success	N/A	1	the average tps (ticks per second) during debug profiling
/debug report		fails to save debug dump	N/A	1	0
		save debug dump successfully	N/A	1	1

File structure

When using /debug report, a ZIP file is created with the following structure:^{[more information needed]}

• debug-report-<year>-<month>-<day>_<hour>.<minute>.<second>.zip
  • levels
    • minecraft or <other custom namespaces>
      • overworld or the_end or the_nether or <other custom dimensions>
        • block_entities.csv: Contains a list of block entities in the world in the format x,y,z,type.
        • chunks.csv: Contains a list of chunk information in the format x,z,level,in_memory,status,full_status,accessible_ready,ticking_ready,entity_ticking_ready,ticket,spawning,entity_count,block_entity_count.
        • entities.csv: Contains a list of entities in the world in the format x,y,z,uuid,type,alive,custom_name.
        • example_crash.txt: An example crash file.
        • stats.txt: Contains some statistics.
  • classpath.txt: Contains the file paths of the external jars Minecraft uses.
  • example_crash.txt: An example crash file.
  • gamerules.txt: A plain text file containing a list of game rules and their values (<gamerule>=<value>).

History

Java Edition
1.3.1		12w27a			Added /debug.
1.8		14w31a			/debug can now be run in single-player.
					Added /debug chunk.
?					Removed/debug chunk.
1.13		18w03a			Added commands to the profiler.
1.14.4		pre1			Added /debug report, used to get more detailed information while debugging performance.

Commands

View at: Template:Commands/content [edit]