Skip to content
Newer
Older
100644 113 lines (83 sloc) 4.26 KB
a5ad43c @samskivert Brought the README out of the stoneage, Markdownified.
samskivert authored
1 The Narya library
2 =================
3
4 Narya provides a framework for building realtime distributed systems with an
5 emphasis on multiplayer online games (massive or otherwise). Its various
6 packages include:
7
8 * [presents]: A distributed object and remote procedure call framework for
9 creating realtime distributed systems.
10 * [crowd]: A foundation for a multiplayer environment with notions of bodies
11 and places, and support for chat and moving between places.
12 * admin: Useful administrative functionality including a mechanism for
13 declaring configuration that can be viewed and modified at runtime by an
14 administrative client.
15 * bureau: A framework for managing a network of code execution servers, which
16 can be used to host ActionScript server-side code in addition to the Java
17 server normally used by presents.
18
9890b96 @samskivert Added link to javadocs.
samskivert authored
19 [Javadoc documentation](http://threerings.github.com/narya/apidocs/) is
20 provided.
21
a5ad43c @samskivert Brought the README out of the stoneage, Markdownified.
samskivert authored
22 Tutorials, etc.
23 ---------------
24
2cfbf4d @samskivert Update README with new newness.
samskivert authored
25 Three Rings hosts a site called [Game Gardens] where the Narya library is used
26 to develop a wide array of multi-player online games. On that site you can find
27 [tutorials and sample code](http://wiki.gamegardens.com/) relating to the use
28 of Narya in game development.
a5ad43c @samskivert Brought the README out of the stoneage, Markdownified.
samskivert authored
29
30 Building
31 --------
32
2cfbf4d @samskivert Update README with new newness.
samskivert authored
33 The library is built using Maven, or [Ant](http://ant.apache.org/).
a5ad43c @samskivert Brought the README out of the stoneage, Markdownified.
samskivert authored
34
2cfbf4d @samskivert Update README with new newness.
samskivert authored
35 The Maven build uses the standard targets:
36
37 package: builds the code and creates the jars and swcs
38 install: builds and installs the artifacts into your local Maven repository
39 test: builds and runs the unit tests
40
41 The Ant build uses the following targets:
a5ad43c @samskivert Brought the README out of the stoneage, Markdownified.
samskivert authored
42
43 all: builds the distribution files and javadoc documentation
44 compile: builds only the class files (dist/classes)
45 javadoc: builds only the javadoc documentation (dist/docs)
46 dist: builds the distribution jar files (dist/*.jar)
47
2cfbf4d @samskivert Update README with new newness.
samskivert authored
48 If you wish to build the ActionScript components via Ant, you will need to
49 supply the location of the Flex SDK on the command line:
a5ad43c @samskivert Brought the README out of the stoneage, Markdownified.
samskivert authored
50
51 % ant -Dflexsdk.dir=SOMEPATH dist
52
53 Artifacts
54 ---------
55
2cfbf4d @samskivert Update README with new newness.
samskivert authored
56 Narya provides three different build artifacts, for differing purposes:
9647820 @samskivert Details on our numerous artifacts.
samskivert authored
57
58 * narya: contains the main Java library; exports dependencies only for
59 libraries which are required by a running client or server.
60 * naryalib: contains the main ActionScript library; exports dependencies for
61 libraries needed when building a SWF using naryalib.
62 * narya-tools: contains the code generation portions of Narya which one need
63 integrate into their build; exports dependencies for various libraries needed
64 when running code generation.
2cfbf4d @samskivert Update README with new newness.
samskivert authored
65
66 Narya is published to Maven Central. To add a Narya dependency to a Maven
67 project, add the following to your `pom.xml`:
68
a5ad43c @samskivert Brought the README out of the stoneage, Markdownified.
samskivert authored
69 <dependencies>
70 <dependency>
71 <groupId>com.threerings</groupId>
72 <artifactId>narya</artifactId>
2cfbf4d @samskivert Update README with new newness.
samskivert authored
73 <version>1.11</version>
a5ad43c @samskivert Brought the README out of the stoneage, Markdownified.
samskivert authored
74 </dependency>
75 </dependencies>
76
77 To add it to an Ivy, SBT, or other Maven repository using project, simply
78 remove the vast majority of the boilerplate above.
79
80 If you prefer to download pre-built binaries, those can be had here:
81
2cfbf4d @samskivert Update README with new newness.
samskivert authored
82 * [narya-1.11.jar](http://repo2.maven.org/maven2/com/threerings/narya/1.11/narya-1.11.jar)
83 * [naryalib-1.11.swc](http://repo2.maven.org/maven2/com/threerings/naryalib/1.11/naryalib-1.11.jar)
84 * [narya-tools-1.11.jar](http://repo2.maven.org/maven2/com/threerings/narya-tools/1.11/narya-tools-1.11.jar)
a5ad43c @samskivert Brought the README out of the stoneage, Markdownified.
samskivert authored
85
86 Related Libraries
87 -----------------
88
2cfbf4d @samskivert Update README with new newness.
samskivert authored
89 Narya is extended by the [Nenya] and [Vilya] libraries which provide additional
a5ad43c @samskivert Brought the README out of the stoneage, Markdownified.
samskivert authored
90 game related functionality like 2D and 3D graphics support, animated character
91 rendering and a more sophisticated virtual world framework.
92
93 Distribution
94 ------------
95
96 Narya is released under the LGPL. The most recent version of the library is
9952456 @deadmoose GHFM autolinkifies, but doesn't know to ignore the period.
deadmoose authored
97 available at http://github.com/threerings/narya
a5ad43c @samskivert Brought the README out of the stoneage, Markdownified.
samskivert authored
98
99 Contact
100 -------
101
102 Questions, comments, and other worldly endeavors can be handled via the [Three
103 Rings Libraries](http://groups.google.com/group/ooo-libs) Google Group.
104
105 Narya is actively developed by the scurvy dogs at
106 [Three Rings](http://www.threerings.net) Contributions are welcome.
107
20ded3b @samskivert Properly format them links.
samskivert authored
108 [presents]: http://threerings.github.com/narya/apidocs/com/threerings/presents/package-summary.html
109 [crowd]: http://threerings.github.com/narya/apidocs/com/threerings/crowd/package-summary.html
2cfbf4d @samskivert Update README with new newness.
samskivert authored
110 [Game Gardens]: http://www.gamegardens.com/
111 [Nenya]: http://github.com/threerings/nenya
112 [Vilya]: http://github.com/threerings/vilya
Something went wrong with that request. Please try again.