# gamer

> Turn-based game server

Latest version **0.0.1** (published 2015-09-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install gamer
pnpm add gamer
yarn add gamer
bun add gamer
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.1 |
| Published | 2015-09-23 |
| First published | 2015-09-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 (+7 in 2 direct dependencies) |
| Install scripts | no |
| Author | dev@sorokin.io |
| Maintainers | asynxis |
| Keywords | node, game, server, turn, based, socket, websockets, socket.io |

## Links

- npm: https://www.npmjs.com/package/gamer
- Repository: https://github.com/asynxis/gamer
- Homepage: https://github.com/asynxis/gamer#readme
- Issues: https://github.com/asynxis/gamer/issues
- npm.io page: https://npm.io/package/gamer

## Dependencies (8)

- [util](https://npm.io/package/util.md) ^0.10.3
- [debug](https://npm.io/package/debug.md) ^2.2.0
- [eslint](https://npm.io/package/eslint.md) ^1.4.3
- [lodash](https://npm.io/package/lodash.md) ^3.10.1
- [bluebird](https://npm.io/package/bluebird.md) ^2.9.34
- [node-uuid](https://npm.io/package/node-uuid.md) ^1.4.3
- [socket.io](https://npm.io/package/socket.io.md) ^1.3.6
- [socketio-jwt](https://npm.io/package/socketio-jwt.md) ^4.3.1

## Alternatives

- [@opentelemetry/exporter-zipkin](https://npm.io/package/@opentelemetry/exporter-zipkin.md) — 14.8M weekly downloads
- [pusher-js](https://npm.io/package/pusher-js.md) — 2.0M weekly downloads
- [browserify](https://npm.io/package/browserify.md) — 1.7M weekly downloads
- [sqs-consumer](https://npm.io/package/sqs-consumer.md) — 1.7M weekly downloads
- [@sanity/eventsource](https://npm.io/package/@sanity/eventsource.md) — 930.8K weekly downloads

## Recent versions

- 0.0.1 (latest) — 2015-09-23

## README

[![Circle CI](https://img.shields.io/circleci/project/asynxis/turny/master.svg?style=flat-square)](https://circleci.com/gh/asynxis/turny/tree/master)
[![Coverage Status](https://img.shields.io/coveralls/asynxis/turny.svg?style=flat-square)](https://coveralls.io/github/asynxis/turny?branch=master)

# TurnyJS
TurnyJS - tiny NodeJS game server based on [Socket.IO](https://github.com/socketio/socket.io/).
## Features
+ Game with 1 to N players or AI.
+ Authentication.
+ **WebSockets** or **Long-Polling** for transferring data.
+ Public and private game-rooms.
+ **Turn-base behavior**, when players do turns one-by-one, like Tic-Tak-Toe, Age of Empires, Civilization ,etc.
+ **Realtime behavior**, when each player can do independent turns. Like Dota2, LoL, etc.

## Workflow

1. Game server is initiated.
2. Client connects to the server. If the client want to create new game - step 3, if find already created or join - step 4.
3. Create new game:
  1. Public
    1. Client send `'client:create-public-room'` to the server.
    2. Client receive `'room:created'` with id in payload.
  2. Private
    1. Client send `'client:create-private-room'` to the server.
    2. Client receive `'room:created'` with id in payload.
4. Find already created game or join:
  1. Public
    1. Client send `'client:find-public-room'` to the server.
    2. Client receive `'room:found'` with id in payload or `'room:not-found'`.
  2. Private
    1. Client send `'client:join-private-room'` to the server.
    2. Client receive `'room:joined'` with id in payload or `'room:not-found'`.
5. When players number in game are equal to needed - all the client receive `'game:ready'`.
6. Now every client need send `'client:ready'` or `'client:not-ready'` to the server.
7. If some clients are not ready - move to step 2.
7. When all the clients are ready, server execute `inititalAction` action and after send `'game:initial-state'` to all the clients with the result as payload.
8. Send every second to the clients `'game:will-start-in'` with countdown as payload. It use `countdown` parameter as base and decrease it every second.
9. When countdown value is **zero** - the server sends `'game:started'` to all the clients.
10. After game is started, clients available to send `'client:turn'` to the server. Payload of this message will be passed to `'turnAction'` method.
11. After `'turnAction'` is done, `'syncAction'` is fired. In `'syncAction'` determine what the data  will be send with `'game:update-state'` message as payload.
12. Sending to all the clients `'game:update-state'` with result of `'syncAction'` method.
13. After it - `'gameOverAction'` will be fired. If the game is over - method fires callback with data, which will be passed to `'game:over'` message later.
13. Client receive `'game:update-state'` and update current game state.
14. Steps 10-13 is repeating until `'gameOverAction'` keep not firing callback.
15. When the game is over clients receive `'game:over'` message with information to show the game results, which was build in `'gameOverAction'` before.
16. After it, players still connected and game state on the server is identically to step 5. If rematch is take the place - client need to do step 6 and replay game again.

## Installation
`npm install turny --save`
## Examples
+ [Tic-Tak-Toe](https://github.com/asynxis/turny-examples/tree/master/barley-break), using React for Client.
+ [Barley-Breck](https://github.com/asynxis/turny-examples/tree/master/tic-tac-toe), using React for Client.

## API

here will be described API...

## License

[MIT](https://github.com/asynxis/turny/blob/master/LICENSE)

---
_Source: https://npm.io/package/gamer · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._