From cb1aae78b8e9611cdc4590e3b57a730b7eb631e5 Mon Sep 17 00:00:00 2001 From: Johann Bernhardt Date: Fri, 12 Nov 2021 13:21:20 +0100 Subject: [PATCH] Add FAQ and access transformer warning --- FAQ.md | 13 +++++++++++++ README.md | 6 ++++++ 2 files changed, 19 insertions(+) create mode 100644 FAQ.md diff --git a/FAQ.md b/FAQ.md new file mode 100644 index 0000000..d5c950d --- /dev/null +++ b/FAQ.md @@ -0,0 +1,13 @@ +# Things we cannot protect you from (yet) + +### Select an mcp conf dir for the deobfuscator + +You may or may not run into this popup. For now, the only solution is to point the deopfuscator into the right direction. + +![](http://i.imgur.com/gzBMLrr.png) + +Solution: Point it to `~/.gradle/caches/minecraft/net/minecraftforge/forge/1.7.10-10.13.4.1614-1.7.10/unpacked/conf`. On Windows, please use `%USERPROFILE%/.gradle/caches/minecraft/net/minecraftforge/forge/1.7.10-10.13.4.1614-1.7.10/unpacked/conf`. + +### Could not find :forgeBin:1.7.10-10.13.4.1614-1.7.10 + +Run the gradle task `setupDecompWorkspace`. \ No newline at end of file diff --git a/README.md b/README.md index fd70697..42000ee 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,10 @@ An example mod for Minecraft 1.7.10 with Forge focussed on a stable, updatable s We had our fair share in struggles with build scripts for Minecraft Forge. There are quite a few pitfalls from non-obvious error messages. This Example Project provides you a build system you can adapt to over 90% of Minecraft Forge mods and can easily be updated if need be. +### Help! I'm stuck! + +We all have been there! Check out our [FAQ](https://github.com/SinTh0r4s/ExampleMod1.7.10/blob/main/FAQ.md). If that doesn't help, please open an issue. + ### Getting started Creating mod from scratch: @@ -49,6 +53,8 @@ You may activate Forge's Access Transformers by defining a configuration file in Check out the [`example-access-transformers`](https://github.com/SinTh0r4s/ExampleMod1.7.10/tree/example-access-transformers) brach for a working example! +__Warning:__ Access Transformers are bugged and will deny you any sources for the decompiled minecraft! Your development environment will still work, you might face some inconveniences. For example, IntelliJ will not permit searches in dependencies without attached sources. + ### Mixins Mixins are usually used to modify vanilla or mod/library in runtime without having to change source code. For example, redirect a call, change visibility or make class implement your interface. It's an advanced topic and most mods don't need to do that.