0
0
mirror of https://github.com/Wurst-Imperium/Wurst7.git synced 2024-09-20 01:12:13 +02:00

Create scripts/README.md

This commit is contained in:
Alexander01998 2020-02-02 00:22:33 +01:00 committed by GitHub
parent 2094ef1074
commit 2e7ce6fcd3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

23
scripts/README.md Normal file
View File

@ -0,0 +1,23 @@
# What These Scripts Do
## `genSources-eclipse.cmd`
Performs all the necessary setup so you can use this project in Eclipse. You need to run this script again every time that the Yarn mappings, Fabric loader or Fabric API in [gradle.properties](/gradle.properties) change. (Keep in mind that this also happens every time that you switch to a different Minecraft version.)
## `build.cmd`
Compiles the project into a `.jar` file that you can place in your `mods` folder. **This will not work without running `genSources-eclipse` first!**
## `migrateMappings_v2.cmd`
For switching to different Yarn mappings (e.g. when updating to a new Minecraft version). After running this script, update [gradle.properties](/gradle.properties) with the new versions, then re-run `genSources-eclipse`.
## `migrateMappings.cmd`
**Old version.** For switching to mappings that don't end in `:v2`. These only exist for Minecraft 1.14.x and some old snapshots. You won't need this in 1.15+.
## `downloadAssets.cmd`
To fix missing assets (no sound, missing textures, etc). Mostly happens when using the **old** `migrateMappings` script.
## `premerge.bat`
To download a pull request and try it out locally before merging. No idea why this ends in `.bat` instead of `.cmd`.