Michael Bayne
f19b3d3776
doesn't need this repo reference because it builds and installs snapshot versions of all of our libraries locally, so it will find them without going to external repositories. Non-OOO people can also build OOO libraries that depend on snapshot versions by building and installing the snapshot version of the appropriate dependency into their local Maven repository. We had the OOO snapshot repo in these files so that OOO people could conveniently just have the OOO snapshots pulled down for them without having to build and install local snapshots. However, a better way to do that is to have OOO people just add the OOO snapshot repository to their ~/.m2/settings.xml file. I'll send a separate email about how to do that. git-svn-id: svn+ssh://src.earth.threerings.net/nenya/trunk@1096 ed5b42cb-e716-0410-a449-f6a68f950b19
The Nenya library
-----------------
The Nenya library provides various facilities for making networked multiplayer
games. Its various packages include:
* geom, util - basic tools for doing data structure manipulation and some
geometry math
* resource - tools for bundling, deploying and managing media (images,
sounds, etc.) with a game
* media - a framework for doing "active" rendering in Java
* media.image - tools for loading, caching, manipulating and displaying images
* media.sound - tools for loading, caching, and playing audio
* media.animation, media.sprite - works in concert with the active
rendering system and provides tools for defining and manipulating
sprites (graphical entities that follow paths) and animations
(graphical entities that affect the display in other ways)
* miso - a framework for defining and displaying isometrically rendered scenes
* cast - a framework for defining and using recolorable, composited
characters with different poses and actions
Documentation is somewhat sparse at the moment, but inspection of the code in
the tests/ directory shows examples of use of many features of the library.
Building
--------
Building the library is very simple. First ensure that the necessary third
party jar files are available in the lib/ directory. See lib/README for a list
of the necessary third party jar files and how to get them.
The library is built using Ant, a modern build tool written in and for Java. If
you aren't already using Ant for other projects, it can be found here:
http://ant.apache.org/
Invoke ant with any of the following targets:
all: builds the distribution files and javadoc documentation
compile: builds only the class files (dist/classes)
javadoc: builds only the javadoc documentation (dist/docs)
dist: builds the distribution jar files (dist/*.jar)
Distribution
------------
The Nenya library is released under the LGPL. The most recent version of the
library is available here:
http://code.google.com/p/nenya/
Contributions and Contact Information
-------------------------------------
Nerya is actively developed by the scurvy dogs at Three Rings Design, Inc.
Contributions are welcome.
Questions, comments, contributions, and other worldly endeavors can be
handled in the Google Group for Three Rings libraries:
http://groups.google.com/group/ooo-libs
$Id$