README

Quizzes and knowledge tests for your community. Write a quiz once, play it on its own page or right inside a discussion, and reward the members who pass it.

Features

Four kinds of question: one right answer, several right answers, true or false, and typed answers (matched without fussing over case, accents, spacing or surrounding punctuation). Any question can carry an image and an explanation.
Marked on the server. The answer key never reaches a player's browser before the attempt is marked, so it can't be read from the page or the network tab.
Timed quizzes with a countdown. The server keeps the time: a late submission is refused, and an attempt left running is marked on what was saved before the deadline.
Pass marks, attempt limits and opening and closing dates. Draw a set number of questions at random from a bigger pool, shuffle the questions and the answers, and give part marks for "several answers" questions if you want.
You choose what players see afterwards: the score only, which questions were right, or the right answers. The right answers can wait until a member has passed or used up their attempts, so they can't be copied into the next try.
Leaderboards for each quiz and across all quizzes. Members can keep themselves off every leaderboard from their settings.
Quizzes inside posts. Put a quiz's link on a line of its own, or use the composer's Quiz button, and the post shows the quiz itself, ready to play. This works with Markdown, BBCode, Scribe and FoF Rich Text.
Rewards: a FoF Badges badge and FoF Gamification points for passing a quiz the first time. FoF Badges also gets two triggers: quizzes passed and quizzes finished with 100%.
Onramp: a "pass N quizzes" step for the Onramp onboarding checklist.
Results for authors: every finished attempt, how often each question is answered correctly, and a reset for any member's attempts.
Practice runs: authors and moderators can try any quiz, drafts included. Those runs never appear on leaderboards and never earn rewards.
A widget showing the top quiz takers or the newest quizzes, for Bespoke, FoF Forum Widgets and Page Builder.
Translatable throughout, works in light and dark mode, and adds about 4 KB (gzipped) to the JavaScript every page loads. Everything else loads only on the pages that use it.

Screenshots

Playing, against the clock	The marked attempt

A quiz inside a post	The editor

How each question went	On a phone

_{The Eiffel Tower photo in the screenshots is by Benh LIEU SONG, CC BY-SA 3.0, via Wikimedia Commons.}

Installation

composer require ernestdefoe/brainstorm

Then enable Brainstorm in the admin panel.

Updating

composer update ernestdefoe/brainstorm
php flarum migrate
php flarum cache:clear

Permissions

Permission	Default
View quizzes	Everyone, guests included
Take quizzes	Members
Write quizzes	Moderators
Edit and delete any quiz, see every result	Moderators
Attach points and badges to quizzes	Admins

Rewards have their own permission so that a quiz's author can't pay themselves for passing a quiz they wrote.

Points

FoF Gamification recounts a member's points from their votes, so points granted by another extension need its point-grants feature. Until your FoF Gamification version has it, the points field stays hidden; badges work either way.

ernestdefoe / brainstorm

Package info

Security

Fund package maintenance!

Statistics