Cleaning Local Thrive Version: Difference between revisions

From Thrive Developer Wiki
Jump to navigation Jump to search
No edit summary
(Updated for Godot 4)
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Category:Programming]]
[[Category:Programming]]
Your locally cloned Thrive version may get messed up from time to time. Here are the steps to fix it:
Your locally cloned Thrive version may get messed up from time to time. This messed up state can be experienced as some game GUI textures (like checkboxes) not showing up or part of the game theme or even buttons not working correctly. 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:


# Close Godot editor
# Close Godot editor
# Delete the .import folder inside the thrive folder
# 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.
# (optional) Delete the .mono folder inside the thrive folder. If you do this step you need to restore nuget packages again
# 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.
# 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
 
This can easily happen for example if the C# code is not compiled and loaded into Godot or if hot reloading of the code fails.
 
== Full Cleanup ==
 
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:
 
# Close Godot editor
# Delete the .godot folder inside the Thrive folder
# 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.

Latest revision as of 17:51, 7 April 2024

Your locally cloned Thrive version may get messed up from time to time. This messed up state can be experienced as some game GUI textures (like checkboxes) not showing up or part of the game theme or even buttons not working correctly. 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.

This can easily happen for example if the C# code is not compiled and loaded into Godot or if hot reloading of the code fails.

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 .godot folder inside the Thrive folder
  3. 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
  4. Reopen Godot editor, it should reimport all assets.
  5. 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.