Skip to content

Home

Jump to bottom Edit New page
dylenbrivera edited this page Sep 25, 2012 · 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.

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) - Properties and methods filled in, need details added for each method.
  • 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.

Layout/Image Editing for the BrowserQuest Client

Layout Editing

Want to change the way BrowserQuest looks? Some tips/advice for editing images within BrowserQuest. Some images have 3 copies, each with their own sizes. These images will be in /client/img/[3,2,1] When editing them, start with the largest image first which will be in /client/img/3/. After your edits are complete, resize and export for the images that belong in directories 2 and 1. Doing it backwards and resizing from a small to a large file will make things look horrible. For an example, look at the tilesheet specs below.

Tilesheet

  • /client/img/3/tilesheet.png - 960 x 4704 Pixels - Large Image of Tilesheet in Directory 3
  • /client/img/2/tilesheet.png - 640 x 3136 Pixels - Medium Image of Tilesheet in Directory 2
  • /client/img/1/tilesheet.png - 320 x 1568 Pixels - Small Image of Tilesheet in Directory 1

Questions about the above Layout and Image Editing Information?

Layout and Map Editing Information added by dylenbrivera [Dylen Rivera [email protected]]

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