Skip to content

Home

Jump to bottom Edit New page
lzbk edited this page Jan 21, 2013 · 45 revisions

Welcome to the BrowserQuest wiki!

For Users and SysAdmins

BrowserQuest Maps

For Developers

General info

  • Backlog - Our ToDo list (new ideas welcome, discussion via the mailing list).
  • Coding Conventions - The coding standards we intend to use. Open to (sane) discussion. :)
  • Useful links - Possibly helpful external links.

How-Tos

A series of short descriptions of how to extend the game. They cannot replace the rest of the documentation, but might get you going a bit faster… These guides are probably not exhaustive and should probably be extended

Overview

Classes

Client

  • App - Property and method list done, with some good initial method descriptions.
  • Bubble - Property and method list done, with good method descriptions.
  • BubbleManager - Property and method list done, with good method descriptions.
  • Game - Stub only, needs work.
  • Storage - Initial property and method list done, some methods have descriptions.

Server

  • Server - Initial property and method list done, needs more in-depth method info added.
  • Connection - Basic property and method list, needs work.
  • Player - Stub only, needs work.
  • area.js-(server) - Complete
  • character.js-(server) - Complete except for two methods. forEachAttacker() and regen() need to be filled in and two others (attack and health) need to be checked for accuracy.
  • entity.js-(server) - Complete, spawn() and despawn() could probably use more clarification.

Note - Communication between the client and server happens via gameclient.js (client side) which talks to gameserver.js (server side) using the messages and entity types defined in shared/gametypes.js.

Undocumented source code files

(turning any of these into class docs, like those above, is encouraged)

Client (Javascript)

Server (Node.js)

Add a custom footer
Add a custom sidebar
Clone this wiki locally