forked from gladiusjs/gladius
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Alan Kligman
committed
Jun 2, 2012
1 parent
5994b0c
commit 728b2dc
Showing
1 changed file
with
83 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
Gladius | ||
======= | ||
|
||
* [FAQ](https://github.com/gladiusjs/gladius-core/wiki/Faq) | ||
* [IRC](irc://irc.mozilla.org/#games) | ||
* [Mailing List](https://lists.mozilla.org/listinfo/community-games) | ||
* [Twitter](https://twitter.com/#!/gladiusjs) | ||
* [Contributors](https://github.com/gladiusjs/gladius-core/contributors) | ||
|
||
# Gladius is a 3D game engine | ||
|
||
Gladius is a 3D game engine, written entirely in JavaScript, and designed to run in the browser. We leverage existing web technologies whenever possible and where gaps exist in support for games, we develop new solutions. | ||
|
||
The engine consists of a core set of functionality that is common to all games and simulations like the game loop, messaging, tasks and timers. Common components like the spatial transform are also provided by the core. More specialized funcionality, like graphics or physics, is encapsulated into engine extensions that are designed to run on top of the core. A common set of extensions is maintained as part of this project, and support for third-party extensions is a strong design objective. | ||
|
||
An engine instance is comprised of the engine core plus a set of extensions. | ||
|
||
# Related projects | ||
|
||
We are also building a set of tools and libraries for building games. They are designed to be generally useful and reusable in other projects as well. | ||
|
||
<b>Check out our [roadmap](https://github.com/gladiusjs/gladius-core/wiki/Roadmap) for more details.<b> | ||
|
||
# Getting Started | ||
|
||
Start by cloning the repository or downloading a zipped version from github. | ||
Inside the project directory you'll find: | ||
|
||
* gladius-core: the engine core; you'll definitely need to load this | ||
* gladius-cubicvr: CubicVR rendering backend | ||
|
||
We're working on more modules to add support for user input, 2d and 3d physics, and additional 2d and 3d backends. | ||
|
||
You can load these modules using requirejs: | ||
|
||
````javascript | ||
var Gladius = require( "gladius-core" ); | ||
var engine = new Gladius(); | ||
```` | ||
|
||
## Using a script tag | ||
|
||
You can load Gladius using a script tag: | ||
|
||
````javascript | ||
<scipt src="gladius-core.js"></script> | ||
<script> | ||
var engine = new Gladius(); | ||
</script> | ||
```` | ||
|
||
If you load Gladius with a script tag you'll find a global engine constructor named Gladius. | ||
Loading extensions this way will add them as properties on the global Gladius object. | ||
For example: | ||
|
||
````javascript | ||
<scipt src="gladius-core.js"></script> | ||
<scipt src="gladius-cubicvr.js"></script> | ||
<script> | ||
Gladius; // global engine constructor | ||
Gladius["gladius-cubicvr"]; // gladius-cubicvr extension you loaded | ||
</script> | ||
```` | ||
|
||
## Examples | ||
|
||
Check out the `examples` in the top-level project directory. | ||
|
||
# Contributing | ||
|
||
This repository contains only the compiled modules that you need to start using Gladius. | ||
If you're interested in contributing to the core or other modules, you can find project repositories here: | ||
|
||
* [gladius-core](https://github.com/gladiusjs/gladius-core) | ||
* [gladius-cubicvr](https://github.com/gladiusjs/gladius-cubicvr) | ||
* [gladius-box2d](https://github.com/gladiusjs/gladius-box2d) | ||
* [gladius-input](https://github.com/gladiusjs/gladius-input) | ||
|
||
# License and Notes | ||
|
||
See [LICENSE](https://github.com/gladiusjs/gladius-core/blob/develop/LICENSE) for more information. | ||
|
||
All our logos are handmade by [Sean Martell](https://twitter.com/#!/mart3ll). |