Marauroa on NetBeans: Difference between revisions

Download the source code from the Arianne website and build it yourself. You will be able to view the source code (if, for example, you want a deeper understanding of how it works), run a debug session into the Marauroa source code, and create the JavaDoc help information. See the rest of this page for this method.

Marauroa source code is held in a Git repository, and you can connect NetBeans to that repository and download the very latest code. This can be compiled, as with the released source code, but may not be as stable (it should be, though). You can find and fix bugs or make modifications, and submit patches back to the Marauroa project. Getting the code from the repository is not covered here, but once downloaded the rest of this page can be used to compile it.

You will need a location where you can save the files needed for development. The top level location is referred to as DEVPATH. Replace this with whatever you have chosen as that location. Do not create any sub-directories yet.

Click New Project, choose Java and Java Class Library. Click Next, then give the Project Name as marauroa. Change the Project Location to the top level location (DEVPATH, see above); the Project Folder is shown as DEVPATH\marauroa with DEVPATH being your chosen location. Directory DEVPATH\marauroa must be empty (or not exist).

Expand the Marauroa source file you have downloaded. Create a new directory named libs (i.e. DEVPATH\marauroa\libs). Copy the files h2.jar, log4j.jar, jnlp.jar and jython.jar from the source file libs directory to this new directory. Copy the whole of the source file src directory to the src directory created by NetBeans.

Return to the NetBeans IDE (Projects tab). It should have rescanned the files and read them into the project. If not, select Source, Scan for External Changes from the menu. A red exclamation mark warning icon shows the location of several errors. Right click the Libraries branch of the Project tree, and select Add Jar/Folder. Browse to the the libs directory for this project and select the h2.jar file. Wait until the Scanning process has finished, then repeat for each of the jar files copied from the source file libs directory (or use Ctrl-click to select multiple jar files). All red warning icons should disappear.

If there are no errors in the package, select Run, Clean and Build Project from the NetBeans menu bar. This will create marauroa.jar in the dist directory.

Select Run, Generate Javadoc from the NetBeans menu bar. This will create the Javadoc documentation files in the dist\javadoc directory, and open the index.html file from that directory in your web browser. The javadoc files contain the Marauroa documentation extracted from the source files. Read them or ignore them, it is your choice; you do not have to create them. They will be useful when you are trying to understand the structure of the Marauroa engine. To read them later, open the index.html in your web browser.

The files in the dist directory are the ones you will need for your game. This step has only created the marauroa library, not a game.