Skip to content

Commit f2fe4cd

Browse files
authored
Merge pull request #14 from FabricCompatibilityLayers/feature/improve-readme
Improve README.md
2 parents 180061e + 7c63969 commit f2fe4cd

1 file changed

Lines changed: 24 additions & 4 deletions

File tree

README.md

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,35 @@
11
# Mod Remapping API
22

3-
Remaps non fabric mods from obfuscated code to intermediary at runtime.
4-
Provides hooks to expand the remapping process from other mods.
3+
Remaps non-Fabric mods made for a different environment (by default obfuscated) to the current runtime mappings.\
4+
Provides hooks to expand the remapping process from other mods such as:
5+
- Remapping mods from another folder than `mods`
6+
- Providing additional libraries as context to improve remapping quality
7+
- Providing additional mappings entry
8+
- Pre and post ASM-like visitors for the remapping process
9+
- Changing the package to which classes without one are automatically moved to
10+
- After remap action
11+
- Changing source namespace and mappings of mods to remap
512

6-
This mod doesn't depend on a specific minecraft version and should work on any version fabric loader can launch.
13+
This mod jar-in-jars:
14+
- [CursedMixinExtensions](https://github.com/FabricCompatibilityLayers/CursedMixinExtensions) 1.0.0
15+
- [WFVAIO (What Fabric Variant Am I On)](https://github.com/thecatcore/WFVAIO) 1.1.0
16+
- [Legacy Fabric Logger API](https://github.com/Legacy-Fabric/fabric/tree/main/legacy-fabric-logger-api-v1) 1.0.4
17+
- [SpASM](https://github.com/mineLdiver/SpASM) 0.2
18+
- [MixinExtras](https://github.com/LlamaLad7/MixinExtras) 0.2.1 for Fabric Loader 0.14 compatibility purpose only.
19+
20+
This mod shadows and relocates for internal usage:
21+
- [mapping-io](https://github.com/FabricMC/mapping-io) 0.6.1
22+
- [tiny-remapper](https://github.com/FabricMC/tiny-remapper) 0.10.2
23+
- [gson](https://github.com/google/gson) 2.2.4
24+
25+
This mod doesn't depend on a specific Minecraft version and should work on any version that Fabric Loader can launch.
726

827
[Discord Server](https://discord.gg/dy4tgDAmeR)
928

1029
### Mods depending on this API:
11-
- Fabricated Forge >=2.0
30+
- Fabricated Legacy Forge >=2.0
1231
- Apron
32+
- Fabricated Rift
1333

1434
## Credits
1535
### Most of the original code of the mod remapper

0 commit comments

Comments
 (0)