aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJonas Herzig <me@johni0702.de>2019-04-24 14:52:29 +0200
committerJonas Herzig <me@johni0702.de>2019-04-24 14:52:41 +0200
commit5fba27c5313046ab5c9ccdefeb94a81b292ef8d4 (patch)
treeb546608a939a91f0caf8d5cd30b6caf1ebc54715 /README.md
downloadRemap-5fba27c5313046ab5c9ccdefeb94a81b292ef8d4.tar.gz
Remap-5fba27c5313046ab5c9ccdefeb94a81b292ef8d4.tar.bz2
Remap-5fba27c5313046ab5c9ccdefeb94a81b292ef8d4.zip
Initial commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..953c09f
--- /dev/null
+++ b/README.md
@@ -0,0 +1,13 @@
+### Remap
+To support multiple Minecraft versions with the ReplayMod, a preprocessor is used which transforms source code to compile against different Minecraft versions.
+
+To keep preprocessor statements to a minimum and support changes in mapping (of originally obfuscated Minecraft names), the preprocessor additionally supports
+source remapping of class, method and field names implemented in the application through use of the Eclipse JDT.
+
+This is not integrated into the preprocessor itself for essentially two reasons:
+- License incompatibility between the GPL used in the ReplayMod (and the preprocessor) and the EPL used by the JDT
+- Lombok requires a javaagent to work for the JDT, so we need to fork off into a separate JVM anyway
+
+## License
+The Remap application is provided under the terms of the Eclipse Public License Version 2.
+See `EPL-2.0.txt` for the full license text. \ No newline at end of file