Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cjmellor/level-up
Level-Up is a Laravel package introducing gamification into your applications. Users earn experience points (XP) and levels through interactions, while also unlocking achievements. It promotes engagement, competition, and fun through its dynamic leaderboard feature. Customisable to fit your specific needs
https://github.com/cjmellor/level-up
achievements engagment experience gamification laravel leaderboard levelling
Last synced: 1 day ago
JSON representation
Level-Up is a Laravel package introducing gamification into your applications. Users earn experience points (XP) and levels through interactions, while also unlocking achievements. It promotes engagement, competition, and fun through its dynamic leaderboard feature. Customisable to fit your specific needs
- Host: GitHub
- URL: https://github.com/cjmellor/level-up
- Owner: cjmellor
- License: mit
- Created: 2023-04-03T18:45:43.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-24T11:43:49.000Z (3 months ago)
- Last Synced: 2024-10-25T06:37:39.356Z (3 months ago)
- Topics: achievements, engagment, experience, gamification, laravel, leaderboard, levelling
- Language: PHP
- Homepage:
- Size: 229 KB
- Stars: 551
- Watchers: 5
- Forks: 40
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://packagist.org/packages/cjmellor/level-up)
[](https://github.com/cjmellor/level-up/actions?query=workflow%3Arun-tests+branch%3Amain)
[](https://packagist.org/packages/cjmellor/level-up)
?style=for-the-badge&logo=laravel)
This package allows users to gain experience points (XP) and progress through levels by performing actions on your site. It can provide a simple way to track user progress and implement gamification elements into your application
# Installation
You can install the package via composer:
```
composer require cjmellor/level-up
```
You can publish and run the migrations with:
```
php artisan vendor:publish --tag="level-up-migrations"
php artisan migrate
```
You can publish the config file with:
```
php artisan vendor:publish --tag="level-up-config"
```
This is the contents of the published config file:
```php
return [
/*
|--------------------------------------------------------------------------
| User Foreign Key
|--------------------------------------------------------------------------
|
| This value is the foreign key that will be used to relate the Experience model to the User model.
|
*/
'user' => [
'foreign_key' => 'user_id',
'model' => App\Models\User::class,
],
/*
|--------------------------------------------------------------------------
| Experience Table
|--------------------------------------------------------------------------
|
| This value is the name of the table that will be used to store experience data.
|
*/
'table' => 'experiences',
/*
|-----------------------------------------------------------------------
| Starting Level
|-----------------------------------------------------------------------
|
| The level that a User starts with.
|
*/
'starting_level' => 1,
/*
|-----------------------------------------------------------------------
| Multiplier Paths
|-----------------------------------------------------------------------
|
| Set the path and namespace for the Multiplier classes.
|
*/
'multiplier' => [
'enabled' => env(key: 'MULTIPLIER_ENABLED', default: true),
'path' => env(key: 'MULTIPLIER_PATH', default: app_path(path: 'Multipliers')),
'namespace' => env(key: 'MULTIPLIER_NAMESPACE', default: 'App\\Multipliers\\'),
],
/*
|-----------------------------------------------------------------------
| Level Cap
|-----------------------------------------------------------------------
|
| Set the maximum level a User can reach.
|
*/
'level_cap' => [
'enabled' => env(key: 'LEVEL_CAP_ENABLED', default: true),
'level' => env(key: 'LEVEL_CAP', default: 100),
'points_continue' => env(key: 'LEVEL_CAP_POINTS_CONTINUE', default: true),
],
/*
| -------------------------------------------------------------------------
| Audit
| -------------------------------------------------------------------------
|
| Set the audit configuration.
|
*/
'audit' => [
'enabled' => env(key: 'AUDIT_POINTS', default: false),
],
/*
| -------------------------------------------------------------------------
| Record streak history
| -------------------------------------------------------------------------
|
| Set the streak history configuration.
|
*/
'archive_streak_history' => [
'enabled' => env(key: 'ARCHIVE_STREAK_HISTORY_ENABLED', default: true),
],
/*
| -------------------------------------------------------------------------
| Default Streak Freeze Time
| -------------------------------------------------------------------------
|
| Set the default time in days that a streak will be frozen for.
|
*/
'freeze_duration' => env(key: 'STREAK_FREEZE_DURATION', default: 1),
];
```
# Usage
## šÆĀ Experience Points (XP)
Add the `GiveExperience` trait to your `User` model.
```php
use LevelUp\Experience\Concerns\GiveExperience;
class User extends Model
{
use GiveExperience;
// ...
}
```
**Give XP points to a User**
```php
$user->addPoints(10);
```
A new record will be added to the `experiences` table which stores the Usersā points. If a record already exists, it will be updated instead. All new records will be given a `level_id` of `1`.
> [!NOTE]
> If you didn't set up your Level structure yet, a default Level of `1` will be added to get you started.
**Deduct XP points from a User**
```php
$user->deductPoints(10);
```
**Set XP points to a User**
For an event where you just want to directly add a certain number of points to a User. Points can only be ***set*** if the User has an Experience Model.
```php
$user->setPoints(10);
```
**Retrieve a Usersā points**
```php
$user->getPoints();
```
### Multipliers
Point multipliers can be used to modify the experience point value of an event by a certain multiplier, such as doubling or tripling the point value. This can be useful for implementing temporary events or promotions that offer bonus points.
To get started, you can use an Artisan command to crease a new Multiplier.
```bash
php artisan level-up:multiplier IsMonthDecember
```
This will create a file at `app\Multipliers\IsMonthDecember.php`.
Here is how the class looks:
```php
month === 12;
}
public function setMultiplier(): int
{
return 2;
}
}
```
Multipliers are enabled by default, but you can change the `$enabled` variable to `false` so that it wonāt even run.
The `qualifies` method is where you put your logic to check against and multiply if the result is true.
This can be as simple as checking that the month is December.
```php
public function qualifies(array $data): bool
{
return now()->month === 12;
}
```
Or passing extra data along to check against. This is a bit more complex.
You can pass extra data along when you're adding points to a User. Any enabled Multiplier can then use that data to check against.
```php
$user
->withMultiplierData([
'event_id' => 222,
])
->addPoints(10);
//
public function qualifies(array $data): bool
{
return isset($data['event_id']) && $data['event_id'] === 222;
}
```
**Conditional Multipliers**
If you don't want to use the class based method to check conditionals to add multipliers, you can do this inline by giving the method a callback with the conditional. When using this method, make sure you have the multiplier set as an argument in the `addPoints` method, otherwise an error will occur. See example below:
```php
$user
->withMultiplierData(fn () => true)
->addPoints(amount: 10, multiplier: 2);
```
The `setMultiplier` method expects an `int` which is the number it will be multiplied by.
**Multiply Manually**
You can skip this altogether and just multiply the points manually if you desire.
```php
$user->addPoints(
amount: 10,
multiplier: 2
);
```
### Events
**PointsIncrease** - When points are added.
```php
public int $pointsAdded,
public int $totalPoints,
public string $type,
public ?string $reason,
public Model $user,
```
**PointsDecreased** - When points are decreased.
```php
public int $pointsDecreasedBy,
public int $totalPoints,
public ?string $reason,
public Model $user,
```
## ā¬ļøĀ Levelling
> [!NOTE]
> If you add points before setting up your levelling structure, a default Level of `1` will be added to get you started.
### Set up your levelling structure
The package has a handy facade to help you create your levels.
```php
Level::add(
['level' => 1, 'next_level_experience' => null],
['level' => 2, 'next_level_experience' => 100],
['level' => 3, 'next_level_experience' => 250],
);
```
**Level 1** should always be `null` for the `next_level_experience` as it is the default starting point.
As soon as a User gains the correct number of points listed for the next level, they will level-up.
> [!TIP]
> a User gains 50 points, theyāll still be on Level 1, but gets another 50 points, so the User will now move onto Level 2
**See how many points until the next level**
```php
$user->nextLevelAt();
```
**Get the Usersā current Level**
```php
$user->getLevel();
```
### Level Cap
A level cap sets the maximum level that a user can reach. Once a user reaches the level cap, they will not be able to gain any more levels, even if they continue to earn experience points. The level cap is enabled by default and capped to level `100`. These
options can be changed in the packages config file at `config/level-up.php` or by adding them to your `.env` file.
```
LEVEL_CAP_ENABLED=
LEVEL_CAP=
LEVEL_CAP_POINTS_CONTINUE
```
By default, even when a user hits the level cap, they will continue to earn experience points. To freeze this, so points do not increase once the cap is hit, turn on the `points_continue` option in the config file, or set it in the `.env`.
### Events
**UserLevelledUp** - When a User levels-up
```php
public Model $user,
public int $level
```
## šĀ Achievements
This is a feature that allows you to recognise and reward users for completing specific tasks or reaching certain milestones.
You can define your own achievements and criteria for earning them.
Achievements can be static or have progression.
Static meaning the achievement can be earned instantly.
Achievements with progression can be earned in increments, like an achievement can only be obtained once the progress is 100% complete.
### Creating Achievements
There is no built-in methods for creating achievements, there is just an `Achievement` model that you can use as normal:
```php
Achievement::create([
'name' => 'Hit Level 20',
'is_secret' => false,
'description' => 'When a User hits Level 20',
'image' => 'storage/app/achievements/level-20.png',
]);
```
### Gain Achievement
To use Achievements in your User model, you must first add the Trait.
```php
// App\Models\User.php
use LevelUp\Experience\Concerns\HasAchievements;
class User extends Authenticable
{
use HasAchievements;
// ...
}
```
Then you can start using its methods, like to grant a User an Achievement:
```php
$achievement = Achievement::find(1);
$user->grantAchievement($achievement);
```
To retrieve your Achievements:
```php
$user->getUserAchievements();
```
### Revoke Achievement
You can revoke an achievement from a user using the `revokeAchievement` method:
```php
$user->revokeAchievement($achievement);
```
The method will throw an exception if you try to revoke an achievement that the user doesn't have. You can revoke both standard and secret achievements, and it will also remove any associated progress.
When an achievement is revoked, a `AchievementRevoked` event is dispatched.
### Add progress to Achievement
```php
$user->grantAchievement(
achievement: $achievement,
progress: 50 // 50%
);
```
> [!NOTE]
> Achievement progress is capped to 100%
### Check Achievement Progression
Check at what progression your Achievements are at.
```php
$user->achievementsWithProgress()->get();
```
Check Achievements that have a certain amount of progression:
```php
$user->achievementsWithSpecificProgress(25)->get();
```
### Increase Achievement Progression
You can increment the progression of an Achievement up to 100.
```php
$user->incrementAchievementProgress(
achievement: $achievement,
amount: 10
);
```
A `AchievementProgressionIncreased` Event runs on method execution.
### Secret Achievements
Secret achievements are achievements that are hidden from users until they are unlocked.
Secret achievements are made secret when created. If you want to make a non-secret Achievement secret, you can just update the Model.
```php
$achievement->update(['is_secret' => true]);
```
You can retrieve the secret Achievements.
```php
$user->secretAchievements;
```
To view *********all********* Achievements, both secret and non-secret:
```php
$user->allAchievements;
```
### Events
**AchievementAwarded** - When an Achievement is attached to the User
```php
public Achievement $achievement,
public Model $user,
```
> [!NOTE]
> This event only runs if the progress of the Achievement is 100%
**AchievementRevoked** - When an Achievement is detached from the User
```php
public Achievement $achievement,
public Model $user,
```
**AchievementProgressionIncreased** - When a Usersā progression for an Achievement is increased.
```php
public Achievement $achievement,
public Model $user,
public int $amount,
```
## šĀ Leaderboard
The package also includes a leaderboard feature to track and display user rankings based on their experience points.
The Leaderboard comes as a Service.
```php
Leaderboard::generate();
```
This generates a User model along with its Experience and Level data and ordered by the Usersā experience points.
> The Leaderboard is very basic and has room for improvement
>
## šĀ Auditing
You can enable an Auditing feature in the config, which keeps a track each time a User gains points, levels up and what level to.
The `type` and `reason` fields will be populated automatically based on the action taken, but you can overwrite these when adding points to a User
```php
$user->addPoints(
amount: 50,
multiplier: 2,
type: AuditType::Add->value,
reason: "Some reason here",
);
```
> [!NOTE]
> Auditing happens when the `addPoints` and `deductPoints` methods are called. Auditing must be enabled in the config file.
**View a Usersā Audit Experience**
```php
$user->experienceHistory;
```
## š„Ā Streaks
With the Streaks feature, you can track and motivate user engagement by monitoring consecutive daily activities. Whether it's logging in, completing tasks, or any other daily activity, maintaining streaks encourages users to stay active and engaged.
Streaks are controlled in a Trait, so only use the trait if you want to use this feature. Add the Trait to you `User` model
```php
use LevelUp\Experience\Concerns\HasStreaks;
class User extends Model
{
use HasStreaks;
// ...
}
```
### Activities
Use the `Activies` model to add new activities that you want to track. Hereās some examples:
- Logs into a website
- Posts an article
### Record a Streak
```php
$activity = Activity::find(1);
$user->recordStreak($activity);
```
This will increment the streak count for the User on this activity. An `Event is ran on increment.
### Break a Streak
Streaks can be broken, both automatically and manually. This puts the count back to `1` to start again. An Event is ran when a streak is broken.
For example, if your streak has had a successful run of 5 days, but a day is skipped and you run the activity on day 7, the streak will be broken and reset back to `1`. Currently, this happens automatically.
### Reset a Streak
You can reset a streak manually if you desire. If `level-up.archive_streak_history.enabled` is true, the streak history will be recorded.
```php
$activity = Activity::find(1);
$user->resetStreak($activity);
```
### Archive Streak Histories
Streaks are recorded, or āarchivedā by default. When a streak is broken, a record of the streak is recorded. A Model is supplied to use this data.
```php
use LevelUp\Experience\Models\StreakHistory;
StreakHistory::all();
```
### Get Current Streak Count
See the streak count for an activity for a User
```php
$user->getCurrentStreakCount($activity); // 2
```
### Check User Streak Activity
Check if the User has performed a streak for the day
```php
$user->hasStreakToday($activity);
```
### Events
**StreakIncreased** - If an activity happens on a day after the previous day, the streak is increased.
```php
public int $pointsAdded,
public int $totalPoints,
public string $type,
public ?string $reason,
public Model $user,
```
**StreakBroken** - When a streak is broken and the counter is reset.
```php
public Model $user,
public Activity $activity,
public Streak $streak,
```
## š„¶ Streak Freezing
Streaks can be frozen, which means they will not be broken if a day is skipped. This is useful for when you want to allow users to take a break from an activity without losing their streak.
The freeze duration is a configurable option in the config file.
```php
'freeze_duration' => env(key: 'STREAK_FREEZE_DURATION', default: 1),
```
### Freeze a Streak
Fetch the activity you want to freeze and pass it to the `freezeStreak` method. A second parameter can be passed to set the duration of the freeze. The default is `1` day (as set in the config)
A `StreakFrozen` Event is ran when a streak is frozen.
```php
$user->freezeStreak(activity: $activity);
$user->freezeStreak(activity: $activity, days: 5); // freeze for 5 days
```
### Unfreeze a Streak
The opposite of freezing a streak is unfreezing it. This will allow the streak to be broken again.
A `StreakUnfrozen` Event is run when a streak is unfrozen.
```php
$user->unfreezeStreak($activity);
```
### Check if a Streak is Frozen
```php
$user->isStreakFrozen($activity);
```
### Events
**StreakFrozen** - When a streak is frozen.
```php
public int $frozenStreakLength,
public Carbon $frozenUntil,
```
**StreakUnfrozen** - When a streak is unfrozen.
```
No data is sent with this event
```
# Testing
```
composer test
```
# Changelog
Please see [CHANGELOG](notion://www.notion.so/CHANGELOG.md) for more information on what has changed recently.
# License
The MIT Licence (MIT). Please see [Licence File](notion://www.notion.so/LICENSE.md) for more information.