PyJ2D
Copyright (C) 2011 James Garnon

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see <http://www.gnu.org/licenses/>.

PyJ2D version 0.21
Download Site: http://gatc.ca


Description:
PyJ2D module was modelled on Pygame commands that permits scripts coded in Python/Pygame to run in the Java virtual machine (JVM) using the Jython interpreter. This permits the deployment of JVM applications without extensive editing of the script. The current version of the module only supports a subset of Pygame functionality.

To use the PyJ2D module, place the pyj2d folder in the script folder or on the module path. Import pyj2d into the Python script, or use the statement 'import pyj2d as pygame' to maintain the Pygame commands.

To launch a desktop application, JVM must be installed and have Jython. In Linux, Jython may be installable from the package manager. To obtain Jython to install using Java runtime, go to its Jython website (www.jython.org), and follow the instructions to either install Jython or create a standalone jython.jar package. If Jython is installed use command 'jython script.py', or standalone method use command 'java -jar jython.jar script.py'. Running on JVM on the desktop was tested with Jython version 2.21 and 2.52, and should work with Java Web Start.

To create a deployable Java applet, copy Applet.py to the script folder, and edit Applet.py to import your Python/Pygame script, set applet size, and code to link the applet thread to the script application, including script setup, and script execution statements that will update during the applet thread loop. Alternatively, use Applet.py as a guide and edit your Python/Pygame script accordingly. To test, the edited Applet.py script can be run directly on the desktop JVM, which executes the applet code with the pawt module in main(). To create an applet jar that can be deployed online, use the command 'jythonc --core --deep --jar Pyj2d_Applet.jar Applet.py' to package together with Jython dependencies, or 'jythonc --jar Pyj2d_Applet.jar Applet.py' to package alone in which case jython.jar must be included. To update the applet jar with an image folder, use command 'jar uf Pyj2d_Applet.jar image'. Note that Java applets do not start from main() rather launch from japplet subclass with the same name as the script.

To run the applet on desktop before deployment online, use appletviewer included with Sun's JDK package, which tests execution and whether applet conforms to security profile; using this method, unsigned applets were created successfully, but if code is required that violates security such as disk access, the applet needs to be signed for permission. To use appletviewer, place an edited Applet.html together with applet jar(s), and use command 'appletviewer Applet.html'. To deploy online, place applet jar(s) on your server, and to launch from browser, a method that worked is to initiate the applet using JavaScript in Applet.js, after editing applet size, jar name and site URL, that is embedded on the webpage.