diff --git a/docs/migration.md b/docs/migration.md index cace1af..4b92331 100644 --- a/docs/migration.md +++ b/docs/migration.md @@ -1,11 +1,11 @@ # Migration guides ## Generic migration -Migration for the typical mod which doesn't usy anything special but minecraft forge and some library dependencies. -For core plugin, mixins, shadowing, access transformes, asm or etc. you'll need to do some extra steps. -If they are missing in this document - we will gladly receive your suggestions/contribution. +Migration for the typical mod which doesn't use anything special but Minecraft forge and some library dependencies. +For core plugin, Mixins, shadowing, access transformers, ASM or etc. you'll need to do some extra steps. +If they are missing in this document - we will gladly receive your suggestions/contribution. -1. Copy and replace all files from template to your repository, but: // TODO: (maybe we should have a task in CI which attaches zip with all files but these, called "migration-bundle.zip" or smth) +1. Copy and replace all files from template to your repository, but: 1. `build.gradle` 2. `src` 3. `LICENSE` @@ -16,7 +16,8 @@ If they are missing in this document - we will gladly receive your suggestions/c 4. replace your `build.gradle(.kts)` with `build.gradle` from template. In case you have written some custom tasks/configurations not present in the template - you'll best to move them to separate file and link it in this, like for example it does this with `dependencies.gradle` 5. Adapt `gradle.properties` to your mod 6. Ensure `src/main/resources/mcmod.info` contains `${modId}`, `${modName}`. `${modVersion}` and `${minecraftVersion}` -7. Run `./gradlew clean setupDecompWorkspace` +7. Re-import the project to your IDE (e.g. restart with clean caches in IntelliJ IDEA) +8. Run `./gradlew clean setupDecompWorkspace` ## Mixin configuration For the reference checkout the [example mixin configuration branch](https://github.com/SinTh0r4s/ExampleMod1.7.10/tree/example-mixins) of the template.