Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/dashed/gojs

A rules engine for a board game called Go
https://github.com/dashed/gojs

board-game coffeescript go javascript

Last synced: 3 months ago
JSON representation

A rules engine for a board game called Go

Awesome Lists containing this project

README

        

gojs
====

Go board game in Javascript.

syntax
======

`var some_var = GoBoard(container_id, length, board_size);`

* `container_id`: an element container with with a unique `id` attribute

* `length`: render the element container into a square of length `length`

* `board_size`: render the go board of grid `board_size` x `board_size`. Must be an integer between `2` and `19`.

usage
=====

1. Place `` in the `head` element, or right before the `body` tag.

2. Place an empty `div` container with a unique `id` attribute. A `div` element is preferred, but other elements such as `p` may be used.

Example:
`

`

**Note:** If the container is not empty, gojs will empty it!

3. Render the go board via

`var go_board = GoBoard("go_board", 500, 19)`

demo
====

[Click here](http://dashed.github.com/gojs/#demo) to view the demo

colophon
========

* All code excluding libraries are written in [coffeescript](http://coffeescript.org/) which compiles into JavaScript.

* [Raphael JS](http://raphaeljs.com/) is primarily used to render the Go board.

* Utility libraries:

* [jQuery](http://jquery.com/)

* [underscore.js](http://underscorejs.org/)

* All JavaScript files are packaged together with [RequireJS](http://requirejs.org/) and its [optimizer](http://requirejs.org/docs/optimization.html), and minified through [UglifyJS2](https://github.com/mishoo/UglifyJS2).

License
=======

MIT License