This is the Moonlight Application Framework, a framework for Java applications. It is based on Qt Jambi and provides a runtime environment for applications that are written as a set of plugins. Prerequisites ------------- Although the framework is written in Java, it contains third party components that come as platform specific native libraries. This means that the framework is only officially supported on the following platforms: Linux/x86 Linux/x86_64 Windows/x86 The Moonlight framework might run on other platforms as well, but this has not been tested and the developers cannot actively support them at the moment. Additionally, you need to have Java 1.6 or higher installed. If you have more than one Java installation on your system please verify that you are running a version that is current enough by running the command java -version and reviewing the program output. The Moonlight Application Framework will not run with any older versions of the Java runtime. Please note that the framework was only tested with the JREs and JDKs provided by Sun Microsystems. Correct functionality on other Java VMs is not guaranteed. We would like to hear about your experiences with other VMs. Compilation ----------- The Moonlight Application framework is delivered only in source code form. In order to use it, you have to compile it. To do this, you should follow these steps: 1. Get Qt Jambi for your set of platforms from http://trolltech.com/products/qt/jambi and copy the library files and the qtjambi.jar file for each platform into the lib/ subdirectory for that platform: the files for Linux on x86 go to lib/Linux/x86, the files for Linux on x86_64 go to lib/linux/x86_64 and so on. 2. Go to the ant-tasks subdirectory and run ant. 2. Go back to the mlframework directory and run > ant package No errors should be reported during both ant runs. This leaves you with a mlframework.jar in the top-level directory, which is the core runtime, and with several jar and XML files in the plugins/-directory which are a set of core plugins provided with the framework itself for convenience. Using the framework ------------------- No concise documentation on building applications on top of the framework has been written yet. But there is reference documentation available in doc/. Also, a small example called mlminimal is available which shows is the smallest possible fully functional interactive program that can be written using the Moonlight Application Framework. It should have been extracted into the directory mlminimal/ alongside the framework source code. Support and User community -------------------------- The framework has been developed as a part of Moonlight|3D. The program website is located at http://www.moonlight3d.eu and the support and user forum is located at http://www.moonlight3d.eu/forum. This is a great place to ask for help if you run into trouble when using this framework. Also feel free to report on your experiences with the framework and your ideas for improvements there. You should also post any patches or fixes to any bugs you discover in the framework there.