Intro

Please be warned - this game has only be shown to work in chrome (windows) / chromium (linux). Sorry for the inconvenience.

Welcome to the Settler's of Catan C S 340 class project. This page contains links to the important files you'll want to be aware about. It links to 1) documentation and 2) pages used to join and play games.

Doc Pages

We give you a lot of documentation. This server provides documenation for it self and the javascript files we give you. They are both automatically generated. Drop us a line if the documentation is ambiguous. We'll try and update to avoid rough patches.

Java

Java docs

This page contains the documentation on the Java files we give you. You can use 'ant make-java-doc to update the documentation, including any documentation you've written in your files!

Javascript

Javascript docs

This page contains the documentation on the javascript files we give you. We decided to go with YUIdoc because their parser looks inside javascript closures. In order to run it, you'll need to have node.js and npm installed, and then install YUIdoc with something along the lines of "node install -g yuidocjs". After that you can use 'ant make-js-doc to update the documentation, including any documentation you've written in your files!

Server API

Interactive Server API

We documented the server using the swagger specification. It allows you to try out the commands we've documented. We've documented them all, you'll only have to worry about using the ones under '/game' and '/moves' in your javascript. You'll need to implement them all on your server though.

Game Pages

Here is a list of pages we give you to make the game work. The 'login' and 'join game' pages are completely implemented for you. We provide the 'setup' and 'catan' pages, but you'll have to modify them to include the javascript files you write.

They are all located in the gameplay folder of the files we give you.