Further enhancement to the README.

git-svn-id: svn+ssh://src.earth.threerings.net/vilya/trunk@1079 c613c5cb-e716-0410-b11b-feb51c14d237
This commit is contained in:
Michael Bayne
2011-04-06 22:18:22 +00:00
parent d272c17b7b
commit 7f339bede3
+45 -12
View File
@@ -4,20 +4,22 @@ The Vilya library
The Vilya library provides various facilities for making networked multiplayer The Vilya library provides various facilities for making networked multiplayer
games. Its various packages include: games. Its various packages include:
* whirled - builds on the crowd framework and defines a scene graph with * [whirled] - builds on the crowd framework and defines a scene graph with
portals to move between scenes and provides hooks for distributing and portals to move between scenes and provides hooks for distributing and
updating scene data (for example isometric rendering information) over the updating scene data (for example isometric rendering information) over the
network network
* parlor - builds upon the crowd framework to create the notion of a game with * [parlor] - builds upon the crowd framework to create the notion of a game with
players and provides tools for making turn based games players and provides tools for making turn based games
* puzzle - builds on the parlor and media frameworks to provide tools for * [puzzle] - builds on the parlor and media frameworks to provide tools for
implementing puzzle games in a networked environment implementing puzzle games in a networked environment
* micasa - builds on the parlor framework to provide lobbies and matchmaking * [micasa] - builds on the parlor framework to provide lobbies and matchmaking
for multiplayer games for multiplayer games
Documentation is somewhat sparse at the moment, but inspection of the code in [Javadoc documentation](http://threerings.github.com/vilya/apidocs/) is provided.
the `src/test/java/` directory shows examples of use of many features of the
library. Tutorial-style documentation is somewhat sparse at the moment, but inspection
of the code in the `src/test/java/` directory shows examples of use of many
features of the library.
Building Building
-------- --------
@@ -31,6 +33,33 @@ Invoke ant with any of the following targets:
javadoc: builds only the javadoc documentation (dist/docs) javadoc: builds only the javadoc documentation (dist/docs)
dist: builds the distribution jar files (dist/*.jar) dist: builds the distribution jar files (dist/*.jar)
Artifacts
---------
A Maven repository containing released versions of the Vilya Java and
ActionScript artifacts are maintained here. To add a Vilya dependency to a
Maven project, add the following to your `pom.xml`:
<repositories>
<repository>
<id>vilya-repo</id>
<url>http://threerings.github.com/vilya/maven</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>com.threerings</groupId>
<artifactId>vilya</artifactId>
<version>1.3</version>
</dependency>
</dependencies>
To add it to an Ivy, SBT, or other Maven repository using project, simply
remove the vast majority of the boilerplate above.
If you prefer to download a jar file, that can be found
[here](http://threerings.github.com/vilya/maven/com/threerings/vilya/).
Distribution Distribution
------------ ------------
@@ -40,9 +69,13 @@ library is available at http://github.com/threerings/vilya.
Contact Contact
------- -------
Questions, comments, contributions, and other worldly endeavors can be handled Questions, comments, and other worldly endeavors can be handled via the [Three
in the [Google Group for Three Rings Rings Libraries](http://groups.google.com/group/ooo-libs) Google Group.
libraries](http://groups.google.com/group/ooo-libs).
Vilya is actively developed by the scurvy dogs at [Three Rings Design, Vilya is actively developed by the scurvy dogs a
Inc.](http://www.threerings.net) Contributions are welcome. [Three Rings](http://www.threerings.net) Contributions are welcome.
[whirled]: http://threerings.github.com/vilya/apidocs/com/threerings/whirled/package-summary.html
[parlor]: http://threerings.github.com/vilya/apidocs/com/threerings/parlor/package-summary.html
[puzzle]: http://threerings.github.com/vilya/apidocs/com/threerings/puzzle/package-summary.html
[micasa]: http://threerings.github.com/vilya/apidocs/com/threerings/micasa/package-summary.html