Search packages, repositories and app categories

GitHub repositoryistornz/flutter_gaimon

flutter_gaimon

A Flutter plugin to fully support Haptic feedback with custom pattern 📳

flutter_gaimon project cover
Stars
42
Forks
11
Last push (UTC)
Aug 30, 2026
Project status
Active

Original README

English project snapshot. Visit GitHub for the latest content.


🧐 What is it ?

Gaimon is a very simple & easy to use plugin to include Haptic feedback in your app. It support custom pattern with .ahap file support.

👻 Getting started

  • Import the plugin.
import 'package:gaimon/gaimon.dart';
  • Trigger haptic 📳.
Gaimon.selection();
Gaimon.success();
Gaimon.error();
// [...]

Quite simple right ? 😎

📘 Documentation

Name Description Android iOS
.canSupportsHaptic() Check if haptic are supported or not ✅ ✅
.selection() Use it on a tap event ✅ ✅
.error() Use it when an error occur ✅ ✅
.success() Use it when a successful event occur ✅ ✅
.warning() Use it when a warning event occur ✅ ✅
.heavy() Huge feedback ✅ ✅
.medium() Medium feedback ✅ ✅
.light() Light feedback ✅ ✅
.rigid() A huge but speed feedback ✅ ✅
.soft() A medium but speed feedback ✅ ✅
.pattern(String data) Read a custom .ahap file (you can use Captain AHAP to generate file) ✅ ✅

❓ FAQ

  • Why custom pattern is not working on my iPhone?

    Custom vibration patterns is only supported on iPhone 8 and newer devices.

🎯 Roadmap

  • [x] Support pattern for Android (send .ahap file & convert it to waveform).
    • [x] Parse .ahab json contents
    • [x] Convert events in pattern to waveform
    • [x] Send waveform to android native plugin to simulate waveform
    • [x] Add support for parameters (https://developer.apple.com/documentation/corehaptics/representing-haptic-patterns-in-ahap-files)
    • [x] Add support for Parameter curves
    • [ ] Add support for AttackTime
    • [ ] Add support for DecayTime
    • [ ] Add support for Sustained Events
  • [ ] Support audio file to haptic feedback (generate correct feedback for audio file).

👥 Contributions

Contributions are welcome. Contribute by creating a PR or create an issue 🎉.

Dimitri Dessus GitHub avatar
GitHub author

Dimitri Dessus ↗

Mobile and web developer 👨‍💻

LanguagesDartKotlinSwiftRubyObjective-C

Categories

Dependencies used

Dependency list 3 items

  • flutter{"sdk":"flutter"}
  • flutter_testDevelopment{"sdk":"flutter"}
  • flutter_lintsDevelopment^6.0.0

How do I choose a repository?

Start with your use case, compare repository activity, and check the original project before adopting it.

  1. Search by repository name, owner or description, then narrow the results by topic.
  2. Compare stars, forks and recent pushes. Stars show community interest, not a guarantee of quality.
  3. Read the README, license and issues on GitHub before using a project.

Sources and maintenance

“A repository is the most basic element of GitHub.”

GitHub Docs — About repositories ↗