Skip to content

Commit

Permalink
update readme with instructions for gradle
Browse files Browse the repository at this point in the history
  • Loading branch information
daveyliam committed Mar 1, 2014
1 parent bb3df21 commit 481aca9
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 33 deletions.
45 changes: 14 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,43 +6,26 @@ MapWriter: A minimap mod for Minecraft

Instructions for development:

1) Set up your Forge/MCP environment.
1) Run "gradlew setupDecompWorkspace" in the mapwriter folder.

2) Move or copy the mapwriter folder to forge/mcp/src/minecraft/
2) Run "gradlew eclipse" if using the eclipse IDE. If it does not work you may
need to copy the eclipse folder from a Forge src release into the mapwriter
folder and retry the command.

3) Copy or move the textures from mapwriter/textures/*.png to
forge/mcp/bin/minecraft/assets/mapwriter/textures/map/*.png
3) Open eclipse and set the workspace directory to mapwriter/eclipse.

4) Modify the code, and use recompile.bat and startclient.bat to test.
Alternatively use Eclipse and recompile and test by pressing the run button.
4) You should now be able to modify the code and test by using the "Client" Run
Configuration.

Reobfuscation and Packaging:

1) Run the recompile.bat script in your mcp directory.

2) Run the reobfuscate.bat script.

3) Create a zip file of the 'forge/mcp/reobf/minecraft/mapwriter' folder.

4) Add the textures to the zip file in the folder
[MapWriter.zip]/assets/mapwriter/textures/map/*.png

The final structure should look like:
MapWriter.zip
| assets/mapwriter/textures/map/
| | arrow_north.png
| | arrow_player.png
| | ...
|
| mapwriter/
| api/
| forge/
| gui/
| map/
| ...
| Mw.class
| MwUtil.class
| ...
1) Edit the version numbers in mapwriter.forge.MwForge and build.gradle.
The version numbers in mcmod.info should automatically be set to the same
versions as set in the build.gradle file.

2) Run "gradlew reobf".

3) The reobfuscated jar should be output to the mapwriter/build/libs folder.

Acknowledgements:

Expand Down
2 changes: 1 addition & 1 deletion build.gradle
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ buildscript {

apply plugin: 'forge'

version = '2.1.0'
version = '2.1.1'
group = 'mapwriter'
archivesBaseName = 'MapWriter'

Expand Down
2 changes: 1 addition & 1 deletion src/main/java/mapwriter/forge/MwForge.java
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@

import java.net.InetSocketAddress;

@Mod(modid="MapWriter", name="MapWriter", version="2.1.0")
@Mod(modid="MapWriter", name="MapWriter", version="2.1.1")
public class MwForge {

private MwConfig config;
Expand Down

0 comments on commit 481aca9

Please sign in to comment.