⚠️ This plugin is under active development. It is not yet published on the Moodle Plugin Directory.

The PlayerGames Block is a thin sidebar widget for the PlayerGames gamification ecosystem. It mirrors a user’s site-wide Player Hub profile — avatar, level, season XP, streak, and rankings — wherever a site administrator adds it, without holding any data or business logic of its own.

Everything the widget shows and does is delegated to local_playergames, which this block depends on directly.

👈 Use the sidebar to jump to any section on this page.

🖼️ Screenshots

Browse with the arrows, the dots, or the left/right keys. Click the image to zoom.

‹

›

The PlayerGames block in the Dashboard drawer: avatar, level, XP bar, today's mini-games and streak — all site-wide data at a glance

1 / 3

✨ Features

• 🦊 Avatar at a glance: shows the equipped avatar; clicking it opens the same avatar-collection modal used by the Player Hub, so equipping there or here stays in sync.
• 📊 Season progress: level, XP and a progress bar toward the next level.
• 🎮 Today’s games: shortcuts to the day’s available mini-games, with done/pending/locked state.
• 🔥 Streak, freezes & check-ins: compact stats with accessible labels.
• 📘 Learning XP (optional): shows the XP mirrored from course activity via block_playerhud, when that bridge and the admin setting are both active — student-only, never mixed with season XP.
• 🏆 Ranking position + one-click opt-in: season and learning ranking positions, each with its own toggle to appear or not — no need to open the full Hub.
• ❓ Built-in help: a short modal explaining the two XP pools, avatars and rankings — the same content shown on every Player Hub page.
• 🕐 Activity history shortcut: a direct link to the full log of XP, streak and freeze events.
• 🔌 Three states, no logic of its own:
  • Normal — active player: avatar, level, XP bar, today’s games, streak and rankings all visible.
  • Paused — the user opted out of gamification, with a link to reactivate directly from the block.
  • Hidden — no active season, or the viewer is excluded by the site’s participant-group setting.

  All three states are computed by local_playergames; the block only picks which template to render.

🕹️ PlayerGames Ecosystem

The PlayerGames Block is a companion to local_playergames, the ecosystem’s central hub. It is designed to complement — not overlap with — block_playerhud:

• PlayerGames Hub (local_playergames): the required dependency — hub page, rankings, missions, avatar catalog, activity log. 👉 github.com/jeanlucio/moodle-local_playergames

• PlayerHUD Block (block_playerhud): per-course gamification block. Its course XP can optionally mirror into this ecosystem’s “Learning XP” pool. 👉 github.com/jeanlucio/moodle-block_playerhud

• AI Hub (local_aihub): shared BYOK broker for AI-assisted cartridge generation in local_playergames. Optional. 👉 github.com/jeanlucio/moodle-local_aihub

📦 Requirements

🛠️ Installation

⚠️ This plugin is not yet published on the Moodle Plugin Directory. Install manually from this repository.

1. Install local_playergames first — this block will not install without it.
2. Download the .zip file or clone this repository.
3. Extract the folder into your Moodle blocks/ directory.
4. Rename the folder to playergames (if necessary). Final path: your-moodle/blocks/playergames/
5. Visit Site administration → Notifications to complete installation.

📖 Usage

For Administrators

1. Turn on editing mode on the site front page or Dashboard.
2. Use “Add a block” → PlayerGames to place the widget.
3. Click the avatar to equip a different one, the ❓ icon for a quick explanation, or the 🕐 icon for the full activity history.

💡 Recommendation: this block is designed for the site front page and the Dashboard, not for individual courses (that role belongs to block_playerhud). For the widget to become visible automatically to everyone:

• Add it to the site front page while editing — the front page is shared by the whole site, so this alone makes it visible to every user with a single action.
• Add it to the default Dashboard page (Site administration → Appearance → Default Dashboard page) so new dashboards start with it. Existing users who already customised their own Dashboard will not get it retroactively unless you also use “Reset Dashboard for all users” — a destructive action that resets everyone’s personal Dashboard layout, so use it deliberately.

For Students

1. The block appears automatically on the site front page and/or the Dashboard once an administrator adds it.
2. Click the avatar thumbnail to open the avatar collection and equip a different one.
3. Click the ❓ icon for a short explanation of XP, avatars and rankings.
4. Click the 🕐 icon to open the full activity history log.
5. Toggle “Show in ranking” directly from the block — no need to visit the full Player Hub.

🧪 Automated Tests

The only business logic that belongs to this plugin — which of the three states to render — is covered by PHPUnit. Everything else is orchestration of local_playergames managers, already tested in that plugin.

PHPUnit — Unit & Integration Tests

Line coverage by class (PHPUnit + Xdebug):

vendor/bin/phpunit --testsuite block_playergames

Behat — Acceptance Tests

php admin/tool/behat/cli/init.php
vendor/bin/behat --tags=@block_playergames --profile=chrome

🔐 Security & Privacy

Access Control

Capability-based access control: block/playergames:view is granted to every authenticated user, since the widget lives on shared, site-wide pages rather than inside a course.

Privacy API

This block implements the null_provider interface — it holds no personal data of its own. All personal data (profile, XP, streak, activity log, avatar) is owned and declared by local_playergames.

Write Operations

All write actions — equipping an avatar, toggling ranking visibility — go through the web services already validated and secured by local_playergames. This block performs no writes of its own.

📄 License

This project is licensed under the GNU General Public License v3 (GPLv3).

Copyright: 2026 Jean Lúcio

Maintained by Jean Lúcio.