Skip to content

Commit

Permalink
In progress... example mod
Browse files Browse the repository at this point in the history
  • Loading branch information
leighghunt committed May 20, 2016
1 parent b69e58b commit 01a222d
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 8 deletions.
3 changes: 3 additions & 0 deletions README.md
Expand Up @@ -16,3 +16,6 @@ We're using *portable versions* of the Java Development Kit and Eclipse so that
- Tutorial video: https://www.youtube.com/watch?v=VhOSL7rGb10
- http://www.minecraftforge.net/wiki/Installation/Source
- http://mcforge.readthedocs.org/en/latest/gettingstarted/

## Other tutorials
- [Minecraft Forge Installation Tutorials (User rather than dev focused)](https://www.youtube.com/playlist?list=PLnpPguhVZMItSgWX8g8NFTq_rYrElxZ96)
7 changes: 5 additions & 2 deletions dev-environment-setup.md
Expand Up @@ -3,6 +3,8 @@

A development environment is a set of tools we use to develop and debug software. We could do much of this without one, but a development environment will make these tasks easier.

Largely inspired by [MrCrayfish's](https://twitter.com/MrCraayfish) great [tutorial video](https://www.youtube.com/watch?v=VhOSL7rGb10)

- The *Java Development Kit* is the *software development kit* we're going to use to build our mods. It give us a bunch of tools to develop using *Java*, the language Minecraft is programmed in.
- *Eclipse* is the *integrated development environment* we're going to use to helps us build and debug the software.
- MinecraftForge is a set of libraries and package we use to build the mods for Minecraft, using Eclipse and the JDK.
Expand Down Expand Up @@ -71,8 +73,9 @@ javac 1.8.0_77
- Run the file, and extract into a folder. Accept the default (````%USERNAME%\Downloads\EclipsePortable````)
- Copy all files and folders from the **Downloads\jdk** folder to the **Downloads\EclipsePortable\App\Java**

### Minecraftforge
- Browse to http://files.minecraftforge.net/ and download the **Recommended MDK** file.
### Minecraftforge (version 1.8)
- We're using version 1.8 of Minecraft Forge as there are more examples, tutorials and samples available to us.
- Browse to http://files.minecraftforge.net/maven/net/minecraftforge/forge/index_1.8.9.html and download the **Recommended MDK** file.
- **WARNING** There are annoying adverts on this download site - don't download anything other than the forge-xxxxx-mdk.zip file - look for a **SKIP** button, and ignore any adverts.
- Unzip the downloaded ````forge-1.8.9-11.15.1.1722-mdk.zip```` file to ````%USERNAME%\Downloads\forge````.
- In Windows Explorer, navigate to the new ````Downloads\forge```` directory, and again, hold down **Shift**, and **right click**, then select "Open command window here".
Expand Down
24 changes: 18 additions & 6 deletions example1-mod.md
@@ -1,6 +1,18 @@
# Let's start MODDING (well almost)
### WOW - you've got further than we have!
- You're ready to start creating a mod - but we haven't got that far here yet - check back in coming weeks for updates, or send us a pull request with some notes yourself!
- In the meantime, here are some additional resources for the next steps:
- [Wuppy's modding tutorials on YouTube](https://www.youtube.com/user/wuppygaming/videos)
- [MinecraftForge's Basic Modding tutorial](http://www.minecraftforge.net/wiki/Basic_Modding)
# Let's start MODDING
- You're ready to start creating a mod - we're going to follow [MrCrayfish's](https://twitter.com/MrCraayfish) Minecraft 1.8 Modding tutorial - [Episode 2 - Mod Class](https://www.youtube.com/watch?v=S8Oy2Z5V2VU&index=2&list=PLy11IosblXIFDFAT3wz_5Nve05wIVKFSJ).

- We should have already [setup out development environment](dev-environment-setup.md).

- Delete the example mod
- ````src/main/java/```` - ````com.example.examplemod```` - Right Click and delete.
- Create a new package
- ````src/main/java/```` - Right Click and New -> Package.
- In Java, packages often are often given a name of an organisation's website, but in reverse. So http://cdr.nz would become ````nz.cdr````.
- Think of each dot being a new directory.
- *Why do you think this might be?*
- We'll use the name ````nz.cdr.minecrafttutorial```` for our package, or you can use your website, or minecraft username.
- Click **Finish**.
- Create a new class
- ````src/main/java/nz.cdr.minecrafttutorial```` - Right Click and New -> Class.
- Give it the name ````TutorialMod````.
- Click **Finish**.

0 comments on commit 01a222d

Please sign in to comment.