Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sdumetz/maya
Maya Project
https://github.com/sdumetz/maya
Last synced: about 1 month ago
JSON representation
Maya Project
- Host: GitHub
- URL: https://github.com/sdumetz/maya
- Owner: sdumetz
- License: gpl-2.0
- Created: 2015-03-13T23:52:01.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2015-05-20T20:33:49.000Z (over 9 years ago)
- Last Synced: 2024-10-12T19:46:58.008Z (2 months ago)
- Language: JavaScript
- Size: 5.84 MB
- Stars: 1
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Maya
Maya is a city builder aiming to have a strong population simulation.
##ES6
Maya relies quiete heavily on cutting-edge ES6 spec. See [es6.md](es6.md)
## Roadmap
- Merge Canvas Branch
- Decide if we use creatjs for canvas management
- Make a simple REST API with basic query
- Make a simple grid display
- Add back drag & click support
- Extend REST API for data POST to server
-
## Docker
This app is containerized.
To create the image, run :
docker build -t maya ./
To run the app, run :
docker run -p 8080:8080 maya
(or daemonize with the -d option)
Data synchronization from src dir to container :
docker run -p 8080:8080 -v :/src maya
Other usefull commands :
docker run -v :/src maya npm test
docker run maya npm install
App is then available on port 8080
## Data model
### Basic
basic model is an array of tiles represented by :
- **Required (valid and not null)**
- content (string hash)
- x (int)
- y (int)
## Network
Networking is mainly event-based
### Routes
#### GET /
Get game client
### Events
**Events are sent using the [socket.io](http://socket.io) library**
They can be categorized as server-sent events or client-sent events
#### subscribe (client)
Subscribe on a chunk of data modifications
#### unsubscribe (client)
Unsubscribe from a chunck
#### update (server)
notify clients of an array of updated tiles.