Skip to content

Project Structure

rtoal edited this page Dec 14, 2011 · 2 revisions

The physical layout of the project is as follows:

.
├── README
├── src
│   ├── main
│   │   ├── app.js (The main file)
│   │   ├── controllers
│   │   │   └── (*-controller.js, Express controllers)
│   │   ├── conf
│   │   │   └── (*-config.js, Server-side configuration)
│   │   ├── package.json
│   │   ├── public (files downloaded to the browser)
│   │   │   ├── assets
│   │   │   │   ├── class_skins
│   │   │   │   │   └── (jpegs and psds of bodies, eyes, and vests for each player class)
│   │   │   │   ├── copperlicht
│   │   │   │   │   └── copperlichtdata
│   │   │   │   │       └── (graphics for zombies, walls, tree, sky, etc.)
│   │   │   │   ├── effects
│   │   │   │   │   └── (tons of special effects images that appear in the 3-D world)
│   │   │   │   ├── fonts
│   │   │   │   │   └── (fonts used by K'tah that most users will not already have)
│   │   │   │   ├── gamestate.json
│   │   │   │   ├── icons
│   │   │   │   │   └── (png files for the icons)
│   │   │   │   ├── jquery-ui-images
│   │   │   │   │   └── (pngs for the icons for jquery-ui widgets)
│   │   │   │   ├── models
│   │   │   │   │   └── (3-D modles for rocks and things)
│   │   │   │   └── site-accents
│   │   │   │       └── (images and other resources for the HTML/CSS webapp portion)
│   │   │   ├── css
│   │   │   │   └── (stylesheets for K'tah and jQuery UI)
│   │   │   └── js
│   │   │       ├── display
│   │   │       │   └── (*-display.js, scripts that run in the browser)
│   │   │       ├── ktah.js (the main module for game resources)
│   │   │       ├── lib
│   │   │       │   └── (third party libs: backbone, copperlicht, jquery, mousewheel, underscore)
│   │   │       ├── modules
│   │   │       │   ├── abilities.js
│   │   │       │   ├── chat
│   │   │       │   │   └── (customizations to node-chat)
│   │   │       │   ├── copperlicht-ui.js
│   │   │       │   ├── db-config.js
│   │   │       │   └── round-mechanics.js
│   │   │       ├── types
│   │   │       │   ├── bipedal.js
│   │   │       │   ├── characters
│   │   │       │   │   ├── architect.js
│   │   │       │   │   ├── character.js
│   │   │       │   │   ├── chemist.js
│   │   │       │   │   ├── herder.js
│   │   │       │   │   ├── pioneer.js
│   │   │       │   │   └── tinkerer.js
│   │   │       │   ├── effects
│   │   │       │   │   ├── effect.js
│   │   │       │   │   ├── pow.js
│   │   │       │   │   └── start.js
│   │   │       │   ├── monsters
│   │   │       │   │   ├── basicZombie.js
│   │   │       │   │   └── monster.js
│   │   │       │   └── resources
│   │   │       │       ├── atomic-waste.js
│   │   │       │       ├── metal.js
│   │   │       │       ├── resource.js
│   │   │       │       ├── sand.js
│   │   │       │       ├── stone.js
│   │   │       │       ├── water.js
│   │   │       │       ├── wood.js
│   │   │       │       └── zombie-flesh.js
│   │   │       └── util
│   │   │           └── include.js
│   │   └── views
│   │       └── (*.jade files for each of the webapp pages and subpages)
│   └── test
│       └── (*.test.js files to run with QUnit or Expresso)
├── screenshots
│   └── (screenshots, documentation)
└── uml
    └── (UML diagrams in both graffle and png formats, for documentation)

Clone this wiki locally