https://github.com/royalgarter/mafia
https://github.com/royalgarter/mafia
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/royalgarter/mafia
- Owner: royalgarter
- License: apache-2.0
- Created: 2020-10-01T16:34:17.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-08T13:43:28.000Z (over 4 years ago)
- Last Synced: 2025-01-04T03:10:48.623Z (5 months ago)
- Language: JavaScript
- Size: 72.3 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Codename-Mafia
Create your desired mafia games! This module is made just for this! Make your own completely automated mafia game. Flexible and easy to use.
## Setup / Usage
To install the module, do `npm i mafia`
And then require it any of your JS files like so:
`const Mafia = require("mafia")`
[If you're not sure how to use this module, read the starting out guide. (I highly recommend it!)](https://googlefeud.github.io/guides/started/)
## Features
- Fully object-oriented.
- Full support for a mafia game. You don't need any other packages to get a game running.
- Fully automated game loop.
- Custom roles, role behavior and role stats.
- Custom player stats and behavior.
- Custom game loop events.
- Easily customizable.
- Typings
## Useful Links
- [Website](https://googlefeud.github.io/)
- [Documentation](https://googlefeud.github.io/lib/ActionManager/)
- [Example Game / Playground](https://github.com/GoogleFeud/Mafia-Example-Game)
- [Guides](https://googlefeud.github.io/guides/notation/)
- [Changelog](https://googlefeud.github.io/other/Changelog/)
- [Github](https://github.com/GoogleFeud/Codename-Mafia)
## Issues
If you spot an issue / bug with the module, [please submit an issue](https://github.com/GoogleFeud/Codename-Mafia/issues) to the module's repository.
If you have anymore questions or you need help you can visit our [discord server](https://discord.gg/gaA5ktE)
## What's new?
The complete changelog can be found [here](https://googlefeud.github.io/other/Changelog/).