https://github.com/returnstring/metagame
extensible online game backend
https://github.com/returnstring/metagame
Last synced: 8 months ago
JSON representation
extensible online game backend
- Host: GitHub
- URL: https://github.com/returnstring/metagame
- Owner: returnString
- License: mit
- Created: 2015-11-30T21:01:33.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-11-23T10:35:52.000Z (about 9 years ago)
- Last Synced: 2025-04-22T14:18:41.099Z (10 months ago)
- Language: JavaScript
- Homepage:
- Size: 148 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# metagame
Extensible online game backend. Moderately modern with ES6. Highly WIP.
# Short version
metagame will take care of your...
- user profiles and inventories
- in-game shop
- matchmaking
- custom platform integration
- annoying in-house PHP 'backend' from three projects ago
It uses websockets and JSON, and so should be easily usable from most languages.
It also includes SSL support if you don't feel like setting up SSL termination.
# Clients
- [Unity](https://github.com/returnString/metagame.unity)
# Documentation
## Protocol
- [Requests and responses](https://github.com/returnString/metagame/wiki/Protocol)
## Stock services
- [Using the authentication service](https://github.com/returnString/metagame/wiki/Authentication-service)
- [Using the state service](https://github.com/returnString/metagame/wiki/State-service)
## Extension
- [Creating a custom service](https://github.com/returnString/metagame/wiki/Custom-services)
- [Creating a custom platform](https://github.com/returnString/metagame/wiki/Custom-platforms)
# Planned features
See the [issue tracker](https://github.com/returnString/metagame/labels/feature).
# Installation
## Linux build status
[](https://travis-ci.org/returnString/metagame)
## Windows build status
[](https://ci.appveyor.com/project/returnString/metagame/branch/master)
Officially, the following Node versions are tested on Linux and Windows:
- 5.x (0-4)
Unofficially, it's primarily developed on OSX, but CI doesn't cover that.
## Install from npm
```
npm install metagame --save
```
```javascript
const MetagameServer = require('metagame')
const config = require('config')
const co = require('co')
const server = new MetagameServer(config)
co(function*()
{
yield server.init()
}).catch(err => console.error(err.stack))
```
## Install from source
```
git clone https://github.com/returnString/metagame
cd metagame
npm install
npm test
node metagame /path/to/my/config
```
## Dependencies
- mongodb
- redis (not yet used in stock services)