Skip to content

debug-logging-checklist.md

Latest commit

 

History

History
81 lines (68 loc) · 2.2 KB

debug-logging-checklist.md

File metadata and controls

81 lines (68 loc) · 2.2 KB

Debug Logging Quick Checklist (GDevelop)

Use this checklist to add per-run debug logging to any GDevelop project.

Note:

  • This checklist is for file logging (FileSystem::LoadStringFromFileAsync / FileSystem::SaveStringToFileAsync).
  • It is separate from storage persistence flows (Read...FromStorage, EcrireFichier...).

Setup

  1. Choose variable scope: scene or global.
  2. Define variables:
    • Debug_Log_String (string)
    • Debug_Log_FilePath (string)
    • Debug_Log_RunId (string)
  3. Add folder documents/logs/ with .gitkeep.
  4. Add ignore rules:
    • documents/logs/*
    • !documents/logs/.gitkeep

Event Group

  1. Create one logging event group (single writer).
  2. On startup, reset the three variables to empty.
  3. If Debug_Log_String is set and Debug_Log_FilePath is empty:
    • create run id
    • set filepath to documents/logs/run_<runId>.txt
  4. If Debug_Log_String is set:
    • prepend timestamp
    • append/write to file
    • clear Debug_Log_String

Usage

  1. From any event, log by setting Debug_Log_String to a concise message.
  2. Use searchable tags (for example [ROOM], [PLAYER], [CAMERA], [HAZARD]).

Validation

  1. Run preview twice and confirm two separate log files are created.
  2. Confirm each run file contains only that run's messages.

Copy-Safe JSON Snippets (From Project)

Taken from C:\GameDev\Dark-Ship-Codex\layouts\run.json.

Initialize log file:

{
  "type": { "value": "FileSystem::SaveStringToFileAsync" },
  "parameters": [
    "\"Log started: \" + Debug_Log_RunId",
    "Debug_Log_FilePath",
    "Debug_Log_Success"
  ]
}

Load then append:

{
  "type": { "await": true, "value": "FileSystem::LoadStringFromFileAsync" },
  "parameters": ["Temp_Log_Content", "Debug_Log_FilePath", "", ""]
}
{
  "type": { "value": "FileSystem::SaveStringToFileAsync" },
  "parameters": [
    "Temp_Log_Content + NewLine() + Debug_Log_String",
    "Debug_Log_FilePath",
    "Debug_Log_Success"
  ]
}

Common Mistakes

  • Referencing variables that were never declared.
  • Writing from multiple event groups (duplicate or out-of-order lines).
  • Forgetting to clear Debug_Log_String after write.
  • Committing generated log files.