Obsidian Stats logoObsidian Stats

Football Playbook

by Adrián Meléndez
5
4
3
2
1
Score: 50/100
Install Code

Description

Obsidian plugin to design American football playbooks: teams, formations and plays drawn with Excalidraw.

Reviews

No reviews yet.

Stats

0
stars
10
downloads
0
forks
3
days
3
days
3
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
4
commits

Latest Version

0.2.0
3 days ago

Changelog

What's new

  • Share playbooks with your team. Export a whole playbook (plays, notes, drawings and formations) as one .playbook.json file, and import it on any device. If the playbook already exists you can replace it or keep both. Imported files are checked, and anything unsafe is skipped.
  • Defense first. Playbooks can be offense only, defense only, or both. Defense plays and formations are drawn from the defense's point of view: defense at the bottom and highlighted, offense faded at the top.
  • Mirror plays and formations to the other side in one click. Left/right wording in names and notes is swapped, e.g. "Trips Right" becomes "Trips Left".
  • Mobile. Larger touch targets, and sharing uses the phone's share sheet when available. PDF export is offered wherever Obsidian supports it.

Existing playbooks keep working. Defense formations created with 0.1.0 still show the defense at the top; delete them and run Restore built-in formations to get the new view.

See all version on GitHub

README file from

Github

Football Playbook

Design and organize American football playbooks in Obsidian. Plays are drawn with the Excalidraw plugin, with the field and players already in place.

Demo: create a playbook, create a play from a formation, draw routes, fill in assignments, browse formations and export to PDF

Watch the full-speed video (MP4)

Features

  • Playbooks per team: 11-man tackle, 9-man tackle or 5v5 flag; offense only, defense only, or both.
  • Defense first: defense plays and formations are drawn from the defense's point of view, with the defense at the bottom and highlighted and the offense faded at the top.
  • New play in one click: pick a formation and get a drawing with the field (yard lines, hashes, yard numbers, line of scrimmage) and every player lined up. Optionally show the opponent's formation faded behind.
  • Formation library: built-in formations for each format, each one a drawing you can open, edit (move players, change labels), rename, duplicate or delete from the Formations section of the panel. You can also turn any play drawing into a formation with Save current drawing as formation. Deleted a built-in by mistake? Run Restore built-in formations.
  • Notes for every play: general notes plus an assignments table with one row per player.
  • Mirror: flip a play or formation to the other side in one click. "Trips Right" becomes "Trips Left", and left/right in the play's notes swap too.
  • Playbook panel: browse plays by side and formation; rename, duplicate, mirror or delete a play (note and drawing together) from its menu.
  • Share with your team: export a whole playbook as one .playbook.json file and import it on any device. No server or account needed.
  • Works on mobile: browse, draw, import and share on phones and tablets (PDF export needs a computer).
  • PDF export: one button exports the team notes and every play, one per page.

Getting started

  1. Install Football Playbook and Excalidraw from Settings → Community plugins. The panel shows an install button if Excalidraw is missing.
  2. Click the clipboard icon in the left ribbon to open the Playbooks panel.
  3. Click New playbook, then New play.

Sharing a playbook

  1. In the Playbooks panel, select the share icon next to the playbook (or Share playbook in its ⋯ menu). On a computer you choose where to save <Team>.playbook.json; on a phone the share sheet opens.
  2. Send the file to your coaches and players: email, chat, shared drive.
  3. They install Football Playbook and Excalidraw, then select the import icon at the top of the panel and pick the file.

Importing a playbook that already exists asks whether to replace it (the old copy goes to the trash) or keep both. The team's formations are added too, without touching formations the person already has. Files are checked before import, and anything unsafe is skipped.

Where things are stored

Everything is plain files in your vault, so it syncs and backs up like any other note:

Playbooks/<Team>/Playbook.md                                team notes + settings (format, defense)
Playbooks/<Team>/Offense/<Formation>/<Play>.md              play notes and assignments
Playbooks/<Team>/Offense/<Formation>/<Play>.excalidraw.md   play drawing
Playbooks/<Team>/Export.md                                  generated by Export PDF
Playbooks/Formations/<Format>/<Offense|Defense>/<Name>.excalidraw.md   formation library

A formation's players are the shapes the plugin drew. To add a player to a formation, copy and paste an existing one; to rename a player, edit the letter inside it.

Development

npm install
npm run dev      # rebuild on change
npm run lint     # Obsidian's review rules
npm test         # check built-in formations
npm run deploy   # build and copy into a test vault (set VAULT=/path/to/vault)

Releasing

  1. npm version patch (or minor/major) updates package.json, manifest.json and versions.json, commits and tags.
  2. git push --follow-tags. The GitHub workflow builds and creates a draft release with main.js, manifest.json and styles.css.
  3. Publish the draft release on GitHub.

First release only: sign in at community.obsidian.md, link your GitHub account and add the plugin to the community directory. It reads manifest.json from the default branch and installs files from the matching release. See Submit your plugin.

Sponsors