mirror of
https://github.com/architectury/architectury-plugin.git
synced 2026-03-28 04:07:01 -05:00
Update README.md
This commit is contained in:
10
README.md
10
README.md
@@ -3,6 +3,8 @@ 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.
|
||||
|
||||
More documentation: [Architectury Wiki](https://architectury.github.io/architectury-documentations/docs/architectury_plugin/)
|
||||
|
||||
### Examples
|
||||
- [KubeJS](https://github.com/KubeJS-Mods/KubeJS)
|
||||
- [Architectury Example Mod](https://github.com/architectury/architectury-example-mod)
|
||||
@@ -11,18 +13,22 @@ Architectury Plugin is a gradle plugin to allow easier multi-modloader set-ups u
|
||||
- `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._
|
||||
_Notes: Only works for static methods._
|
||||

|
||||
|
||||
### IntelliJ Plugin
|
||||
https://plugins.jetbrains.com/plugin/16210-architectury
|
||||
|
||||
### How does it work
|
||||
Fabric Side:
|
||||
|
||||
- Module `fabric` depends on a transformed version of `common`, which is shaded afterwards
|
||||
- A fake mod is generared, to let fabric load it on the correct class loader and let fabric load its assets
|
||||
|
||||
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
|
||||
- A fake mod is generated, to let forge load it on the correct class 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.
|
||||
|
||||
Reference in New Issue
Block a user