[ci skip] Restructure README.md

This commit is contained in:
FlorianMichael 2024-07-11 05:27:07 +02:00
parent c99860106d
commit b23a86b6ad
No known key found for this signature in database
GPG Key ID: C2FB87E71C425126

View File

@ -1,42 +1,40 @@
# ViaForge <div align="center">
Client-side Implementation of the Via* projects for Minecraft Forge <img src="https://raw.githubusercontent.com/ViaVersion/ViaForge/master/src/main/resources/icon.png" width="150">
<h1>ViaForge</h1>
<a href="https://files.minecraftforge.net/net/minecraftforge/forge"><img src="https://img.shields.io/badge/Mod%20Loader-Forge-lightyellow?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAYCAYAAACbU/80AAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAALySURBVEhLtZZPaBNBFMbzz42NtoII0aCiRQURVGIFEak3URFEEHqUCkVsPZSKoHjQiwjiQb1UFOlBUXoS0XjowYte1JutF6kKUtYIUQpN1k3zz9+bndos3TabNPng4817b+Z7Mzs7sxtoFKVSaV25XO6BD4vF4nodbi4QD+nmfxDbWqlUnsFfUIHYNZ12gUluI32R/Ed4Uof9g0EGPKVdBUS7nLIumMTbdT7BmLNwjHjOSSuklIAfMLhDN6V9Hx7XrvhrEJtyNOdBfBjzBP5RATcKcDSbzQa1zNJA7A7slTYrGmTwd/Z5tUoCcq+V7NL4DVP07Udjh23b/ooLGHSMwVPY/UJRw97V6QDuJYl54Af9RuBpijb2YqbT6RCr3YTIIQTHEEpiTVEndlj6ENuDW5RYNcj3KZHlAqGD8CrsolgHthv9HPYz+2hIH/y3qqobD5RAM0CxPgTfY3drfx/+NPaG9s+oklUgNm6a5oKj2zAQvI6uje0Xn/Yu2hNsUbJQKBj4k1JYI0/uOfGVavBykM/nIxSRfb7taKvVjUrOsqw425CQNrFeUu+wA7BTYvXC82jkcrlEKBTqjkajbcFg0JIQBfIcpQ+xWEy9AyBMcbEV+vzFrtAUTZXQmKsxrfu54DkBisXpLIVKTkT1s3kqVyKRiGyHraLzhTx1qtAGL6D5yHFrgAmcU8+d/YdWFUuwUQxpeRc8Z05neZPvwQEVqB+zcAKdT9ivLEhOz5hhGF9U1i8YdBS+QOgnnIW1ICfmFnfHzkwmU2tb/APRtbCTI/ZYF/KCfPmO6CGtAadgC0Xki+eFYd2tteDxtlMs7dR04bzuUhcauTblsxx1mi5s17Y14PYLs/q9rDTlLHgBLN6TIfps0EOaB4Tl0zwO/dwDM3CES0tuxZrwdVQQvIm57HgKb4i9ZGLfaK8Kh8MHsD0wLkkgN+RGbj7TcReH3wkkMfIzQrMyyXfilUpUgUe/mfgJmrLyGSb3lInNXdmLIBD4Bw72x5r0eQ99AAAAAElFTkSuQmCC"></a>
<img src="https://img.shields.io/badge/Enviroment-Client-purple">
<a href="https://discord.gg/viaversion"><img src="https://img.shields.io/discord/316206679014244363?color=0098DB&label=Discord&logo=discord&logoColor=0098DB"></a> <br />
<a href="https://modrinth.com/mod/viaforge"><img src="https://img.shields.io/badge/dynamic/json?color=158000&label=downloads&prefix=+%20&query=downloads&url=https://api.modrinth.com/v2/project/Z6se2s8f&logo=modrinth"></a>
<a href="https://curseforge.com/minecraft/mc-mods/viaforge"><img src="https://cf.way2muchnoise.eu/full_418933_downloads.svg"></a>
<a href="https://github.com/ViaVersion/ViaForge/actions/workflows/build.yml"><img src="https://github.com/ViaVersion/ViaForge/actions/workflows/main.yml/badge.svg?branch=master"></a>
## Contact #### Client-side Implementation of the Via* projects for Minecraft Forge
If you encounter any issues, please report them on the </div>
[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).
## For users ## Supported Server versions
### Where can I download the latest version? - Release (1.0.0 - 1.21)
CurseForge: https://www.curseforge.com/minecraft/mc-mods/viaforge - 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. <br>
### How does it work? The ``legacy-1.8`` also supports Minecraft 1.8.9.
![](.github/images/ViaVersion.png)
## For developers Dev builds: https://ci.viaversion.com/view/Platforms/job/ViaForge/
### Project Structure
All ViaForge versions from Minecraft version 1.12.2 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>
`Minecraft 1.12.2` - `viaforge-mc1122` <br>
`Minecraft 1.16.5` - `viaforge-mc1165` <br>
`Minecraft 1.17.1` - `viaforge-mc1171` <br>
`Minecraft 1.18.2` - `viaforge-mc1182` <br>
`Minecraft 1.19.2` - `viaforge-mc1192` <br>
`Minecraft 1.19.4` - `viaforge-mc1194` <br>
`Minecraft 1.20.4` - `viaforge-mc1204` <br>
### ViaForge for Minecraft 1.8 If you encounter any issues, please report them on either:
Since ForgeGradle for Minecraft 1.8.9 is too old, it has its own branch called `legacy-1.8` - [the issue tracker](https://github.com/ViaVersion/ViaForge/issues)
- [the ViaVersion Discord](https://discord.gg/viaversion)
### I want ViaForge in my own utility mod ## How to (Developers)
Just take a look at my other Project called `ViaMCP`: https://github.com/FlorianMichael/ViaMCP
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 ### How to build
1. Clone the repository with `git clone`. 1. Clone the repository with `git clone`.
2. Run `./gradlew build` in the root directory of the repository. 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. Note: Build scripts are made to be run using Java 17.
## Other ViaVersion Mods / Platforms ## 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) <br>
ViaSponge - https://modrinth.com/project/viasponge <br>
ViaFabric - https://modrinth.com/mod/viafabric <br>
ViaFabricPlus - https://modrinth.com/mod/viafabricplus (Includes additional modifications to make the experience better) <br>
ViaForge - https://modrinth.com/mod/viaforge/ <br>
ViaProxy (App) - https://github.com/ViaVersion/ViaProxy/#readme <br>
ViaaaS (Proxy) - https://github.com/ViaVersion/ViaaaS#readme <br>
For a more detailed summary see https://viaversion.com/suite