ReadMe.md

Bonx monster

An awesome game to enjoy in your spare time!
Explore the docs »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Usage
5. License
6. Contact

About The Project

Bonx Monster is a game where you collect and own monsters. The objective is to gather all the monsters and raise them to the highest level. To achieve this, you can have them battle against bosses, explore dungeons, or purchase monster cards in the store.

(back to top)

Built With

This section highlights several major tools used in building our project. For a comprehensive list, please refer to the requirements.txt file.

• 
• 
• 
• 
• 
• 

(back to top)

Getting Started

To get a local copy up and running follow these simple steps.

Prerequisites

Install a recent version of Python (3.9 or higher) and pip.

Installation

Follow the steps below to set up a local copy of the project and get it running on your local machine.

1. Clone the repo

   git clone https://github.com/antonin-lfv/Bonx_monsters.git

2. Add the right permissions to the scripts

   chmod +x install_requirements.sh
   chmod +x start_bonx_monster.sh
   chmod +x reset_data.sh
   chmod +x update_bonx_app.sh

3. Install requirements and dependencies

   ./install_requirements.sh

If you're using Linux, consider using sudo apt install gunicorn to install gunicorn.

(back to top)

Usage

1. To start the game, run the following command:

   ./start_bonx_monster.sh

(use Ctrl + C to stop the server)

2. To reset the data, run the following command:

   ./reset_data.sh

This will delete all the data in the database (users, monsters, cards, etc.)

3. To update the game, run the following command:

   ./update_bonx_app.sh

(back to top)

Roadmap

• Add Changelog
• Add sorting system during monster selection in battle

(back to top)

License

Distributed under the GNU General Public License v3.0. See LICENSE.txt for more information.

(back to top)

Contact

Antonin - [email protected]

(back to top)