Files
architectury-plugin/README.md
ROM 59f24faab2 Fix KubeJS link
Previous link referenced non-existing (or private) repository.
2021-01-24 14:42:51 -06:00

29 lines
1.2 KiB
Markdown

# Architectury Plugin
Talk to us on [Discord](https://discord.gg/C2RdJDpRBP)!
Architectury Plugin is a gradle plugin to allow easier multi-modloader set-ups using a common module.
### Examples
- [KubeJS](https://github.com/KubeJS-Mods/KubeJS)
- [Architectury Example Mod](https://github.com/architectury/architectury-example-mod)
### Important Information
- `Environment` and `EnvType` are remapped to `OnlyIn` and `Dist` on forge.
### Implementing Platform Specific APIs
_Notes: Only works when architectury api is loaded and for static methods._
![](https://media.discordapp.net/attachments/586186202781188108/776428814309785620/unknown.png?width=1191&height=439)
### How does it work
Fabric Side:
- Module `fabric` depends on a transformed version of `common`, which is shaded afterwards
Forge Side:
- Module `forge` depends on a transformed version of `common`, which is shaded afterwards
- A fake mod is generated, to let forge load it on the correct mod loader and let forge load its assets
### Usage
Your gradle version **MUST** be equals or above 5.5.1, all `assets` or `data` should go into the common module, with modloader specific files to their corresponding modules.