https://github.com/f/wolves
JavaScript port of lykoss/lykos, a Werewolf party game IRC bot
https://github.com/f/wolves
Last synced: 8 months ago
JSON representation
JavaScript port of lykoss/lykos, a Werewolf party game IRC bot
- Host: GitHub
- URL: https://github.com/f/wolves
- Owner: f
- License: mit
- Created: 2014-07-13T02:27:34.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2014-07-23T23:11:48.000Z (almost 12 years ago)
- Last Synced: 2024-09-14T04:40:39.999Z (almost 2 years ago)
- Language: CoffeeScript
- Size: 766 KB
- Stars: 7
- Watchers: 4
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
IRC based online Wolves (a [Mafia][2] theme) game
[ ](https://travis-ci.org/f/wolves)
[ ](http://badge.fury.io/js/wolves)
[ ](https://david-dm.org/f/wolves#info=dependencies&view=table)
[ ](https://david-dm.org/f/wolves#info=devDependencies&view=table)
***
**THIS PROJECT IS UNDER HEAVY DEVELOPMENT**
***
## Installation
Simply install using NPM.
```bash
npm install -g wolves
```
### Ubuntu
```bash
sudo apt-get install python-software-properties
sudo add-apt-repository ppa:chris-lea/node.js
sudo apt-get update
sudo apt-get install nodejs
npm install -g wolves
```
### Mac OS X
```bash
brew install node
npm install -g wolves
```
### Windows
I really don't know.
## Configuration
You should create the IRC settings file at `config/irc.yml`
```yaml
channel: "#wolfgamechannel"
auth:
username: yourusername
password: password
connection:
host: irc.freenode.net
port: 6667
owners: [user1, user2]
admins: [user1, user2]
```
## Run
Then, you can connect to server and start the game:
```bash
wolves start
```
You can change connection file:
```bash
wolves start --config=config/another-config.yml
```
## The Game
Inspired from [lykoss/lykos][1], a Wolves party game based on IRC Protocol,
From Wikipedia:
> **Mafia** (Russian: Ма́фия, also known as **Wolves**) is a party game created
> in the USSR by Dimitry Davidoff in 1986,[3] modelling a conflict between
> an informed minority (the mafia) and an uninformed majority (the innocents).
> At the start of the game each player is secretly assigned a role affiliated
> with one of these teams. The game has two alternating phases: "night",
> during which the mafia may covertly "murder" an innocent, and "day", in
> which surviving players debate the identities of the mafiosi and vote to
> eliminate a suspect. Play continues until all of the mafia has been
> eliminated, or until the mafia outnumbers the innocents.
## License
MIT: [http://f.mit-license.org](http://f.mit-license.org)
[1]: http://github.com/lykoss/lykos
[2]: http://en.wikipedia.org/wiki/Mafia_(party_game)