FabricMC / tiny-remapper

Tiny JAR remapping tool.
GNU Lesser General Public License v3.0
116 stars 65 forks source link

Add readme #107

Open e-ave opened 1 year ago

e-ave commented 1 year ago

This project is in dire need of an example in the readme. Like for example what does “to” and “from” argument do? I cannot for the life of me figure out what to put for these two arguments. Then looking at the code just adds fuel to the confusion. Why isn’t java -jar tinyremapper.jar client.jar mapped.jar mappings.match enough? What is the point of “toM” and “fromM”?

Juuxel commented 1 year ago

from and to are the mapping namespaces (e.g. "intermediary" or "named") in a tiny-format mapping file, which can have any number of namespaces (at least 2, see #9).

To my knowledge you can't use .match files directly but Matcher can output .tiny files via the "Save Mappings" option as well.