diff --git a/README.md b/README.md index 4c7af2c..b4264a3 100644 --- a/README.md +++ b/README.md @@ -1,42 +1,40 @@ -# ViaForge -Client-side Implementation of the Via* projects for Minecraft Forge +
+ +

ViaForge

+ + +
+ + + -## Contact -If you encounter any issues, please report them on the -[issue tracker](https://github.com/ViaVersion/ViaForge/issues). -If you just want to talk or need help with ViaForge feel free to join the ViaVersion -[Discord](https://discord.gg/viaversion). +#### Client-side Implementation of the Via* projects for Minecraft Forge +
-## For users -### Where can I download the latest version? -CurseForge: https://www.curseforge.com/minecraft/mc-mods/viaforge +## Supported Server versions +- Release (1.0.0 - 1.21) +- Beta (b1.0 - b1.8.1) +- Alpha (a1.0.15 - a1.2.6) +- Classic (c0.0.15 - c0.30 including [CPE](https://wiki.vg/Classic_Protocol_Extension)) +- April Fools (3D Shareware, 20w14infinite) +- Combat Snapshots (Combat Test 8c) -Modrinth: https://modrinth.com/mod/viaforge +## How to (Users) -GitHub Releases: https://github.com/ViaVersion/ViaForge +ViaForge can be installed on 1.12.2, 1.16.5, 1.17.1, 1.18.2, 1.19.2, 1.19.4 and 1.20.4 Forge client versions.
-### How does it work? -![](.github/images/ViaVersion.png) +The ``legacy-1.8`` also supports Minecraft 1.8.9. -## For developers -### Project Structure -All ViaForge versions from Minecraft version 1.12.2 onwards are on the `master` branch.
-The names of the submodules indicate the version, they are always given in the format `mc-`.
-`Minecraft 1.12.2` - `viaforge-mc1122`
-`Minecraft 1.16.5` - `viaforge-mc1165`
-`Minecraft 1.17.1` - `viaforge-mc1171`
-`Minecraft 1.18.2` - `viaforge-mc1182`
-`Minecraft 1.19.2` - `viaforge-mc1192`
-`Minecraft 1.19.4` - `viaforge-mc1194`
-`Minecraft 1.20.4` - `viaforge-mc1204`
+Dev builds: https://ci.viaversion.com/view/Platforms/job/ViaForge/ -### ViaForge for Minecraft 1.8 -Since ForgeGradle for Minecraft 1.8.9 is too old, it has its own branch called `legacy-1.8` +If you encounter any issues, please report them on either: +- [the issue tracker](https://github.com/ViaVersion/ViaForge/issues) +- [the ViaVersion Discord](https://discord.gg/viaversion) -### I want ViaForge in my own utility mod -Just take a look at my other Project called `ViaMCP`: https://github.com/FlorianMichael/ViaMCP +## How to (Developers) + +See [this project](https://github.com/ViaVersionMCP/ViaMCP) for a copy-paste solution to include ViaForge into your MCP based project. -## For developers ### How to build 1. Clone the repository with `git clone`. 2. Run `./gradlew build` in the root directory of the repository. @@ -45,9 +43,13 @@ Just take a look at my other Project called `ViaMCP`: https://github.com/Florian Note: Build scripts are made to be run using Java 17. ## Other ViaVersion Mods / Platforms -- ViaFabric - https://modrinth.com/mod/viafabric -- ViaFabricPlus - https://github.com/ViaVersion/ViaFabricPlus (Includes additional modifications to make the experience better) -- ViaProxy (App) - https://github.com/ViaVersion/ViaProxy -- ViaaaS (Proxy) - https://github.com/ViaVersion/ViaaaS -### If you want to talk with me, feel free to join my [Discord](https://discord.gg/BwWhCHUKDf) +ViaBungee - https://hangar.papermc.io/ViaVersion/ViaBungee (ensure Bungee is updated to latest)
+ViaSponge - https://modrinth.com/project/viasponge
+ViaFabric - https://modrinth.com/mod/viafabric
+ViaFabricPlus - https://modrinth.com/mod/viafabricplus (Includes additional modifications to make the experience better)
+ViaForge - https://modrinth.com/mod/viaforge/
+ViaProxy (App) - https://github.com/ViaVersion/ViaProxy/#readme
+ViaaaS (Proxy) - https://github.com/ViaVersion/ViaaaS#readme
+ +For a more detailed summary see https://viaversion.com/suite \ No newline at end of file