Skip to content

Commit ba57aee

Browse files
committed
Document recovery mode
1 parent d83d55a commit ba57aee

File tree

3 files changed

+35
-0
lines changed

3 files changed

+35
-0
lines changed
Binary file not shown.

tutorials/editor/project_manager.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -144,3 +144,29 @@ you created.
144144
To remove a tag from your project manager it must be removed from all the projects it's
145145
used by. Once that's done close the project manager, open it up again, and the tag should
146146
be gone.
147+
148+
Recovery Mode
149+
-------------
150+
151+
If a project is immediately crashing on startup, or crashing frequently during
152+
editing it can be opened in recovery mode, to attempt to make it more stable
153+
while looking for the source of the crashing to fix it.
154+
155+
Usually a project should open in recovery mode automatically when you re-open it
156+
after a crash. If it doesn't you can manually open recovery mode by selecting the
157+
project in the project manager, to do that select the project from your list of
158+
projects, click the dropdown button next to the edit node, and select ``Edit in
159+
recovery mode``.
160+
161+
.. image:: img/editor_ui_intro_project_manager_13.webp
162+
163+
While in recovery mode the following are disabled:
164+
165+
- Tool scripts
166+
- Editor plugins
167+
- GDExtension addons
168+
- Automatic scene restoring
169+
- Running the project
170+
171+
It is recommended that you backup your project before editing it in recovery
172+
mode.

tutorials/troubleshooting.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -251,3 +251,12 @@ On Windows, this can also be due to :ref:`case sensitivity
251251
in your script with a different case than on the filesystem, loading will fail
252252
once you export the project. This is because the virtual PCK filesystem is
253253
case-sensitive, while Windows's filesystem is case-insensitive by default.
254+
255+
The project crashes frequently or instantly after opening it from the project manager
256+
-------------------------------------------------------------------------------------
257+
258+
This could be caused by a number of things such as an editor plugin, GDExtension
259+
addon, or something else. In this scenario it's recommended that you open the
260+
project in recovery mode, and attempt to find and fix whatever is causing the
261+
crashes. See the :ref:`Project Manager page <doc_project_manager>` for more
262+
information.

0 commit comments

Comments
 (0)