m4v3rick4git/flarum-lineup

Create football lineups for Austrian Bundesliga matches and post them as images in Flarum.

Maintainers

Package info

github.com/m4v3rick4git/flarum-lineup

Type:flarum-extension

pkg:composer/m4v3rick4git/flarum-lineup

Transparency log

Statistics

Installs: 0

Dependents: 0

Suggesters: 0

Stars: 0

Open Issues: 0

Security

Advisories: 0

Aikido package health analysis

v0.1.0 2026-08-04 22:09 UTC

Requires

Requires (Dev)

MIT 64e80f55a806b44f24c8fbe134ed573926ef96da

  • m4v3rick <wirsansoizburg.woop@gmail.com>

flarum

Published on Packagist.org on 2026-08-04 22:17 UTC

This package is auto-updated.

Last update: 2026-08-05 22:15:21 UTC

README

License Latest Stable Version Total Downloads

A Flarum extension for creating football lineups and inserting them as generated images into posts.

The first release is designed for the Austrian Bundesliga and obtains team and squad data from API-Football.

Features

  • Synchronize teams and current squads from API-Football
  • Select eleven players from one team
  • Choose from several common formations
  • Generate a PNG lineup image
  • Insert the generated image directly into the Flarum composer
  • Control access through a dedicated Flarum permission
  • Store the API-Football key encrypted in the Flarum database
  • German and English translations

Requirements

  • Flarum 1.2 or newer within the 1.x release series
  • PHP GD extension with FreeType support
  • PHP Sodium extension
  • allow_url_fopen enabled
  • DejaVu Sans fonts at:
/usr/share/fonts/truetype/dejavu/DejaVuSans.ttf
/usr/share/fonts/truetype/dejavu/DejaVuSans-Bold.ttf

The PHP process must be able to write to Flarum's public/assets directory.

An API-Football account and API key are required for synchronizing team and player data.

Installation

Install the extension with Composer from the Flarum root directory:

composer require m4v3rick4git/flarum-lineup:^0.1
php flarum migrate
php flarum cache:clear

Enable Flarum Lineup in the Flarum administration panel.

Encryption key

The extension requires the following environment variable:

WSS_LINEUP_ENCRYPTION_KEY

Its value must contain exactly 64 hexadecimal characters, representing a random 32-byte key.

Generate a suitable key with PHP:

php -r 'echo bin2hex(random_bytes(32)), PHP_EOL;'

Add the generated value to the environment used by both the Flarum web process and CLI processes.

Example:

WSS_LINEUP_ENCRYPTION_KEY=replace_with_your_64_character_hexadecimal_key

Keep this key secret, stable and backed up. Changing or losing it prevents the extension from decrypting an API key that was already stored.

Configuration

Open the extension settings in the Flarum administration panel and:

  1. Enter and save the API-Football API key.
  2. Test the API connection.
  3. Enter the API-Football league ID.
  4. Enter the season.
  5. Synchronize the teams.
  6. Synchronize the squads.
  7. Grant the Create football lineups permission to the desired user groups.

Team and squad synchronization is currently started manually from the extension settings.

Generated images

Generated PNG files are stored in:

public/assets/wss-lineup/

The directory is created automatically when the first image is generated, provided that the PHP process has write access to public/assets.

Player photos and team logos are downloaded over HTTPS while the lineup image is generated. Failed image downloads are replaced with a fallback representation.

Updating

composer update m4v3rick4git/flarum-lineup
php flarum migrate
php flarum cache:clear

Security

The API-Football key is encrypted before it is stored in the Flarum settings table. The encryption key itself is not stored in the database and must be supplied through WSS_LINEUP_ENCRYPTION_KEY.

Do not commit API keys or the encryption key to the repository.

Links

License

Released under the MIT License.