mirror of
https://github.com/ViaVersion/ViaFabricPlus.git
synced 2025-02-16 01:42:20 +01:00
Explain git branches and update README file
This commit is contained in:
parent
9f80ee41e1
commit
a3fe3bee87
31
README.md
31
README.md
@ -69,21 +69,22 @@ For compiling only! **You do not need to install these!**
|
|||||||
<details>
|
<details>
|
||||||
<summary>Click to get a list of all dependencies</summary>
|
<summary>Click to get a list of all dependencies</summary>
|
||||||
|
|
||||||
| Dependency | Download |
|
| Dependency | Download |
|
||||||
|------------------------|------------------------------------------------------------|
|
|------------------------|------------------------------------------------------|
|
||||||
| Fabric API | https://github.com/fabricMC/fabric |
|
| Fabric API | https://github.com/FabricMC/fabric |
|
||||||
| Fabric Loader | https://github.com/fabricMC/fabric-loader |
|
| Fabric Loader | https://github.com/FabricMC/fabric-loader |
|
||||||
| Classic4J | https://github.com/FlorianMichael/Classic4J |
|
| Classic4J | https://github.com/FlorianMichael/Classic4J |
|
||||||
| ViaVersion | https://github.com/ViaVersion/ViaVersion |
|
| ViaVersion | https://github.com/ViaVersion/ViaVersion |
|
||||||
| ViaBackwards | https://github.com/ViaVersion/ViaBackwards |
|
| ViaBackwards | https://github.com/ViaVersion/ViaBackwards |
|
||||||
| ViaLoader | https://github.com/ViaVersion/ViaLoader |
|
| ViaLoader | https://github.com/ViaVersion/ViaLoader |
|
||||||
| ViaLegacy | https://github.com/ViaVersion/ViaLegacy |
|
| ViaLegacy | https://github.com/ViaVersion/ViaLegacy |
|
||||||
| ViaAprilFools | https://github.com/ViaVersion/ViaAprilFools |
|
| ViaAprilFools | https://github.com/ViaVersion/ViaAprilFools |
|
||||||
| ViaBedrock | https://github.com/RaphiMC/ViaBedrock |
|
| ViaBedrock | https://github.com/RaphiMC/ViaBedrock |
|
||||||
| MinecraftAuth | https://github.com/RaphiMC/MinecraftAuth |
|
| MinecraftAuth | https://github.com/RaphiMC/MinecraftAuth |
|
||||||
| Netty-transport-RakNet | https://github.com/CloudburstMC/Network/tree/develop |
|
| Netty-transport-RakNet | https://github.com/CloudburstMC/Network/tree/develop |
|
||||||
| Reflect | https://github.com/Lenni0451/Reflect |
|
| Reflect | https://github.com/Lenni0451/Reflect |
|
||||||
| MixinExtras | https://github.com/LlamaLad7/MixinExtras |
|
| MCPing | https://github.com/Lenni0451/MCPing |
|
||||||
|
| MixinExtras | https://github.com/LlamaLad7/MixinExtras |
|
||||||
</details>
|
</details>
|
||||||
|
|
||||||
### Setting up a Workspace
|
### Setting up a Workspace
|
||||||
|
@ -18,7 +18,7 @@ ChangeProtocolVersionCallback.EVENT.register((oldVersion, newVersion) -> {
|
|||||||
| PostGameLoadCallback | Called when Minecraft is finished with loading all its components |
|
| PostGameLoadCallback | Called when Minecraft is finished with loading all its components |
|
||||||
| PostViaVersionLoadCallback | Called when ViaVersion is loaded and ready to use |
|
| 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 |
|
| 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
|
## Get and set the current protocol version
|
||||||
```java
|
```java
|
||||||
|
@ -56,4 +56,10 @@ Translation files are located in `src/main/resources/assets/viafabricplus/lang/`
|
|||||||
newer fixes at the top of the file.
|
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)
|
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.
|
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`, ...)
|
||||||
|
Loading…
Reference in New Issue
Block a user