Candy Logo Copyright © 2025-2026 Candy Arts
Updates
Candy Dialogue Engine is updated through the Candy Wizard. 1. The Wizard reports when an update is available. If a newer Candy Wizard is out too, update the Wizard first: Candy Dialogue Engine is only updated with the latest Wizard. 2. Back up your project before updating. 3. Click the "Update" button, and choose the download from GitHub. 4. Read each page of the update wizard, then proceed. 5. Restart Godot once the update is complete. 6. After the update, the Wizard displays the release's notes, and lists the changes that are left to do by hand, if any. Files During an Update An update preserves the 'safe' files, and replaces every 'unsafe' file with its new version. Both are listed below. The Wizard records every file as it was installed, so it detects the ones you changed, and treats each file accordingly:
FileWhat happens
A file you addedNot touched: it's 'safe'.
A 'safe' file that ships with Candy Dialogue EngineNever overwritten. If the update changed it, its new version is saved beside the update, to compare.
An 'unsafe' file you haven't changedReplaced by the new version.
An 'unsafe' file you changedReplaced by the new version, even when the update doesn't change that file. The Wizard warns you first.
An 'unsafe' file you deletedYou choose: leave it out, or restore it.
A file of your own, where the update adds one of the same nameReplaced by the update's file. The Wizard warns you first.
A file that is no longer part of Candy Dialogue EngineRemoved. If you had changed it, it remains, and is yours from now on.
Before you confirm, the Wizard displays the whole list, and asks for your choices. Nothing is changed until you click "Update". Safe Files A 'safe' file is one that updates never overwrite. Write your own code, data and scenes in safe files only:
  • Every file you add, anywhere in Candy_DE: your scripts (Commands, event scripts, Dialogue Modes, tables, functions...), your scenes, your Dialogues and your media files.
  • Candy_Properties.gd and CandyRef_Shortcuts.gd, in Scripts/User_Data.
  • The scripts that ship in User_Data/Data_Tables, User_Data/Localization_Tables and User_Data/Functions: your tables (such as Actors.gd and Display_Names.gd) and your functions (such as Tts.gd).
  • The Default.tscn scene of each folder in Scenes, Candy_UI.tscn and Testing_Scene.tscn.
  • The Animation Libraries that ship in the Media folders.
When a new version requires something in one of the safe files that ship, such as a new setting in Candy_Properties.gd, the update adds it to your file without changing the rest. If the addition fails, the change is listed among the tasks to do by hand. Unsafe Files Every other file that ships with Candy Dialogue Engine is 'unsafe'. Updates replace it with its new version, and overwrite the changes you made to it:
  • Every script outside Scripts/User_Data: Candy_Engine.gd, the Commands, the built-in event scripts and Dialogue Modes, and the scripts of UI Elements and media players (such as Box_UI.gd).
  • Every scene that ships in Scenes under another name than Default.tscn, such as the Candy_Default.tscn scenes. They're the templates you duplicate to create your own scenes. Don't edit them: work on a copy.
  • The files that ship in the UI Resources folder.
Your changes to an unsafe file could break what a new version introduces, so an update never preserves them. When you click "Update", the Wizard lists every changed file it's about to overwrite, and asks what to do:
  • Abort: Nothing is changed, and the Wizard closes. Back up the listed files, then start the update again.
  • Overwrite and Update: The update replaces the listed files with their new versions.
After the update, add your own code to the new versions of these files again. The update also retains a copy of each file it replaces (see The Update's Folder, below). To protect your code from updates, write it in safe files: see Code Modification. The Update's Folder Each update stores its files in Candy_DE/.Install/Updates, in a folder named after the version. Godot doesn't display it: open it in your file manager (its name starts with a dot, so hidden files may need to be shown). It contains:
  • Previous: every file the update replaced or removed, as it was before.
  • New: the update's versions of the safe files that ship, when the update changed them. They aren't installed, so you can compare them with your own.
  • A report of what the update changed.
To recover a file as it was before the update, copy it from Previous. If an error occurs while the files are written, the Wizard restores every file as it was.