Chunky

Chunky is a Minecraft mapping and rendering tool.

Quick links:

• Wiki
• Subreddit
• Dev Blog

Copyright & License

Chunky is Copyright (c) 2010-2013, Jesper Öqvist jesper@llbit.se

Permission to modify and redistribute is granted under the terms of the GPLv3 license. See the file license/LICENSE.txt for the full license.

Chunky uses the following 3rd party libraries:

• JOCL by Marco Hutter. JOCL is covered by the MIT/X11 license. See the file license/JOCL.txt for the full license and copyright notice.
• MWC64X by David Thomas. MWC64X is covered by the BSD license. See the file license/MWC64X.txt for the full license and copyright notice.
• log4j by the Apche Software Foundation. The log4j library is covered by the Apache License, version 2.0. See the file license/LOG4J.txt for the full license. See the file license/NOTICE for the copyright notice.
• Markdown by John Gruber Markdown is covered by a BSD-style open source license. See the file license/Markdown for the full license.

Building

There is an Apache Ant script provided with Chunky that can be used to build the project. The default target will compile the code. To build a jar file use the jar or release targets.

Running

Chunky uses a lot of memory. In order to give Chunky extra memory to work with you can run Chunky from the command line with for example

java -Xmx4g -Xms512m -jar Chunky.jar

This will start with 512 MiB minimum heap size and 4 GiB maximum.

Rendering using the command line (Headless Mode)

It is possible to render a scene from the command line. First set up a scene using the GUI. Don't forget to save the scene. Then run the following on the command line:

java -jar ~/Chunky/Chunky.jar -render SceneName.cvf

Where SceneName is the name of the scene to render. You can read more about headless rendering on the Wiki.

Code Style

The standard Eclipse Java style is used, with slight modifications. If you want to contribute code to Chunky please make your code look similar to the rest of the code.

Additional Information

More information about Chunky, including a short getting started guide and rendering tips are available at the Chunky Wiki.