Skip to content

Improve README.md #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 6, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 24 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,35 @@
# Mod Remapping API

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

This mod doesn't depend on a specific minecraft version and should work on any version fabric loader can launch.
This mod jar-in-jars:
- [CursedMixinExtensions](https://github.com/FabricCompatibilityLayers/CursedMixinExtensions) 1.0.0
- [WFVAIO (What Fabric Variant Am I On)](https://github.com/thecatcore/WFVAIO) 1.1.0
- [Legacy Fabric Logger API](https://github.com/Legacy-Fabric/fabric/tree/main/legacy-fabric-logger-api-v1) 1.0.4
- [SpASM](https://github.com/mineLdiver/SpASM) 0.2
- [MixinExtras](https://github.com/LlamaLad7/MixinExtras) 0.2.1 for Fabric Loader 0.14 compatibility purpose only.

This mod shadows and relocates for internal usage:
- [mapping-io](https://github.com/FabricMC/mapping-io) 0.6.1
- [tiny-remapper](https://github.com/FabricMC/tiny-remapper) 0.10.2
- [gson](https://github.com/google/gson) 2.2.4

This mod doesn't depend on a specific Minecraft version and should work on any version that Fabric Loader can launch.

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

### Mods depending on this API:
- Fabricated Forge >=2.0
- Fabricated Legacy Forge >=2.0
- Apron
- Fabricated Rift

## Credits
### Most of the original code of the mod remapper
Expand Down
Loading