README

Stickers

A sticker manager for Flarum with native support for animated Lottie JSON and Telegram TGS stickers, in addition to PNG, GIF, WebP, APNG and JPEG. Stickers are organized in categories and inserted into posts through a floating composer picker.

Features

• Sticker manager — Upload, edit, organize and delete stickers from the admin panel.
• Categories — Group stickers under named categories with a draggable display order.
• Animated stickers — Native rendering of Lottie JSON (.json) and Telegram TGS (.tgs, gzip-compressed Lottie) via lottie-web canvas renderer.
• Static images — PNG, GIF, WebP, APNG and JPEG supported alongside animations.
• Composer picker — A floating sticker picker is added to the post editor toolbar; click a sticker to insert it.
• Text replacement codes — Each sticker has a token (e.g. :smile:) that is rewritten inline when a post is rendered.
• Bulk upload — Drop multiple files at once in the admin panel.
• Import / Export ZIP — Export the full sticker library (files + metadata) as a portable archive and re-import it elsewhere. Duplicate codes are skipped automatically.
• Hover-only animations — Optional admin setting to keep animations paused on the first frame and play only on hover.
• Tooltips — Optional sticker-name tooltip on hover in posts.

Requirements

• Flarum ^1.8.10 || ^2.0

Installation

composer require ramon/stickers
php flarum migrate
php flarum assets:publish
php flarum cache:clear

Then enable Stickers under the Extensions page in the admin panel.

Updating

composer update ramon/stickers --with-dependencies
php flarum migrate
php flarum assets:publish
php flarum cache:clear

Configuration

All settings are available in the admin panel under the Stickers extension:

Import & Export

Use the Export ZIP button in the admin page to export all stickers (files + metadata) as a portable archive. Use Import to restore from a ZIP, or to import metadata-only from a JSON file. Stickers whose replacement code already exists are skipped — no duplicates.

API Endpoints

TGS Files — License & Copyright Notice

This extension supports TGS files (Telegram animated stickers) as a technical format. Support for the format does not grant any rights over the content inside it. Telegram sticker packs are creative works owned by their respective authors. Before uploading a TGS file to your forum, ensure that you are the original author, have explicit permission to redistribute it, or that the sticker is released under a license that permits redistribution. The forum administrator is solely responsible for ensuring that all uploaded content complies with applicable copyright laws and the terms of service of the original platform.

Links

• GitHub
• Issues
• Donate

Authors

• Ramon Guilherme

License

MIT