Download the PHP package shebaoting/flarum-avatar without Composer
On this page you can find all versions of the php package shebaoting/flarum-avatar. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download shebaoting/flarum-avatar
More information about shebaoting/flarum-avatar
Files in shebaoting/flarum-avatar
Package flarum-avatar
Short Description Reddit-style avatar editor for Flarum.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package flarum-avatar
Flarum Avatar
中文说明
Flarum Avatar is a Reddit-style avatar builder for Flarum 2. It replaces the default avatar upload flow with a layered SVG editor where users can style a full character, preview every item on the base avatar, pick outfits, tune colors, choose a background, and display the finished avatar in forum UI.
The editor is designed for communities that want a playful identity system instead of simple uploaded profile pictures. It keeps the experience inside Flarum, uses the active forum language, and stores each user's selections as structured avatar decoration data.
Screenshots
Features
- Reddit-style avatar editor page at
/avatar/edit. - Layered SVG rendering with correct ordering for body, head, eyes, hair, accessories, left hand, right hand, and outfit parts.
- Replacement-mode support for core body parts such as head, eyes, upper body, and lower body.
- Outfit support with grouped SVG parts and preview images.
- Item cards preview each asset on the default avatar, without showing file names or titles.
- Color controls for body, hair, eyes, and avatar background.
- Built-in solid, gradient, radial, conic, and striped background presets.
- Decorated avatars are shown in forum UI with a portrait crop so the character is readable at small sizes.
- Default Flarum avatar upload/remove UI is hidden while the extension is enabled.
- Clicking the user avatar in settings or on the user's profile opens the avatar editor.
- English and Simplified Chinese locale files are included.
Requirements
- Flarum
^2.0.0-beta - PHP
^8.3 - Composer
- Node.js and Yarn only when rebuilding frontend assets
Installation
Install the extension with Composer:
For local development in this repository, the package can be loaded through a Composer path repository from the Flarum app:
Then require the package from the Flarum root:
Usage
After enabling the extension, users edit their avatar by clicking their avatar in:
/settings- their own user profile header
The editor opens at:
The default avatar upload and remove controls are intentionally hidden so the decoration editor becomes the only avatar-management entry point.
Asset Structure
Avatar assets are bundled in:
The extension scans tab folders such as:
Normal tabs contain SVG files or item folders. The Outfits tab supports section folders, and every outfit item can be a folder containing multiple child SVG parts plus a preview image such as:
The default avatar is rendered from layered SVG files under:
This layered base allows items to replace or overlay specific body parts instead of simply stacking everything on top.
Frontend Development
When changing forum or admin JavaScript, rebuild the bundled assets:
Then publish Flarum assets:
Localization
The extension includes:
Flarum automatically selects the matching language according to the forum's current locale.
License
MIT
Community & Contact
Community: https://wyz.xyz
Email: [email protected]
Available for custom Flarum extension development and general software development projects.
