Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

better setup.sh and a readme!

  • Loading branch information...
commit b83888ad1fba940ec334a944913c6554e342e0ec 1 parent 0493f7c
Daniel Ribeiro authored

Showing 2 changed files with 64 additions and 1 deletion. Show diff stats Hide diff stats

  1. +62 0 README.md
  2. +2 1  setup_scripts/setup.sh
62 README.md
Source Rendered
... ... @@ -0,0 +1,62 @@
  1 +Conjcraft
  2 +==============
  3 +
  4 +Conjcraft is an open source mod for [Minecraft](http://www.minecraft.net/) written in [Clojure](http://clojure.org/). It uses [ModLoader](http://www.minecraftdl.com/modloader-risugami-downloads/) and [Minecraft Coder Pack](http://mcp.ocean-labs.de/index.php/Main_Page) (aka MCP) (thanks guys!).
  5 +
  6 +
  7 +Installing the mod
  8 +----
  9 +
  10 +This assumes you have basic dev tool setup (specifically wget and curl) and lawfully own a copy of Minecraft.
  11 +
  12 +If you don't have [ModLoader](http://www.minecraftdl.com/modloader-risugami-downloads/) install, you can install it and the mod in one line
  13 +
  14 + $ curl https://raw.github.com/danielribeiro/conjcraft/master/setup_scripts/full_install.sh | bash
  15 +
  16 +If you have [ModLoader](http://www.minecraftdl.com/modloader-risugami-downloads/) installed, you can install the mod in one line:
  17 +
  18 + $ curl https://raw.github.com/danielribeiro/conjcraft/master/setup_scripts/install.sh | bash
  19 +
  20 +
  21 +Installing the mod (full developer mode, including MCP)
  22 +----
  23 +This is not required if you just wanna play with the recipes, as they are all plain text clojure files included in the conjcraft folder installed on your home directory (the above installation creates them).
  24 +
  25 +This setup assumes the setup above, and that you have git installed.
  26 +
  27 + $ curl https://raw.github.com/danielribeiro/conjcraft/master/setup_scripts/dev_install.sh | bash
  28 +
  29 +You do not need [ModLoader](http://www.minecraftdl.com/modloader-risugami-downloads/) installed, unless you want to release your changes (just run ./release.sh). In this case, after the setup, just change to minecraft_modding and run
  30 +
  31 + $ ./startclient.sh
  32 +
  33 +If you cloned this git repo, you can setup everything just by using:
  34 +
  35 + $ ./setup_scripts/setup.sh
  36 +
  37 +
  38 +Running tests
  39 +----
  40 +The recipe [DSL](http://www.manning.com/ghosh/) has basic clojure/test tests in the recipe_dsl_test.clj. They can be run with:
  41 +
  42 + $ ./run_tests.sh
  43 +
  44 +Locally installing your changes
  45 +----
  46 +To install your changes (java ones, as, by default, clojure changes will be in the correct path if you haven't changed anything), just run
  47 +
  48 + $ ./release.sh
  49 +
  50 +This requires [ModLoader](http://www.minecraftdl.com/modloader-risugami-downloads/) installed. If you have not it installed, you can do it in one line with:
  51 +
  52 + $ ./setup_scripts/install_modloader.sh
  53 +
  54 +
  55 +Meta
  56 +----
  57 +
  58 +Created by Daniel Ribeiro. Not affiliated with Mojang. Minecraft is a trademark of [Mojang](http://mojang.com/).
  59 +
  60 +Released under the MIT License: http://www.opensource.org/licenses/mit-license.php
  61 +
  62 +https://github.com/danielribeiro/conjcraft
3  setup_scripts/setup.sh
@@ -25,6 +25,7 @@ cd ../../
25 25 yes Yes | ./updatemcp.sh
26 26 ./decompile.sh
27 27 cd ..
28   -cp bin/*.jar minecraft_modding/lib/
29 28 ./create_constants.sh
  29 +cp bin/*.jar minecraft_modding/lib/
  30 +cp java/* minecraft_modding/src/minecraft/net/minecraft/src/
30 31 echo == Minecraft Setup Done ==

0 comments on commit b83888a

Please sign in to comment.
Something went wrong with that request. Please try again.