Skip to content

Documentation Change Naming #1212

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BrandonM-404 wants to merge 3 commits into
base: main
Choose a base branch
from
+16 −14
Open

Documentation Change Naming #1212

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ed58094
Delete docs/2to3.md
BrandonM-404 May 22, 2026
b80327e
Delete docs/3to4.md
BrandonM-404 May 22, 2026
404addd
Combine Upgrade Docs
BrandonM-404 May 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions docs/3to4.md
View file
Open in desktop

This file was deleted.

16 changes: 16 additions & 0 deletions docs/2to3.md → docs/Upgrading_Version.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,19 @@ The upgrade should be mostly seamless but there are a couple of things to watch
- The built-in `emit` mutation has been removed in favour of emitting signals just like GDScript (ie. `some_signal.emit()`).

To upgrade from 2.x to 3.x you can remove the `addons/dialogue_manager` directory and then download a fresh copy of Dialogue Manager 3 from either the Asset Library or GitHub.


# Upgrading from Dialogue Manager 3 to Dialogue Manager 4

Godot 4.6 is now the minimum Godot version supported.

## Breaking changes

- "Titles" are now called "Cues" to better reflect how they are used.
- Response Conditions are now self-closing (eg. `- Text [if some_condition]` is now `- Text [if some_condition /]`).
- The `translation_key` property of `DialogueLine`s is now `static_id` to better reflect that it's not just for translations.

## Possible gotchas

- The bespoke CSV exporter has been removed in favour of Godot's built-in translation template exporter (in **Project Settings > Localisation > Template Generation**) now supporting CSVs.
- The `raw_text` property of `DialogueResource` files has been removed.