Explain git branches and update README file

ViaVersion · Nov 28, 2023 · a3fe3be · a3fe3be
1 parent 9f80ee4
commit a3fe3be
Show file tree

Hide file tree

Showing 3 changed files with 24 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -69,21 +69,22 @@ For compiling only! **You do not need to install these!**
 <details>
   <summary>Click to get a list of all dependencies</summary>
 
-| Dependency             | Download                                                   |
-|------------------------|------------------------------------------------------------|
-| Fabric API             | https://github.com/fabricMC/fabric                         |
-| Fabric Loader          | https://github.com/fabricMC/fabric-loader                  |
-| Classic4J              | https://github.com/FlorianMichael/Classic4J                |
-| ViaVersion             | https://github.com/ViaVersion/ViaVersion                   |
-| ViaBackwards           | https://github.com/ViaVersion/ViaBackwards                 |
-| ViaLoader              | https://github.com/ViaVersion/ViaLoader                    |
-| ViaLegacy              | https://github.com/ViaVersion/ViaLegacy                    |
-| ViaAprilFools          | https://github.com/ViaVersion/ViaAprilFools                |
-| ViaBedrock             | https://github.com/RaphiMC/ViaBedrock                      |
-| MinecraftAuth          | https://github.com/RaphiMC/MinecraftAuth                   |
-| Netty-transport-RakNet | https://github.com/CloudburstMC/Network/tree/develop       |
-| Reflect                | https://github.com/Lenni0451/Reflect                       |
-| MixinExtras            | https://github.com/LlamaLad7/MixinExtras                   |
+| Dependency             | Download                                             |
+|------------------------|------------------------------------------------------|
+| Fabric API             | https://github.com/FabricMC/fabric                   |
+| Fabric Loader          | https://github.com/FabricMC/fabric-loader            |
+| Classic4J              | https://github.com/FlorianMichael/Classic4J          |
+| ViaVersion             | https://github.com/ViaVersion/ViaVersion             |
+| ViaBackwards           | https://github.com/ViaVersion/ViaBackwards           |
+| ViaLoader              | https://github.com/ViaVersion/ViaLoader              |
+| ViaLegacy              | https://github.com/ViaVersion/ViaLegacy              |
+| ViaAprilFools          | https://github.com/ViaVersion/ViaAprilFools          |
+| ViaBedrock             | https://github.com/RaphiMC/ViaBedrock                |
+| MinecraftAuth          | https://github.com/RaphiMC/MinecraftAuth             |
+| Netty-transport-RakNet | https://github.com/CloudburstMC/Network/tree/develop |
+| Reflect                | https://github.com/Lenni0451/Reflect                 |
+| MCPing                 | https://github.com/Lenni0451/MCPing                  |
+| MixinExtras            | https://github.com/LlamaLad7/MixinExtras             |
 </details>
 
 ### Setting up a Workspace

diff --git a/docs/DEVELOPER_API.md b/docs/DEVELOPER_API.md
@@ -18,7 +18,7 @@ ChangeProtocolVersionCallback.EVENT.register((oldVersion, newVersion) -> {
 | PostGameLoadCallback                 | Called when Minecraft is finished with loading all its components                                                                                                                                             |
 | PostViaVersionLoadCallback           | Called when ViaVersion is loaded and ready to use                                                                                                                                                             |
 | RegisterSettingsCallback             | Called after the default setting groups are loaded and before the setting config is loaded                                                                                                                    |
-| LoadSaveFiles                        | Called before and after the save files are loaded                                                                                                                                                             |
+| LoadSaveFilesCallback                | Called before and after the save files are loaded                                                                                                                                                             |
 
 ## Get and set the current protocol version
 ```java

diff --git a/docs/UPDATE_INSTRUCTIONS.md b/docs/UPDATE_INSTRUCTIONS.md
@@ -56,4 +56,10 @@ Translation files are located in `src/main/resources/assets/viafabricplus/lang/`
    newer fixes at the top of the file.
 10. Increment the version number in `gradle.properties` by at least a minor version (e.g. 1.0.0 -> 1.1.0)
 11. Create a pull request and wait for it to be reviewed and merged.
-12. You're done, congrats!
+12. You're done, congrats!
+
+## Git branches
+- `main`: The main branch, this is where all changes are merged into
+- `backport/*`: Backport branches, these are used to backport newer ViaFabricPlus versions to older versions of the game
+- `recode/*`: Recode branches, these are used to port ViaFabricPlus to newer versions of the game or rewrite big parts of the code
+- `<version>`: Final release branches sorted by their Minecraft version (e.g. `1.8.9`, `1.16.5`, `1.17.1`, ...)