Top8er

Top8er is a Django app that generates top 8 result graphics for many different fighting games tournaments using Pillow. These graphics include a picture of the player's main character as well as their nicknames and tournament placing. The graphic template parts used were made by EDM. Character portraits are not included in this repository. You can see the app working here.

support the designer on paypal

Table of Contents

• Features
• Usage
  • Previous Requirements
  • Installation Instructions
• Contributing

Features

• Boxes under each player's name for their twitter handle.
• Bottom Left, Top Left and Top Right texts to insert details regarding tournaments or other related information.
• Custom layout and font colors, custom backgrounds.
• Custom Palettes (only Eternal Fighter Zero)
• Support for Japanese and European characters (by changing the font).
• Option to import data from a start.gg, challonge, or tonamel link.

Usage

Previous Requirements

• Python 3.10 with virtualenv installed
• Node.js 14 or higher

Installation Instructions

1. Clone the repository:

   git clone -b master --single-branch [email protected]:ShonTitor/Top8er.git
   cd Top8er

2. Copy the contents of the starter_files directory to the project root:

   cp -rT starter_files/ .

3. Set up a virtual environment and install the required Python packages:

   python -m venv venv
   source venv/bin/activate  # On Windows use `venv\Scripts\activate`
   pip install -r requirements.txt

4. Run the tests to ensure everything is set up correctly:

   python manage.py test

5. Apply the database migrations:

   python manage.py migrate

6. Start the Django development server:

   python manage.py runserver

7. Open your browser and navigate to http://127.0.0.1:8000 to see the app in action.

   

Try out the new frontend (beta)

1. Navigate to the frontend directory and install the required Node packages:

   cd frontend
   npm install

2. Build the frontend assets:

   npm run build

3. Copy the bult assets to the static folder:

   cp -r dist/assets/* ../static/assets

4. With the Django server still running, open your browser and navigate to http://127.0.0.1:8000/beta/template/top1er/game/kf2.

5. Alternatively, you can run the frontend in development mode.

   npm run dev

6. With both servers running, open your browser and navigate to http://localhost:5173/static/beta/template/top1er/game/kf2.

Contributing

If you would like to contribute to this project, please follow the guidelines in the HowToHelp.md file.