ernestdefoe / club
Book and watch clubs for Marquee titles: a monthly pick, a reading or watching schedule, spoiler-gated replies per section and a progress bar for every member.
Fund package maintenance!
Requires
- php: ^8.3
- ernestdefoe/marquee: ^1.6
- flarum/core: ^2.0
Requires (Dev)
- flarum/phpstan: ^2.0
- flarum/testing: ^2.0
Suggests
None
Provides
None
Conflicts
None
Replaces
None
README
A Flarum 2 companion to Marquee for book clubs and watch clubs. A club picks a title each month, splits it into a schedule ("chapters 1–5 by the 10th", "episodes 1–3 this week"), and discusses it section by section, with every reply about a section hidden from members who haven't finished it yet. Each member ticks off sections as they go, and everyone's progress shows beside the discussion.
Features
- Clubs.
/clubs(linked from the forum's sidebar) lists them. Anyone with permission starts one and becomes its host; members join and leave with one click. - A monthly pick from Marquee. A host opens any discussion Marquee links to a title and chooses Make it a club pick from its controls: which club, which month, and the schedule. Even sections over the month fills in a schedule to edit, or build one section by section with names and due dates.
- Spoiler-gated replies. Replying in a pick's discussion asks which section the reply is about (it starts on the one you last finished, or "everything so far"). A reply about a section you haven't finished arrives without its text, with I've finished this section in its place. The text is held back by the server, not hidden in the browser, so it isn't in the page at all. Your own replies are always open to you.
- Progress for everyone. The discussion's sidebar shows the schedule, your own progress bar and every member's. Tick a section off and the replies about it open.
- A page per club, with this month's pick, its schedule and members, and the past picks.
- Translatable. Every word on screen comes from the language files.
Installation
composer require ernestdefoe/club php flarum migrate
Enable Marquee first, then Club.
Permissions
| Permission | Default | What it allows |
|---|---|---|
| Join book and watch clubs | Members | Joining, leaving and tracking progress |
| Start book and watch clubs | Moderators | Starting a club and hosting it |
| Run any club | Moderators | Editing or deleting any club and changing any pick |
A pick is visible to whoever can see its discussion, so a pick in a restricted tag stays restricted.
Good to know
- What is spoiler-gated. Replies in the forum (the discussion, search results, mentions, the no-JavaScript page) for anyone who hasn't finished that section, staff included. Email notifications about new replies are not: someone who follows the discussion by email gets the text.
- Lean on every page. Ordinary discussions cost nothing: only replies that name a section are checked, and a page of them costs two small queries however many there are.
- A club always has a host. Its only host can't leave; they can delete the club, or a moderator can step in.
- Schedules have up to 31 sections.
Updating
composer update ernestdefoe/club php flarum migrate php flarum cache:clear