Commands/debug

From Minecraft Wiki
Jump to: navigation, search
This article is about command. For other uses, see Debug.
Information icon.svg
This feature is exclusive to Java Edition.
debug
Restrictions

Operator
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[edit]

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[edit]

CommandTriggerJava Edition
/debug startif a debug profiling session have already been started Failed
/debug stopif there's no debug profiling session running.
anyOn successStarts/stops the debug profiling, or get more detailed information.

Output[edit]

CommandEditionSituationSuccess Count/execute store succeess .../execute store result ...
anyJava EditionOn failN/A00
/debug startOn successN/A10
On successN/A1the average tps (ticks per second) during debug profiling
/debug reportfailed to save debug dumpN/A10
save debug dump successfullyN/A11

File structure[edit]

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[edit]

Java Edition
1.3.112w27aAdded /debug.
1.814w31a/debug can now be run in single-player.
Added /debug chunk.
?Removed/debug chunk.
1.1318w03aAdded commands to the profiler.
1.14.4pre1Added /debug report, used to get more detailed information while debugging performance.