Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deeper explanation on the README #3

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ This repo provides the server for a distributed treasure hunt game using erlang
It was originally used for Inaka's Erlang Dojo 2015, but it can hopefully be used by anyone :)

## Instructions

### Booting up the Server
To run the server just clone the repo and start the app in shell:

```bash
Expand All @@ -16,6 +18,10 @@ make && make shell

Then let the players connect to it by giving them your node name and cookie (as a bonus you can give them a *clue* to get the cookie instead).

### The Players
For the players the story begins when they boot up an erlang node and connect to the server. At that time, they'll receive the first clue that will let them move along. Once they deciphered that clue they'll have to perform another action that will lead them to the next clue, and so on so far until they eventually find the treasure.
The actual story depends on the server configuration. With [generic.config](config/generic.config) it's set up somewhere in the far west and a well known burglar has escaped with a treasure in his hands. It's the player's task to find him and retrieve the treasure to its rightful owner.

## Configuration
The different game stages are configured by application environment. To help you with that a [sys.config.template](config/sys.config.template) is provided, along with the configuration we used at [inaka](config/inaka.config) and the [generic](config/generic.config) one that's used by default.
If you want to start the server using your own config, just do:
Expand Down
2 changes: 2 additions & 0 deletions config/generic.config
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,8 @@
{gold_fever,
[ {step1, #{ cookie => 'erlang-dojo-2015'
, message => "Welcome to the far west, fellow!"
"\nA very well-known thief has robbed us and escaped"
"\nYou have to find that treasure"
"\nNow spawn 'larry' and listen to me."
"\nI have something for you..."
}}
Expand Down