Update README.md

This commit is contained in:
florian 2023-02-25 20:38:52 +01:00 committed by GitHub
parent 2b12ecaad5
commit 1232b01736
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -1,8 +1,13 @@
# ViaForge # ViaForge
Clientside Implementation of ViaVersion for Forge Clientside Implementation of ViaVersion for Forge
## For users ## Contact
If you encounter any issues, please report them on the
[issue tracker](https://github.com/FlorianMichael/ViaForge/issues).
If you just want to talk or need help with ViaForge feel free to join my
[Discord](https://discord.gg/BwWhCHUKDf).
## For users
### Where can I download the latest version? ### Where can I download the latest version?
Just take a look at Curse-forge: https://www.curseforge.com/minecraft/mc-mods/viaforge Just take a look at Curse-forge: https://www.curseforge.com/minecraft/mc-mods/viaforge
@ -16,28 +21,19 @@ First of all see if it's because of an installed mod, otherwise come to my Disco
No No
## For developers ## For developers
### How does it work? ### How does it work?
![](images/via-expl.png) ![](images/via-expl.png)
### Project Structure ### Project Structure
All ViaForge versions from Minecraft version 1.12 onwards are on the `master` branch. <br> All ViaForge versions from Minecraft version 1.12 onwards are on the `master` branch. <br>
The names of the submodules indicate the version, they are always given in the format `mc-<version name without .>`. <br> The names of the submodules indicate the version, they are always given in the format `mc-<version name without .>`. <br>
`Minecraft 1.12.2` - `mc1122` `Minecraft 1.12.2` - `mc1122`
### ViaForge for Minecraft 1.8 ### ViaForge for Minecraft 1.8
Since ForgeGradle for Minecraft 1.8 is too old, it has its own branch called `legacy-1.8` Since ForgeGradle for Minecraft 1.8 is too old, it has its own branch called `legacy-1.8`
### I want ViaForge in my own utility mod ### I want ViaForge in my own utility mod
Just take a look at our other Project called `ViaMCP`: https://github.com/RejectedVia/ViaMCP-Reborn Just take a look at our other Project called `ViaMCP`: https://github.com/RejectedVia/ViaMCP-Reborn
## For users and developers ## Other Via related Projects
### Discord Server
https://discord.gg/sFzR8bZVHm
### Other Via related Projects
ViaFabric - Clientside Via implementation for Fabric: https://www.curseforge.com/minecraft/mc-mods/viafabric ViaFabric - Clientside Via implementation for Fabric: https://www.curseforge.com/minecraft/mc-mods/viafabric