README.md

Borre

Borre is a dead simple Farkle 🎲 dice game implementation and game maker made using Python at it's glory 🐍

Game rules are simple, you usually have five dices with six sides, you roll the set of dices, and check if you score bonus or regular standard points.

Requirements

This package supports the following minimum versions:

• Python >= 3.7

If you have Python installed, just skip to Usage, otherwise install Python.

Earlier versions may still work, but we encourage people building new applications to upgrade to the current stable.

Usage

First, you will need to install the borre package localy

pip install borre

To quickly start, with a simple Dice

import borre

dice = borre.Dice()

# Rolls the dice once
print(dice.roll())

Or create a multiple players

import borre

bob = borre.Player("Bob")
alice = borre.Player("Alice")

# Bob plays with 6 Dices
bob.play(borre.Dice(), 6)

# Alice plays with only 2 Dices
alice.play(borre.Dice(), 2)

If you have any difficulties, you might as well check the examples in examples folder.

Getting help

If you have a question about the library, or are having difficulty using it, chat with the community in GitHub Discussions..

Contributing

Everyone is welcome to make this package better feel free to submit your pull request/feature request.