Skip to content

Building.md

Latest commit

 

History

History
74 lines (54 loc) · 2.88 KB

Building.md

File metadata and controls

74 lines (54 loc) · 2.88 KB

Building AOI from source

Quickstart for the experienced developer:

  • Run gradle build in the main directory.
  • gradle tasks to see other targets.

If you're new to building java programs, please follow the detailed process and explanation below:

Prerequisites

Here's a list of the tools that you will need to work on the AOI source code:

  • A Java Developer Kit, java 8 or higher. This is a compiler that turns the java text files into something that the Java runtime can understand. You can download this from the AdoptOpenJDK project.
    • A Linux user should probably use their package mamager
    • macos users who use Homebrew can use brew install --cask adoptopenjdk
  • Gradle build tool A simple tool to automate compiling and packaging a large number of java files. Again, Linux users can probably get this through their package manager.
  • Git is used for tracking changes that you have made to the code, and coordinating with other people.
  • An editor suitable for use with program source code. This means something other than notepad or Microsoft Word. One good, free option for Windows users is notepad++.

Obtaining and building the sources

Create a new directory on your hard drive where you would like to keep your AOI development build, then access it from a command line:

  • If you have a github account, with an SSH key, type: git clone git@github.com:makiam/Tokonga.git
  • If you don't have an account, or don't use SSH, type: git clone https://github.com/makiam/Tokonga.git

This will access the repository on github and make a copy in your directory. This may take a few minutes.

To build AOI, type: gradle assemble. This will create a working AOI distributions under ArtOfillusion/ArtOfIllusion/build/distributions. This application is suitable for testing and experimentation, but will not have desktop integration and filetype association.

To launch AOI, type gradle run.

Structure of a development build

  • Plugins directory where AOI looks for installed plugins. These include the standard modeling tools and file translators. The standard plugins are overwritten when you rebuild. Any other plugins in this directory are not touched, and can continue to be used from build to build.
  • Scripts directory where beanshell and groovy scripts live. None are generated by the build process.
  • Textures and Materials Installation directory that holds a library of .aoi files that contain re-usable textures and materials. The build process does not populate this directory.

Building installers

AOI installers for Linux and Windows are built using IZPack. The templates are found in InstallerSrc Apple OS mountable .dmg files are built by hand.

Building any of these yourself should not be neccessary, and is not recommended.