# hackbox-server

> A Jackbox inspired framework for creating party games - server component

Latest version **0.0.3** (published 2019-05-30) · MIT license · 0 weekly downloads

## Install

```sh
npm install hackbox-server
pnpm add hackbox-server
yarn add hackbox-server
bun add hackbox-server
```

## 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.3 |
| Published | 2019-05-30 |
| First published | 2019-05-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 8.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 88 |
| Author | tomalama |
| Maintainers | tomalama |
| Keywords | realtime, framework, websocket, events, socket, server, jackbox, party, games |

## Links

- npm: https://www.npmjs.com/package/hackbox-server
- Repository: https://github.com/tomalama/hackbox/tree/master/packages/hackbox-server
- npm.io page: https://npm.io/package/hackbox-server

## Dependencies (1)

- [socket.io](https://npm.io/package/socket.io.md) ^2.2.0

## 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.3 (latest) — 2019-05-30
- 0.0.2 — 2019-05-24
- 0.0.1 — 2019-05-23

## README

# `hackbox-server`

A Jackbox inspired framework for creating party games - server component.

## Usage

```javascript
const hackbox = require("hackbox-server");
```

### Using Express

```javascript
const express = require("express");
const path = require("path");
const hackbox = require("hackbox-server");
const gameReference = require("./gameReference");

const port = process.env.PORT || 8080;
const app = express();
app.use(express.static("build"));

app.get("/", function(req, res) {
  res.sendFile(path.join("build", "index.html"));
});

hackbox({ app, port }, gameReference);
```

### Game Reference

```javascript
module.exports = {
  gameTypes: ["demo"],
  demo: {
    gameLength: 60000,
    validActionIds: [0, 1],
    description: `This is the description of the game. You have 60 seconds to compete`
  },
  actions: {
    0: { actionName: "action1" },
    1: { actionName: "action2" }
  }
};
```

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