Favorite Team

A Flarum 2.x extension that lets members pick a favorite

FBS (NCAA Division I-A) college-football team. The team's logo is displayed

under the member's avatar on posts and on their profile.

Features

• Team picker — a searchable grid of all 136 FBS teams (logo + name) in the

  member's account settings.

• Avatar badge — the chosen team's logo appears under the avatar on posts

  (in the post's side column) and on the profile / user card.

• Require at registration (optional) — an admin toggle that forces new

  members to pick a team before they can use the forum. It shows a

  non-dismissible picker on the next page load for any logged-in member who

  hasn't chosen yet (works with normal, social, and SSO sign-ups).

• No database migration — the choice is stored in the member's existing

  preferences, so it loads with the user row (no extra query when rendering the

  badge across a page of posts).

• Logos via the ESPN CDN — no images are bundled or hosted by the extension.

Installation

php flarum cache:clear```

Then enable **Favorite Team** in the admin panel under Extensions.

## Usage

### For members

Go to **Settings** → **Favorite Team** → **Choose your team**, search or scroll

the grid, pick a team, and save. The logo then shows under your avatar.

### For admins

Open the **Favorite Team** extension page in the admin panel and toggle

**Require members to pick a team** to force the choice at registration. It's off

by default.

## How it works

* The FBS team list is bundled as static reference data in

  `resources/teams.json` (id, name, abbreviation, color,

  and ESPN logo URL per team).
* The chosen team id is stored in the member's `preferences`

  (`ernestdefoe-favorite-team.team`).
* The core `UserResource` is extended with two fields:
  * `favoriteTeamId` — writable by the member themselves (or an admin), validated

    against the bundled team list.
  * `favoriteTeam` — a read-only resolved object (`id`, `name`, `logo`, …) used to

    render the badge; readable by everyone.
* `GET /api/fbs-teams` returns the full team list for the picker.

## API

| Method | Endpoint | Notes |

|---|---|---|

| `GET` | `/api/fbs-teams` | Full FBS team list (registered users). |

| `PATCH` | `/api/users/{id}` | Set `favoriteTeamId` (self or admin). |

## Configuration

| Admin setting | Default | Effect |

|---|---|---|

| Require members to pick a team | off | Blocks members without a team until they choose. |

## Notes

Team names and logos are the property of their respective institutions and are

served from ESPN's public logo CDN. This is an unofficial fan tool and is not

affiliated with or endorsed by the NCAA, ESPN, or any team.

## License

MIT

# Favorite Team

A [Flarum](https://flarum.org) 2.x extension that lets members pick a favorite

FBS (NCAA Division I-A) college-football team. The team's logo is displayed

under the member's avatar on posts and on their profile.

## Features

* **Team picker** — a searchable grid of all 136 FBS teams (logo + name) in the

  member's account settings.
* **Avatar badge** — the chosen team's logo appears under the avatar on posts

  (in the post's side column) and on the profile / user card.
* **Require at registration (optional)** — an admin toggle that forces new

  members to pick a team before they can use the forum. It shows a

  non-dismissible picker on the next page load for any logged-in member who

  hasn't chosen yet (works with normal, social, and SSO sign-ups).
* **No database migration** — the choice is stored in the member's existing

  preferences, so it loads with the user row (no extra query when rendering the

  badge across a page of posts).
* **Logos via the ESPN CDN** — no images are bundled or hosted by the extension.

## Installation

```composer require ernestdefoe/favorite-team
php flarum cache:clear```

Then enable **Favorite Team** in the admin panel under Extensions.

## Usage

### For members

Go to **Settings** → **Favorite Team** → **Choose your team**, search or scroll

the grid, pick a team, and save. The logo then shows under your avatar.

### For admins

Open the **Favorite Team** extension page in the admin panel and toggle

**Require members to pick a team** to force the choice at registration. It's off

by default.

## How it works

* The FBS team list is bundled as static reference data in

  `resources/teams.json` (id, name, abbreviation, color,

  and ESPN logo URL per team).
* The chosen team id is stored in the member's `preferences`

  (`ernestdefoe-favorite-team.team`).
* The core `UserResource` is extended with two fields:
  * `favoriteTeamId` — writable by the member themselves (or an admin), validated

    against the bundled team list.
  * `favoriteTeam` — a read-only resolved object (`id`, `name`, `logo`, …) used to

    render the badge; readable by everyone.
* `GET /api/fbs-teams` returns the full team list for the picker.

## API

| Method | Endpoint | Notes |

|---|---|---|

| `GET` | `/api/fbs-teams` | Full FBS team list (registered users). |

| `PATCH` | `/api/users/{id}` | Set `favoriteTeamId` (self or admin). |

## Configuration

| Admin setting | Default | Effect |

|---|---|---|

| Require members to pick a team | off | Blocks members without a team until they choose. |

## Notes

Team names and logos are the property of their respective institutions and are

served from ESPN's public logo CDN. This is an unofficial fan tool and is not

affiliated with or endorsed by the NCAA, ESPN, or any team.

## License

MIT

favorite-team 2.0.1

What's Changed

• Add author email to composer.json
• ci: add support-site release announcer (publish-to-flarum)

Full Changelog: https://github.com/ernestdefoe/favorite-team/compare/2.0.0...2.0.1

View release on GitHub

favorite-team 2.0.2

Hardening release from a code audit.

Changes

• Server-side enforcement of the "require a favorite team" setting: members without a team are now blocked from starting discussions and replying (previously only nudged by the modal). Reading and choosing a team stay open.
• Visible feedback in the team picker: an error alert if a save fails (your selection is kept for retry) and a "Team saved!" confirmation on success.
• The profile-card logo badge now attaches via the supported profileItems hook instead of mutating core's render tree — more robust across Flarum updates.
• TeamRepository is bound as a container singleton, so the bundled team list is parsed at most once per request.

No database or settings migrations; safe to update.

View release on GitHub

favorite-team 2.0.3

Changes

• The favorite-team logo badge now overlays the avatar's bottom-left corner on posts (like a group badge), instead of sitting below the avatar.
• Hovering the badge shows the team name as a tooltip.

Visual/UX only — no migrations.

View release on GitHub

favorite-team 2.0.4

Audit hardening: PHP constraint bumped to ^8.3 (Flarum 2.x minimum) and the bundled team list is read via the Laravel File facade.

View release on GitHub

favorite-team 2.0.5

Fixed

• Enabling the extension no longer 500s the forum on Flarum 2. TeamRepository read its bundled teams.json via the Laravel File facade, which isn't reliably bound in Flarum's container — so it threw "A facade root has not been set" while the user API document was built, taking down the forum frontend the moment the extension was enabled (Flarum's error handler masked it, so logs only showed the facade error). It now reads the file with plain file_exists()/file_get_contents(). Regression introduced in 2.0.4.

View release on GitHub