nightfury

nightfury

Puzzle based game server

Development

$ git clone https://github.com/boothgames/nightfury.git
$ cd nightfury
$ make build
$ ./out/nightfury server

specify --log-level debug for priting more detailed logging

Setup

Games

There is support for web and non-web games. The web games are assumed to be embedded in the browser, so it is easy to determine if the level has been solved. For the non-web games, some external factor is needed to determine whether the game is completed; currently we load all the random codes possible.

To load data:

Create a json file with the game info as save it as games.json

[
  {
    "name": "smile",
    "title": "Why so serious?",
    "instruction": "Let's put a smile on that face!",
    "type": "web",
    "mode": "embedded"
  },
  {
    "name": "snakes",
    "title": "Snakes",
    "instruction": "Help the snake to eat the right food",
    "type": "web",
    "mode": "embedded"
  },
  {
    "name": "seeker",
    "title": "Seek the diamonds",
    "instruction": "Ask volunter for a tablet/phone, collect all the diamonds within 60 seconds. Tilt the device in appropriate direction for movement. Beware of the consequences :)",
    "type": "mobile",
    "mode": "external",
    "metadata": {
      "codes": ["1234", "5678", "0987"]
    }
  }
]

Upload the games to nightfury

$ curl -H "Content-Type: application/json" --data @games.json http://localhost:5624/v1/bulk/games

Hints

After completing each level, a hint is shown to the user.

To load data:

Create a json file with the hints and save it as hints.json

[
  {
    "title": "hint title",
    "tag": ["tag-1", "tag-2"],
    "content": "hint content",
    "takeaway": "hint takeaway"
  }
]

Upload the hints to nightfury

$ curl -H "Content-Type: application/json" --data @hints.json http://localhost:5624/v1/bulk/hints

Clear data

The data is stored in an embedded key/value database boltdb. To clear the previously loaded data, delete the nightfury.db file.

Contributions

nightfury is an open source project under the Apache 2.0 license, and contributions are gladly welcomed! To submit your changes please open a pull request.