Getting Started

You have two routes:

I am not a 'Java' programmer

1. Download version of Purugin.jar
2. copy Purugin.jar into your servers plugins directory. If you are unfamiliar with setting up your own CraftBukkit server for Minecraft you should visit the page setting up a server.
3. Download latest version of jruby-complete.jar from http://www.jruby.org/download. Be sure to get jruby-complete jar.
4. Copy jruby-complete.jar to your minecraft server directory (sibling of your plugins directory).

To execute the server you need a slightly special command-line (on Unix/Mac systems):

    GEM_HOME=./gems java -Xms1024M -Xmx1024M -cp jruby-complete.jar:craftbukkit.jar org.bukkit.craftbukkit.Main

Or on windows:

    set GEM_HOME=.\gems
    java -Xms1024M -Xmx1024M -cp jruby-complete.jar;craftbukkit.jar org.bukkit.craftbukkit.Main

Putting these commands into a run.sh (linux) or run.bat (windows) can save a bunch of typing.

If your using Glowstone instead of CraftBukkit change craftbukkit.jar to glowstone.jar and change org.bukkit.craftbukkit.Main to net.glowstone.GlowServer. This was only tested using very simple Purugin plugins.

I want to build Purugin myself

To get a working Purugin.jar you should:

1. Hava Java installed
2. Have Maven installed

What you should do to compile and install Purugin.jar:

1. Git clone this repository
2. mvn -Pfatjar
3. cp target/purugin-*jar ../MY_MINECRAFT_SERVER_DIR/plugins/Purugin.jar

If you do not have a Minecraft server installation you can look at CraftBukkit's site setting up a server.

Once you have Purugin.jar installed in the Purugin's directory you can start your server as described in CraftBukkits documentation. I typically use:

    GEM_HOME=./gems java -Xms1024M -Xmx1024M -jar craftbukkit.jar

Note: If you don't want an all-in-one drop into plugins dir version of Purugin built (like what is uploaded to dev.bukkit.org) then just do a 'mvn' and leave off fatjar profile.