https://github.com/vladikoff/cubeslam-mirror

🔲 Unofficial mirror of the cubeslam project at https://code.google.com/p/cubeslam/
https://github.com/vladikoff/cubeslam-mirror

Last synced: 14 days ago
JSON representation

🔲 Unofficial mirror of the cubeslam project at https://code.google.com/p/cubeslam/

• Host: GitHub
• URL: https://github.com/vladikoff/cubeslam-mirror
• Owner: vladikoff
• Created: 2013-06-14T06:16:14.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2013-06-14T06:21:47.000Z (over 11 years ago)
• Last Synced: 2024-10-19T00:23:13.327Z (3 months ago)
• Homepage:
• Size: 68.9 MB
• Stars: 32
• Watchers: 5
• Forks: 14
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
Cube Slam

=========

Cube Slam is a WebRTC Chrome Experiment that you can play face-to-face against your friends.

## Building

  **Requirements:**

  * python (2.7.2 tested)

  * node (0.8.x tested)

  * make (GNU Make 3.81 tested, should come with xcode dev tools on mac)

  Building is done using a `Makefile` which in turn uses `npm` and `component` for packages and `jade` and `stylus` for templating.

  But to get started all you have to do it make sure `python` and `node` is installed and then:

    $ make

  While developing I'd recommend using [watch](http://github.com/visionmedia/watch) so you don't have to keep running that command manually. The Makefile is set up to only run whenever something changes.

## Testing

  **Requirements:**

  * Go App Engine (`brew install go-app-engine-64`)

  To get it up and running on a local machine the app engine dev server must be up and running. Start it with:

    $ dev_appserver.py .

## Deploying

  To deploy you must first be added to the app engine user list. Then it's simply a matter of using `make`:

    $ make deploy-webrtcgame

  Where the `webrtcgame` part depends on the app you want to deploy to. See the Makefile for available options.

### Versioned deploys

  Right now it will automatically increment the version number on each deploy. Simply because it will be easier to refer to a version while doing QA.

  If you want to deploy to a specific version (like to version 1 which will be the default) you add `v=` like this:

    $ make deploy-webrtcgame v=1

  The version can be anything that can be a subdomain such as "hello-there-123". Which would be accessible at http://hello-there-123.webrtcgame.appspot.com/.

## Query string shortcuts

Add these to the URL querystring to toggle some flags.

### Network

  * `buffer` - should the rtc signal buffer candidates before sending them

  * `signal` - set to `ws` to use the WebSocket signal for rtc

### Multiplayer

  * `autonav` - automatically press buttons to get to the game (use https:// to go all the way without accepting camera more than once)

  * `render` - set to `sync` to render the sync game in a 2d renderer window

  * `ai` - turns on the AI for the opponent (not very useful)

  * `verify` - stores hashes and the states for verification. set to a number (ms) to start an interval which sends them over the network. or use `.`-key to do it manually.

### Singleplayer

  * `play` - go directly to a game against Bob

### Game play

  * `quality` - webgl rendering quality. possible values are `best`, `high`, `low`, `mobile`

  * `god` - no player can die

  * `momentum` - set to `off` to turn off paddle momentum

  * `round` - set to a number to start at that particular round

  * `extras` - set to a comma separated list of extras to override the level extras.

  * `framerate` - set to a number to set the games framerate

  * `speed` - set to a number to set the games unit speed. which all speeds are based upon.

  * `ns` - the namespace of levels. can be either `single`, `mobile` or `multi`.

  * `level` - the level to play. can be any number but there's up to 11 scripted levels. after that it'll be randomized.

### Localization

  * `lang` - set to a locale like `en` or `sv` to override the browser locale

### Debug

  * `dev` - enables the settings gui

  * `see` - set to a path to start at (see `lib/app.js` for available paths)

  * `mobile` - force mobile

  * `paused` - start game in paused mode. step forward a frame using `.`-key.

  * `silent` - don't load in sounds

  * `dmaf` - turn on dmaf logs