Skip to content
This repository has been archived by the owner on Jun 7, 2024. It is now read-only.

Commit

Permalink
Merge branch 'docs/update-readme' into docs/revole-conflict-readme
Browse files Browse the repository at this point in the history
  • Loading branch information
l0u1sg authored Dec 19, 2022
2 parents 22548aa + dad8a6b commit c3e29cf
Showing 1 changed file with 30 additions and 15 deletions.
45 changes: 30 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,31 @@
# BASKET GO!

Basket Go ! est un jeu tournant sous la bibliothèque **Pygame**, comme son nom l'indique l'univers de ce jeu vidéo est tourner vers le basketball, comportant **trois catégories :**
(Solo / 1vs1 'tour par tour' / Niveaux) Dont le but est de s'amusez en se challengeant à **marquez le plus de panier possible** dans un **temps imparti (45sec)**, le jeu étant composée d'une **boutique** et de sa propre **monnaie (Go ticket)** vous la gagnerait à chaque fin de partie selon le score obtenue.
A vous de Jouez !
## Aspect Graphique
[Charte Graphique](https://user-images.githubusercontent.com/97946104/206729155-c77702b8-d29a-4dad-ace3-678474b561ec.png)
...
...

## Hierarchie code
```mermaid
graph LR
A[main.py] --> B((button))
A --> C((game))
# Basket Go !

Basket Go! is a basketball game made in Python for the "NSI Trophies" contest of the year 2023

## The project

The goal of the project is to create a basketball game in Python. This game is made with PyGame. It is planned that the game will have an online leaderboard, a local multiplayer mode

## How to download

You can download the project through the releases page on GitHub. If no release is available (which would probably be the case at the beginning), you have to manually clone the project and build it

## How to build from source

To build the project from the source, you need to clone the project and install the necessary Python packages.

```bash
git clone https://github.com/Basket-GO/basket-go.git
cd basket-go
pip install -r requirements.txt
```

Then, you can run the game with the following command

```bash
python main.py
```

## How to play

To play, you have take the ball and score a basket. An Angry Birds-like indication allows you to preview the ball's trajectory.

0 comments on commit c3e29cf

Please sign in to comment.