Metadata-Version: 2.1
Name: quantumwerewolf
Version: 3.2.2
Summary: Quantum version of the werewolves party game.
License: MIT License
        
        Copyright (c) 2022 Jesse Straat
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/ProodjePindakaas/Quantum-Werewolf
Project-URL: Bug Tracker, https://github.com/ProodjePindakaas/Quantum-Werewolf/issues
Keywords: quantum,werewolf,werewolves,game
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE

# Quantum Werewolf

Quantum Werewolf is a game based on the party game "The Werewolves of Millers Hollow" (known as "Weerwolven van Wakkerdam" to Dutch audiences) with a quantum mechanical twist: Players play all possible games of werewolf at the same time.

Original puzzle:
https://web.archive.org/web/20080719133809/http://puzzle.cisra.com.au/D-5-Schroedingers-Wolves.pdf

Solution and original explanation:
https://web.archive.org/web/20181116123708/https://puzzle.cisra.com.au/2008/quantumwerewolf.html

## Installation

`$ pip install quantumwerewolf`

## Usage

Start the game in a terminal by running the `quantumwerewolf` command.

## About

### What is "The Werewolves of Millers Hollow"?

The Werewolves of Millers Hollow is a classical party game where each player (save the game master) gets a secret role card assigned to them. There are two teams: the werewolves
and the village (consisting of all roles except the werewolves). At night, each player secretly takes an action corresponding to their role -- the seer gets to see another player's card,
Cupid can make two players fall in love, and the werewolves vote on who they will eat that night. During the day, all players vote on another player to be lynched.
The village's goal is to kill all werewolves, and the werewolves' goal is to kill all non-werewolves. When only one faction is left, they win.

### What is the quantum twist?

The quantum twist introduced in Quantum Werewolf is a superposition of roles. This means that every player is every role at once, and gets to take actions corresponding to all roles at night.
Of course, the superposition can be collapsed by measurements. Currently, there are two ways of measuring the superposition:

1. A player uses his Seer action to look at someone else's role, partially collapsing the superposition (and introducing entanglement!);
2. A player dies, which reveals his role to all players, collapsing the superposition quite a bit.

Since there is no way of knowing the final gamestate (in fact, your actions influence what the final measurement will be), it is important to players to "crack" the permutations
and try to make the superposition collapse in their favour. The game is very complex, and honestly isn't much fun to play with your grandma. However, it can be used as an
education tool for superpositions, or as a way to pit physicists against each other in cracking the code.

## What are the rules?

### Game setup

When you start a game of quantum werewolf, you are prompted to enter the names of all participating players first.
After entering and confirming the list of players, you are presented with the standard role selection of 2 werewolves and the seer.
You may refuse this role selection and choose the amount of werewolves as well as the additional roles.

A game of quantum werewolf needs at least 1 werewolf, optional roles are:

 * Seer: Inspects the identity of a player each night, revealing their role to the seer.
 * Cupid: Chooses two players to fall in love during the first night. Whenever one of the lovers dies, the other dies as well. The lovers win if they are the only 2 players left, regardless of role.
 * Hunter: Whenever the hunter dies, they may choose to kill another player.

You should also decide on the rules to follow during the day phase.

### Night phase

During the night all special roles get to take their specific actions. In quantum werewolf all players will take all their actions in turns.
In your turn you must specify how you would act as each role. You are only promted for actions corresponding to roles for which you have a non-zero probability to be.

### Day phase

At the start of the day phase all players that have died during the night will be revealed, as will their roles.
After the reveal, the players are presented with the current state of the game in which all players and their chances of being each role is tabulated.
All players in the table are anomymous except for dead players. The order of the players is random, but fixed throughout the game.

All players that are still alive must now discuss whoever they will lynch.
This discussion is separate from the interface of the game.
You should decide beforehand on the format of this discussion and how the lynch target will be decided.
