ViaForge/README.md

53 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

2023-01-04 03:42:43 +01:00
# ViaForge
2023-10-25 01:58:52 +02:00
Client-side Implementation of the Via* projects for Minecraft Forge
2023-01-04 03:42:43 +01:00
2023-02-25 20:38:52 +01:00
## Contact
If you encounter any issues, please report them on the
[issue tracker](https://github.com/ViaVersion/ViaForge/issues).
2023-05-28 20:27:34 +02:00
If you just want to talk or need help with ViaForge feel free to join the ViaVersion
[Discord](https://discord.gg/viaversion).
2023-01-04 03:42:43 +01:00
2023-02-25 20:38:52 +01:00
## For users
2023-01-04 03:42:43 +01:00
### Where can I download the latest version?
2023-06-07 21:04:43 +02:00
CurseForge: https://www.curseforge.com/minecraft/mc-mods/viaforge
2023-01-04 03:42:43 +01:00
2023-10-20 20:32:08 +02:00
Modrinth: https://modrinth.com/mod/viaforge
2023-01-04 03:42:43 +01:00
2023-10-20 20:32:08 +02:00
GitHub Releases: https://github.com/ViaVersion/ViaForge
2023-01-04 03:42:43 +01:00
### How does it work?
2023-10-20 20:32:08 +02:00
![](.github/images/ViaVersion.png)
2023-01-04 03:42:43 +01:00
2023-10-20 20:32:08 +02:00
## For developers
2023-01-04 03:42:43 +01:00
### Project Structure
2024-04-28 22:36:23 +02:00
All ViaForge versions from Minecraft version 1.12.2 onwards are on the `master` branch. <br>
2023-01-04 03:42:43 +01:00
The names of the submodules indicate the version, they are always given in the format `mc-<version name without .>`. <br>
2024-04-28 22:36:23 +02:00
`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.4` - `viaforge-mc1194` <br>
`Minecraft 1.20.4` - `viaforge-mc1204` <br>
2023-01-04 03:42:43 +01:00
### ViaForge for Minecraft 1.8
2024-04-28 22:36:23 +02:00
Since ForgeGradle for Minecraft 1.8.9 is too old, it has its own branch called `legacy-1.8`
2023-01-04 03:42:43 +01:00
### I want ViaForge in my own utility mod
2023-06-07 21:04:43 +02:00
Just take a look at my other Project called `ViaMCP`: https://github.com/FlorianMichael/ViaMCP
2023-01-04 03:42:43 +01:00
2024-06-04 01:33:43 +02:00
## For developers
### How to build
1. Clone the repository with `git clone`.
2. Run `./gradlew build` in the root directory of the repository.
3. The compiled jar files can be found in `viaforge-mc<version>/build/libs`.
2024-06-05 06:43:34 +02:00
Note: Build scripts are made to be run using Java 17.
2024-06-04 01:33:43 +02:00
2023-06-08 21:34:43 +02:00
## Other ViaVersion Mods / Platforms
- ViaFabric - https://modrinth.com/mod/viafabric
2023-10-20 20:32:08 +02:00
- ViaFabricPlus - https://github.com/ViaVersion/ViaFabricPlus (Includes additional modifications to make the experience better)
2024-02-03 20:19:01 +01:00
- ViaProxy (App) - https://github.com/ViaVersion/ViaProxy
- ViaaaS (Proxy) - https://github.com/ViaVersion/ViaaaS
2023-10-20 20:32:08 +02:00
### If you want to talk with me, feel free to join my [Discord](https://discord.gg/BwWhCHUKDf)