Skip to content

A plug-and-play Gamification engine for Mendix apps. Features include XP calculation, automated leveling, and a badge system with a non-intrusive 1-1 User architecture.

License

Notifications You must be signed in to change notification settings

alsharefee/Mendix-Gamification-Module

Repository files navigation

Mendix-Gamification-Module

A plug-and-play Gamification engine for Mendix apps. Features include XP calculation, automated leveling, and a badge system with a non-intrusive User architecture.

A lightweight, scalable Gamification module for Mendix. This module allows developers to quickly integrate user engagement features like Experience Points (XP), Leveling, and Achievements/Badges without modifying their existing User entities.

🚀 Key Features

  • Flexible XP Engine: Logic to handle XP gains and multi-level jumps.
  • Level Configuration: Fully data-driven level requirements (Levels 1-50 included).
  • Badge System: Many-to-Many association architecture for badges and rewards.
  • Ready-to-use UI: Includes snippets for Profile Cards and Leaderboards.
  • Easy Integration: Uses a 1-1 association with System.User to avoid entity inheritance conflicts.
  • Fully Open-Source: With editable microflows and domain models. Easily customize XP logic and level scaling to fit your specific project needs.

🛠 Installation

  1. Download the .mpk file in the Releases section.
  2. Import the module into your Mendix Project.
  3. Map the module security roles (User and Administrator) to your project roles.
  4. Add the ASu_InitializeLevelConfig microflow to your app's After Startup event.

📖 Usage

To reward a user with XP, simply call the SUB_AddXP microflow in your logic:

  • User: The user receiving points.
  • Amount: The number of points to add.
  • Reason: A string describing the action (e.g., "Daily Login").

🤝 Contributing

Contributions, issues, and feature requests are welcome! Feel free to check the issues page.

📄 License

This project is Apache 2.0 licensed.

About

A plug-and-play Gamification engine for Mendix apps. Features include XP calculation, automated leveling, and a badge system with a non-intrusive 1-1 User architecture.

Resources

License

Stars

Watchers

Forks

Packages

No packages published