From df1ab747da54ed29aa90f6e939f5c3ad11afd033 Mon Sep 17 00:00:00 2001 From: Acamaeda Date: Thu, 8 Oct 2020 23:45:08 -0400 Subject: [PATCH] Added Updating TMT tutorial --- docs/!general-info.md | 2 ++ getting-started.md => docs/getting-started.md | 0 docs/updating-tmt.md | 28 +++++++++++++++++++ 3 files changed, 30 insertions(+) rename getting-started.md => docs/getting-started.md (100%) create mode 100644 docs/updating-tmt.md diff --git a/docs/!general-info.md b/docs/!general-info.md index c83adbf..7e7a9f2 100644 --- a/docs/!general-info.md +++ b/docs/!general-info.md @@ -18,6 +18,7 @@ plain number, and perform operations on them by calling functions. e.g, instead ## Table of Contents: +- [Getting Started](getting-started.md): Getting your own copy of the code set up with Github Desktop. - [Basic layer breakdown](basic-layer-breakdown.md): Breaking down the components of a layer with minimal features. - [Layer features](layer-features.md): Explanations of all of the different properties that you can give a layer. - [Upgrades](upgrades.md): How to create upgrades for a layer. @@ -28,3 +29,4 @@ plain number, and perform operations on them by calling functions. e.g, instead - [Custom Tab Layouts](custom-tab-layouts.md): An optional way to give your tabs a different layout. You can even create entirely new components to use. - [Subtabs and Microtabs](subtabs-and-microtabs.md): Create subtabs for your tabs, as well as "microtab" components that you can put inside the tabs. +- [Updating TMT](updating-tmt.md): Using Github Desktop to update your mod's version of TMT. diff --git a/getting-started.md b/docs/getting-started.md similarity index 100% rename from getting-started.md rename to docs/getting-started.md diff --git a/docs/updating-tmt.md b/docs/updating-tmt.md new file mode 100644 index 0000000..6675d93 --- /dev/null +++ b/docs/updating-tmt.md @@ -0,0 +1,28 @@ +# Updating The Modding Tree + +This tutorial assumes that you have used [the Getting Started Tutorial](getting-started.md), and are using Github Desktop and VSCode for your mod. + +Here's what you have to do when there's a TMT update: + +1. Look at the changelog. It will warn you if the update will break anything or require any changes. + Decide if you want to try to update. + +2. Open Github Desktop, and at the top middle, click "fetch origin". This will make Github Desktop get + information about the update. + +3. Click where it says "current branch: master" at the top middle, and at the bottom of the thing +that appears, click "choose a branch to merge into master. + +4. Select upstream/master. It will likely say there are conflicts, but you have tools to resolve them. + Click "Merge upstream/master into master". + +5. A conflict happens when the things you're trying to merge have both made changes in the same place. + Click "open in Visual Studio Code" next to the first file. + +6. Scroll down through the file, and look for the parts highlighted in red and green. One of these is + your code, and the other is some code that will be modified by the update. Do your best to try to + edit things to keep the updated changes, but keep your content. + +7. Continue to do this for all remaining challenges. + +8. Do any other changes required by the update, run the game, fix issues, etc. \ No newline at end of file