Board Game Builder
Project description
BoardGameBuilder
!!! Project now is in very early stage. Dont use it in any apps :)
Object-oriented framework for build board game logic in python
pip install bgameb
Short example
from typing import Optional
from dataclasses import dataclass
from bgameb import (
Game, Player, Steps, Step, Deck, Card, Shaker, Dice,
Bag, log_enable
)
log_enable()
# create the game
G = Game('one board game')
# add player
G.add(Player('Player'))
# The players object is in attribute p, items -> i, tools -> t.
# Names are converted to snake case
player = G.c.player
# add game tuns order
G.add(Steps('Steps'))
G.c.steps.add(Step('step0'))
G.c.steps.add(Step('step1', priority=1))
# start new turn
current_steps = G.c.steps.deal()
# Game_steps is a priority queue, linked with priority attribute
last = G.c.steps.pull()
# add deck object and cards
G.add(Deck('Deck'))
G.c.deck.add(
Card('First', description='story', count=3)
)
G.c.deck.add(Card('Second', count=1))
# Specific arguments is stored to dict attribute `other`
description = G.c.deck.c.first.other['description']
# If you need more clear schema, inherite from any class
@dataclass(repr=False)
class MyCard(Card):
description: Optional[str] = None
some_text: Optional[str] = 'some texts'
def __post_init__(self) -> None:
super().__post_init__()
G.c.deck.add(
MyCard('Thierd', description='story', count=12)
)
# Use default counters of cards
G.c.deck.c.first.counter['yellow'] = 12
G.c.deck.c.second.counter['banana'] = 0
# Deal and shuffle deck
G.c.deck.deal().shuffle()
# You can add additional attributes directly, but
# this attributes can not added to the schema
G.IS_ACTIVE = True
# Add shaker and dices
G.add(Shaker('blue shaker'))
G.c.blue_shaker.add(
Dice('dice#8', info='some important', sides=8, count=10)
)
# and roll dices
result = G.c.blue_shaker.c.dice_8.roll()
# Use bag as collection of any items
G.add(Bag('Bag'))
G.c.bag.add(Dice('dice'))
G.c.bag.add(Card('card'))
# get the schema
schema = G.to_json()
# components and technical attrs not added to shcema.
# You can reconstruct this, if you need
import json
game = G.to_dict()
game['players'] = [val.to_dict() for val in G.get_players().values()]
game['decks'] = [
val.to_dict() for val
in G.get_tools().values()
if isinstance(val, Deck)
]
game['cards'] = [
val.to_dict() for val
in G.c.deck.c.values()
if isinstance(val, MyCard)
]
schema = json.dumps(game)
Documentation
Development
how install project for development.
Available cli
make proj-doc
make test
to check simple scenario use python tests/check.py
make test-pypi
to test deploy to testpypi
make log
- insert fragmet name to store new about project
make ipython
run interactive terminal
make check
check flake8 and mypy
Available fragmet naming:
- .feature: Signifying a new feature.
- .bugfix: Signifying a bug fix.
- .doc: Signifying a documentation improvement.
- .removal: Signifying a deprecation or removal of public API.
- .misc: A ticket has been closed, but it is not of interest to users.
make draft
- to check changelog output before release.
make release
- to bump version, build changelog, commit, push tags and changes.
* for version management are used incremental and towncrier for changelog * project based on dataclasses-json
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.