Cleaning Local Thrive Version: Difference between revisions

From Thrive Developer Wiki
Jump to navigation Jump to search
(note about automatic script)
(switched to using proper command highlighting and prepared for the switch to C# scripts)
Line 7: Line 7:


# Close Godot editor
# Close Godot editor
# Make sure that git doesn't say anything is modified (`git status` shows no changes). If there are changes use git reset to get rid of them, or git checkout the individual files.
# Make sure that git doesn't say anything is modified (<code>git status</code> shows no changes). If there are changes use git reset to get rid of them, or git checkout the individual files.
# Reopen Godot editor and run the game from there. If it still doesn't work, make sure that no new changes appeared in `git status`, if there are go back to the first step.
# Reopen Godot editor and run the game from there. If it still doesn't work, make sure that no new changes appeared in <code>git status</code>, if there are go back to the first step.


== Full Cleanup ==
== Full Cleanup ==


There is an automatic script that handles the folder delete and git reset called "cleanup.py" which you can run to automate this process. Note that after the asset reimport when reopening Godot, you may need to close Godot and git reset again, if it automatically broke things again.
There is an automatic script that handles the folder delete and git reset (can be ran with <code>dotnet run --project Scripts -- cleanup</code>) which you can run to automate this process. Note that after the asset reimport when reopening Godot, you may need to close Godot and git reset again, if it automatically broke things again.


When things are really messed up here are steps to clean out everything:
When things are really messed up here are steps to clean out everything:
Line 19: Line 19:
# Delete the .import folder inside the thrive folder
# Delete the .import folder inside the thrive folder
# (optional) Delete the .mono folder inside the thrive folder. If you do this step you need to restore nuget packages again
# (optional) Delete the .mono folder inside the thrive folder. If you do this step you need to restore nuget packages again
# Make sure that git doesn't say anything is modified (`git status` shows no changes). If there are changes use git reset to get rid of them
# Make sure that git doesn't say anything is modified (<code>git status</code> shows no changes). If there are changes use git reset to get rid of them
# Reopen Godot editor, it should reimport all assets.
# Reopen Godot editor, it should reimport all assets.
# Everything should be fixed now when you start the game from the Godot editor
# Everything should be fixed now when you start the game from the Godot editor


If even that doesn't work you should attempt to delete your local Thrive folder and clone again. Note that this loses all of your local changes so if you did any changes yourself, you should copy them to somewhere safe first.
If even that doesn't work you should attempt to delete your local Thrive folder and clone again. Note that this loses all of your local changes so if you did any changes yourself, you should copy them to somewhere safe first.

Revision as of 08:59, 2 September 2022

Your locally cloned Thrive version may get messed up from time to time. Here are the steps to fix it.

Light Cleanup

Often if the game doesn't run or there's some errors in some parts that shouldn't be there you can get away with just some cleanup:

  1. Close Godot editor
  2. Make sure that git doesn't say anything is modified (git status shows no changes). If there are changes use git reset to get rid of them, or git checkout the individual files.
  3. Reopen Godot editor and run the game from there. If it still doesn't work, make sure that no new changes appeared in git status, if there are go back to the first step.

Full Cleanup

There is an automatic script that handles the folder delete and git reset (can be ran with dotnet run --project Scripts -- cleanup) which you can run to automate this process. Note that after the asset reimport when reopening Godot, you may need to close Godot and git reset again, if it automatically broke things again.

When things are really messed up here are steps to clean out everything:

  1. Close Godot editor
  2. Delete the .import folder inside the thrive folder
  3. (optional) Delete the .mono folder inside the thrive folder. If you do this step you need to restore nuget packages again
  4. Make sure that git doesn't say anything is modified (git status shows no changes). If there are changes use git reset to get rid of them
  5. Reopen Godot editor, it should reimport all assets.
  6. Everything should be fixed now when you start the game from the Godot editor

If even that doesn't work you should attempt to delete your local Thrive folder and clone again. Note that this loses all of your local changes so if you did any changes yourself, you should copy them to somewhere safe first.