konradmichalik/typo3-letter-avatar

TYPO3 extension, which generates colorful backend user avatars using name initials letter.

1.0.1 2025-05-22 11:29 UTC

Requires

• php: ^8.1
• typo3/cms-core: ^11.0 || ^12.0 || ^13.0

Requires (Dev)

• armin/editorconfig-cli: ^2.0
• bk2k/bootstrap-package: ^15.0
• ergebnis/composer-normalize: ^2.44
• friendsofphp/php-cs-fixer: ^3.52
• helhum/typo3-console: ^8.1
• helmich/typo3-typoscript-lint: ^3.2
• roave/security-advisories: dev-latest
• saschaegerer/phpstan-typo3: ^1.10
• ssch/typo3-rector: ^2.10
• symfony/translation: ^6.3 || ^7.0
• typo3/cms-base-distribution: ^11.0 || ^12.0 || ^13.0
• typo3/cms-lowlevel: ^11.0 || ^12.0 || ^13.0

Suggests

• ext-gd: Image processing library for avatar generation
• ext-gmagick: Image processing library for avatar generation
• ext-imagick: Image processing library for avatar generation

GPL-2.0-or-later

• Konrad Michalik

README

TYPO3 extension typo3_letter_avatar

This TYPO3 extension generates colorful backend user avatars using name initials letter.

✨ Features

• Generates out-of-the-box colorful avatars for backend users
• Easily customizable and flexible configuration
• Provides different predefined color modes and themes
• Supports frontend user avatars with an additional viewhelper

🔥 Installation

Requirements

• TYPO3 >= 11.5
• PHP 8.1+

Composer

composer require konradmichalik/typo3-letter-avatar

TER

Download the zip file from TYPO3 extension repository (TER).

Setup

Set up the extension after the installation:

vendor/bin/typo3 extension:setup --extension=typo3_letter_avatar

The extension will automatically generate avatars for all existing backend users.

🧰 Configuration

See Configuration Documentation for detailed setup instructions including:

• Extension settings configuration
• Custom themes and color modes
• Code-based configuration examples

⚡ Usage

See Usage Documentation for comprehensive usage examples including:

• Backend user avatars (automatic)
• Programmatic avatar generation
• Fluid ViewHelper usage
• Console commands
• Event listener customization

🧑‍💻 Contributing

Please have a look at CONTRIBUTING.md.

💎 Credits

This project is highly inspired by similar open source projects like avatar and letter-avatar.

The fonts used in the extension are licensed under SIL Open Font License and Apache License, Version 2.0.

⭐ License

This project is licensed under GNU General Public License 2.0 (or later).