Obsidian Drum Notation

Render drum kit patterns as graphical SVG percussion staff notation in Obsidian, with playback.

Try the interactive web playground, or see the full notation format reference.

The playground example picker includes a Rudiments group with ten core exercises covering rolls, paradiddles, flams, drags, and buzz strokes. In these examples, ST identifies the main hand; grace-note hands and the second stroke of compact diddles remain implicit.

Release Notes

• 1.5.0 adds optional split hands/feet engraving with Voicing: split, including synchronized up-stem and down-stem voices and shared rests, plus even diddle timing and smoothly overlapping buzz-roll strokes.
• 1.4.0 adds inherited system-level time-signature and beam-grouping changes, with changed signatures engraved at the start of each affected staff line.
• 1.3.0 adds written-beat-span tuplets such as 2/3(xxx), groups the playground examples by purpose, and adds ten core rudiment exercises.
• 1.2.0 extends tuplets with explicit note-value spans such as 3@8(xxx) for three equal positions in one eighth-note duration.
• 1.1.0 adds explicit one-written-beat tuplets with N(...) syntax, synchronized playback and engraving, text-safe repeat support, and clear advisory warnings for malformed or mismatched tuplet rows.
• 1.0.11 adds count dialogs for % and %xN, group-aware repeat resizing and deletion, conversion to one editable bar, and quieter ghost-note playback.
• 1.0.10 makes Repeat insert a new one-bar repeat after the selected bar, keeps Unrepeat as a non-destructive conversion to editable notation, and refreshes the visual-editor repeat icons and toolbar order.
• 1.0.9 shows inferred rest symbols by default, adds Rests: off for the previous compact style, groups fully silent bars by meter, and adds a playground example for rests and off-beat entries.
• 1.0.8 restores full notehead highlighting during playback and keeps normal bars following measure-repeat notation visible and separately playable.
• 1.0.7 adds explicit Grouping: syntax for beaming asymmetric /8 and /16 meters, plus a 7/8 playground example grouped as 2+2+3.
• 1.0.6 beams regular eighth-note patterns by compound beat in 6/8, 9/8, and 12/8, adds a 9/8 playground example, and includes a small font-registry type-safety cleanup.
• 1.0.5 makes the visual-edit setting searchable through Obsidian 1.13's declarative settings API while preserving the legacy settings tab on older supported Obsidian versions.
• 1.0.4 expands visual bar editing with Duplicate, split-at-selection New line behavior, and a session clipboard that copies and pastes compatible bar content across notation blocks.
• 1.0.0 is the first stable public release for Obsidian Community plugin submission.
• 0.9.7 polishes visual grid editing with a gesture hint, musical count labels in the selection strip, clearer grid-cell accessibility labels, and an extended 25–150% playback-speed range for tempo training.
• 0.9.6 documents setlist-style embeds and makes embedded drums blocks explicitly read-only for visual editing; open the source note to edit.
• 0.9.5 adds a one-bar count-in option in the metronome menu, a small first-session usage tip, and more reliable music-font loading for Obsidian PDF export and pop-out windows.
• 0.9.4 adds low-noise row-length warnings for likely accidental bar-length mismatches, such as a 17-slot row in 4/4 Grid 16. Short shorthand examples like HH | x--- remain warning-free.
• 0.9.3 adds advisory parser warnings in Obsidian and the playground for ignored rows, fallback settings, unsupported characters, and removed settings. Warnings do not block rendering, playback, or visual editing.
• 0.9.2 corrects Grid-16 engraving and buzz/legend durations to follow the written distance to the next hit. Three hits in one Grid-16 count no longer imply a triplet; use compound meters such as 6/8 or 12/8 for triplet-feel practice until explicit triplet syntax is added.

Create A Notation

You can start without writing drum rows manually:

• In an open Markdown editor, run Drum Notation: Insert notation block from the Command palette. Choose the title, tempo, time signature, and grid, then the plugin inserts a complete fenced drums block with one empty HH/SD/BD bar at the cursor.
• If you already created an empty top-level drums block, switch to Reading view and press Create first bar in the rendered block. Existing Title, Tempo, Time, and Grid values prefill the setup window.

The setup window shows the calculated bar length before creating it, such as 7/8 · Grid 16 · 14 slots. When visual edit mode is enabled, creating the first bar opens it immediately for editing.

Basic Example

Create a fenced code block with the language drums:

```drums
Title: Basic rock groove
Tempo: 100
Time: 4/4
Count: 1 e & a 2 e & a 3 e & a 4 e & a
HH | x-x-x-x-x-x-x-x-
SD | ----o-------o---
BD | o-------o-o-----
```

In reading view, the plugin renders the block as page-width percussion staff notation and adds Play, Stop, Loop Bar, Loop All, playback-speed, metronome/count-in, instrument-mute, and Edit controls. For training, playback speed supports 25–150% of the written tempo; the toolbar offers compact 10% steps, including above-100% tempos for push-tempo practice. The metronome menu offers Off, With drums, and Metronome only, plus an optional 1 bar count-in before Play, Loop Bar, or Loop All starts. The first metronome/count-in pulse of each bar is accented. Compound meters use grouped pulses, such as two clicks per bar in 6/8 and four in 12/8. The mute menu lists only instruments used in the current notation and mutes each canonical voice independently.

Speed, metronome, count-in, and mute choices are playback-only: they do not change the fenced notation text. Obsidian resets them when the rendered block is recreated; the playground keeps them for the current page session. Changing speed, metronome, or mute controls during playback restarts from the current slot while preserving the active Play/Loop mode and does not replay the count-in. Instrument mutes do not silence the metronome or count-in. Muting affects transport playback only, so clicking a rendered note or previewing an editor cell remains audible.

On mobile, if playback becomes silent after Obsidian was backgrounded or another audio app was used, tap Play again. If sound does not recover, relaunch Obsidian. This can happen when the mobile WebView audio session is interrupted.

Add Cursor: on if you want a blinking cursor to follow playback. Click a rendered note to preview that hit or stacked chord.

Visual Edit Mode

Visual edit mode is opt-in because it writes changes back to your notes. Enable Drum Notation → Enable visual edit mode in the plugin settings first. Then, in Obsidian reading view, press Edit to open a selected-bar grid below the rendered score. Click or tap a rendered bar to choose which bar the grid edits. Empty cells add a normal hit; filled cells select the hit and show the articulation tool strip. Edits apply immediately to the rendered notation and are saved back into the fenced drums block when you close visual edit mode or when Obsidian unloads the rendered block.

The bar toolbar is arranged as Add · Duplicate · Repeat · New line | Copy · Paste | Delete:

• Add inserts an empty bar after the selected bar on the same line.
• Duplicate inserts an editable copy of the selected bar immediately after it.
• Repeat opens a count dialog (1–99, default 1), then inserts % for one repeat or a compact %xN group immediately after the selected normal bar. Unrepeat opens the repeat dialog for both % and %xN, where you can change the count or use Make editable to replace the repeat/group with one editable copy.
• New line splits the current line after the selected bar, moving later bars to a new untitled line. If the selected bar is already last, it creates an empty next line.
• Copy stores the selected bar without changing the notation. Paste replaces the selected bar with that copied content.
• Delete removes the selected bar. For compact %xN, it removes the entire counted repeat group at once; separate % lines remain independent.

Copy/Paste uses a notation-only clipboard shared by visual editors for the current Obsidian session. Pasting over notes, sticking, or repeat notation asks for confirmation, and bars with different Time/Grid settings or bar lengths cannot be pasted together. Copy also mirrors a readable one-bar drums snippet to the system clipboard when the platform permits it.

Visual edit mode is intentionally limited in v1:

• It is available in reading view only. Live Preview/source-mode visual editing is planned, but remains read-only for now to avoid conflicts with Obsidian's active editor buffer.
• A block containing explicit tuplet syntax is read-only in the visual editor. Edit its fenced notation text directly. This block-level guard prevents the fixed-grid editor from accidentally removing or flattening tuplet regions; bar-level locking and tuplet-aware visual controls can be added later.
• Blocks with effective system-level Time: or Grouping: changes are rendered and playable but remain text-authored in this release.
• It edits only top-level drums fences. Blocks nested inside callouts, lists, or indented Markdown are rendered and playable, but visual editing is disabled.
• Embedded drums blocks are rendered and playable, but visual editing and first-bar creation are disabled. Open the source note to edit the groove.
• The first visual edit serializes the whole block in the plugin's canonical authoring form. This keeps the model safe and deterministic, but it may normalize spacing, labels, header order, and equivalent hit characters.
• One-bar repeat bars are selectable but their repeated body remains read-only. Use Unrepeat to open the repeat dialog, resize %/%xN, or retain one editable copy.

Embedding Grooves In Other Notes

Obsidian embeds are useful for building setlists, lesson notes, and practice dashboards from a groove library. Put each reusable groove under its own heading in the source note, then embed that heading wherever you need it:

## Chorus

```drums
Title: Chorus groove
Tempo: 112
HH | x-x-x-x-x-x-x-x-
SD | ----o-------o---
BD | o-------o-o-----
```

# Setlist

![[Groove Library#Chorus]]
![[Groove Library#Bridge Fill]]

Embedded drums blocks render with the normal score, playback controls, metronome/count-in, mute menu, legend, and parser warnings. Visual editing is intentionally read-only in embeds so the plugin does not write through an embedded section of another file. Open the source note, such as Groove Library, to edit the notation visually.

Settings

Put settings at the top of the block:

Title: Groove title
Author: Your name
Comment: Practice slowly, then loop it.
Tempo: 120
Time: 7/8
Grouping: 2+2+3
Voicing: split
Subtitle: Verse
Repeat: 4
Cursor: on
Highlight: on
Rests: on
Legend: off
Grid: 16

Supported settings:

Setting	Example	Notes
Title:	Title: Linear fill	Shown above the rendered score.
Subtitle:	Subtitle: Verse	Labels the current rendered staff line and all inline bars on it.
Tempo: or BPM:	Tempo: 96	Playback tempo, clamped between 30 and 260 BPM.
Time:, Meter:, or Time Signature:	Time: 6/8	Drawn on the staff. After Bar, changes that system and following systems.
Grouping:	Grouping: 2+2+3	Beams /8 or /16 meters in explicit groups that add up to the meter numerator. Use auto to clear inherited grouping.
Voicing:	Voicing: split	Uses separate up-stem hand and down-stem foot voices. Defaults to single.
Repeat: or Repeats:	Repeat: 4	Plays the whole block this many times when pressing Play.
Cursor: or Playback Cursor:	Cursor: on	Shows or hides the blinking playback cursor. Defaults to off.
Highlight:, Note Highlight:, or Playback Highlight:	Highlight: off	Highlights the note/chord that is currently sounding. Defaults to on.
Rests:	Rests: off	Shows inferred rest symbols by default. Use off to keep their spacing while hiding the symbols.
Legend:, Instrument Legend:, or Kit Legend:	Legend: all	Shows a compact color key. Use on/used for instruments in the current block, all for the full supported kit, or off to hide it. Defaults to off.
Grid:, Subdivision:, or Resolution:	Grid: 32	Sets one source character to a sixteenth note (16, default) or thirty-second note (32).
Author:	Author: Test Author	Stored as metadata.
Comment:	Comment: Test Comment	Stored as metadata.
Count:	Count: 1 e & a 2 e & a	Useful source-code guide while editing.

Title: names the complete notation block. Subtitle: is optional and belongs to one rendered staff line. Put another Subtitle: after a Bar separator to label the next line. Long subtitles wrap above the staff on narrow screens.

Instrument Rows

Each instrument row is:

LABEL | pattern

The pattern is one character per grid slot. By default one character is a sixteenth note. Use Grid: 32 when one character should be a thirty-second note. Put hits in the same column to stack them, such as kick plus hi-hat foot.

Labels	Instrument
BD, KD, Kick	Kick
BD2, KD2, Kick2, Bass Drum 2	Second kick / second bass drum
HF, HHF, Foot Hat, Hi-hat Foot	Hi-hat foot
HFS, HHFS, Foot Splash, Hi-hat Splash	Hi-hat foot splash
SD, SN, Snare	Snare
RS, Rim, Cross, Cross-stick	Rim/cross-stick
HH, CH, Close, Hat, Hi-hat	Closed hi-hat
OH, Open Hat	Open hi-hat
HO, HHO, Half-open Hat, Half-open Hi-hat	Half-open hi-hat
RD, Ride	Ride
RB, Ride Bell, Bell	Ride bell
CR, Crash	Crash
SP, Splash	Splash cymbal
China	China cymbal
Stack	Stack cymbal
HT, RT, T1, Rack Tom	High rack tom
MT, T2	Mid rack tom
LT, T3	Low rack tom
FT, Floor Tom	Floor tom
LFT, Low Floor Tom	Low floor tom
CB, Cowbell	Cowbell

SD uses a fuller synthesized snare sound. RS / cross-stick stays shorter and clickier. BD2 / second kick is for double-bass-pedal notation and renders below the main kick while using the same synthesized kick voice. RD, RB, CR, SP, China, and Stack use separate synthesized cymbal voices so their playback is distinguishable; ride bell is distinct from cowbell and renders as a diamond notehead on the ride line. OH / open hi-hat renders with the standard open-circle mark above the note. HO / half-open hi-hat renders the open circle with a vertical line through it. HFS / hi-hat foot splash renders as a circled x on the foot-hat line.

Sticking

Add a global right/left/both-hands sticking lane with ST, Stick, Sticking, or Hands. It is slot-aligned with the drum rows and display-only, so it does not affect playback.

```drums
Title: Sticking example
ST | R-L-B-L-R-L-B-L-
HH | x-x-x-x-x-x-x-x-
SD | ----o-------o---
BD | o-------o-------
```

Color Legend

The legend is hidden by default. Add Legend: on to show a color key for only the instruments used in the block, or Legend: all to show every supported instrument. When the legend is visible, noteheads are colored to match the legend while staff lines, stems, beams, and notation marks keep the notation color scheme. During playback and clicked-note previews, the active instrument symbols in the legend briefly pulse when note highlighting is enabled.

```drums
Title: Full Supported Kit - Separate Sounds Test
Tempo: 80
Time: 4/4
Grid: 16
Legend: all

CR    | x--------------- | ----------------
SP    | -x-------------- | ----------------
China | --x------------- | ----------------
Stack | ---x------------ | ----------------
RD    | ----x----------- | ----------------
RB    | -----x---------- | ----------------
OH    | ------x--------- | ----------------
HO    | -------x-------- | ----------------
HH    | --------x------- | ----------------
HF    | ---------x------ | ----------------
SD    | ----------o----- | ----------------
RS    | -----------x---- | ----------------
HT    | ------------o--- | ----------------
MT    | -------------o-- | ----------------
LT    | --------------o- | ----------------
FT    | ---------------o | ----------------
LFT   | ---------------- | x---------------
CB    | ---------------- | -x--------------
BD    | ---------------- | --o-------------
BD2   | ---------------- | ----o-----------
```

Starting A New Bar

Use | inside an instrument row to split measures. Inline measures stay on the same rendered staff line with a visual bar divider:

```drums
Title: Two-bar groove
Tempo: 104
Time: 4/4
HH | x-x-x-x-x-x-x-x- | x-x-x-x-x-x-x-x-
SD | ----o-------o--- | ----o---o---o---
BD | o-------o-o----- | o-o-----o-------
```

Use Bar: to force a new rendered staff line. This is useful when the next bar uses a different set of instruments.

```drums
Title: Groove then fill
Tempo: 104
Time: 4/4

Subtitle: Main groove
HH | x-x-x-x-x-x-x-x-
SD | ----o-------o---
BD | o-------o-o-----

Bar:
Subtitle: Fill
RD | x-x-x-x---------
HT | --------o-o-----
MT | ------------o-o-
FT | --------------oo
BD | o---o---o---o---
```

Bar:, Bar 2:, Measure:, and New Bar: all work as separators. A Subtitle: before or among a system's rows labels that complete rendered line, including multiple inline bars. Normal Play runs through all bars in order. Loop Bar loops the declared bar containing the current cursor or last clicked note.

Time: after Bar changes the meter for that entire system and remains active until another system declares Time:. A changed meter resets explicit beam grouping to automatic; add a new Grouping: beside it when needed. All inline bars on one rendered line share the same meter:

Time: 4/4
HH | x-x-x-x-x-x-x-x-

Bar
Time: 3/4
HH | x-x-x-x-x-x-

Bar
HH | x-x-x-x-x-x-

Bar
Time: 7/8
Grouping: 2+2+3
HH | x-x-x-x-x-x-x-

For clarity, place system Time: and Grouping: immediately after Bar. Late declarations still apply to the complete current system and produce an advisory parser warning. A one-bar % repeat cannot cross a boundary where the effective time signature changes.

Subdivisions And Beams

The notation is a literal grid: Grid: 16 means each character is a sixteenth slot, and Grid: 32 means each character is a thirty-second slot. The renderer derives note values from the distance to the next hit inside each beat:

Pattern inside one 4/4 count	Rendered as
x---	Quarter note
x-x-	Two eighth notes
x--x	Dotted eighth plus sixteenth
xxxx	Four sixteenth notes
xxxxxxxx in Grid: 32	Eight thirty-second notes

Rest tickables keep spacing exact when a gap cannot be represented by one simple or dotted note value. Their symbols are visible by default; add Rests: off to hide the symbols without changing timing or spacing. Hyphens describe silence, but they do not force a separate rest after every hit because the preceding note duration is inferred from the next hit. In 6/8, 9/8, and 12/8, regular eighth notes are beamed in compound groups of three. For asymmetric /8 and /16 meters, add a setting such as Grouping: 2+2+3 to control beam boundaries. Grouping changes engraving only; it does not change playback timing, metronome/count-in pulses, or create tuplets. Three hits in a Grid-16 count are not treated as an implicit triplet; write an explicit tuplet when equal subdivisions must occupy one written beat.

Drum voicing

By default, Voicing: single keeps every instrument in one up-stem voice, as in earlier releases. Add Voicing: split to engrave hand-played instruments with stems up and foot-played instruments with stems down:

Voicing: split
HH | x-x-x-x-x-x-x-x-
SD | ----o-------o---
BD | o-------o-o-----
HF | ------------x---

The lower voice contains kick (BD), second kick (BD2), hi-hat foot (HF), and hi-hat foot splash (HFS). Every other built-in instrument, including all toms and floor toms, remains in the upper voice. Simultaneous hand and foot notes align on the same timeline but infer durations and beams independently. Inferred whole-kit rests are drawn once, in the upper voice when it is present and otherwise in the lower voice; hidden alignment rests keep both voices at the full bar duration. Rests: off hides the shared rests without changing spacing. Voicing affects engraving only, so playback, visual editing, repeats, and copied bar content remain unchanged.

Explicit tuplets

Use N(...) to divide exactly one written denominator beat into N equal rhythmic positions:

Title: Triplet fill
Time: 4/4
ST | 3(RLR)3(LRL)3(RLR)3(LRL)
SD | 3(ooo)3(ooo)3(ooo)3(ooo)

N may be 3–12, and the body must contain exactly N hit, rest, or sticking characters. The token must begin on a written-beat boundary. In 4/4, 3(x-x) is one quarter-note beat divided into three equal positions; in 6/8, it is one eighth-note beat divided into three. Explicit 4(...) and 8(...) subdivisions are accepted for structural consistency but use ordinary power-of-two notation without a tuplet number.

Use B/N(...) to divide B complete written beats into N equal positions. For example, two 2/3(...) regions fill a 4/4 bar with quarter-note triplets:

Title: Multi-beat tuplets
Tempo: 84
Time: 4/4
ST | 2/3(RLR)2/3(LRL)
HH | 2/3(xxx)2/3(xxx)
SD | 2/3(o--)2/3(o--)
BD | 2/3(-o-)2/3(-o-)

B must be positive, the wrapper must begin on a written-beat boundary, and the complete region must fit in the bar. 1/N(...) normalizes to N(...). Forms where B equals N are ordinary subdivisions and should be written on the plain grid instead.

Use N@D(...) when the tuplet should occupy an explicit note-value duration instead of one written beat. D may be 2, 4, 8, 16, or 32:

Time: 4/4
HH | 3@8(xxx)--3@8(xxx)--3@8(xxx)--3@8(xxx)--
SD | 3@8(o--)--3@8(---)--3@8(o--)--3@8(---)--
BD | 3@8(---)o-3@8(---)o-3@8(---)o-3@8(---)o-

Here 3@8(xxx) is three equal positions within one eighth note: a sixteenth-note triplet. Explicit-duration tuplets may begin after any completed plain-grid position or another tuplet. They may not extend beyond the current bar. The engraver selects an exact power-of-two note value through 128th notes; combinations that cannot be represented within that limit produce an advisory warning.

Every present drum and sticking row in the same inline bar must describe the same ordered plain/tuplet rhythm structure and the same duration form. For example, do not mix meter-relative 2/3(...) and absolute 3@2(...) across rows even though they occupy the same duration in 4/4. Use explicit rest bodies such as 3(---) on a silent row:

Time: 4/4
HH | x-x-3(x-x)x-x-x-x-
SD | ----3(o--)----o---
BD | o---3(---)o-------

Tuplet bodies support the normal hit and articulation characters. Rests inside a tuplet remain explicit rhythmic positions and break beams. % and %xN repeat the resulting timing normally, and playback, metronome, cursor, and highlight timing follow the expanded quarter-note timeline.

Malformed tuplets, row-structure mismatches, and unsupported forms produce advisory parser warnings and fall back to plain-grid text so the block remains renderable. N(...) and B/N(...) remain relative to the written beat if the meter is changed through the playground controls; N@D(...) retains its absolute note-value duration. Nested tuplets remain deferred. Adjacent explicit wrappers remain separate engraving and beam groups.

Hit Characters

Character	Meaning
x, o	Normal hit
X, O, >, !, #	Accent
g	Ghost note, drawn in parentheses with quieter playback
f	Flam, drawn as a small grace note with connector and played as a soft grace hit
r	Drag / ruff, drawn as two beamed grace notes with connector and played as two soft grace hits
d	Diddle, drawn as a mid-stem slash and played as two hits that divide the inferred note value evenly
z, Z	Buzz roll, drawn as a custom line-drawn Z through the note stem and played as an overlapping closed snare-roll texture
c	Choked cymbal, drawn with a small plus mark and played with a short muted decay
-, ., _	Rest

Use c on a cymbal row for a choked cymbal:

```drums
Title: Choked crash
CC | c---------------
BD | o---------------
```

Buzz Rolls

Use z or Z on the snare row for a closed buzz roll / press roll. The rendered note shows a modern drumline-style custom line-drawn Z through the stem. During playback, snare buzz rolls use a continuous noise texture for the rendered note value. A short acoustic release tail overlaps the next buzz stroke, avoiding a silent gap between consecutive notes.

```drums
Title: Buzz roll with release
Tempo: 84
Time: 4/4
SD | z-------z-----o-
BD | o-------o-------
```

For long rolls, write consecutive buzz notes and end with a normal snare release note:

```drums
Title: Two-beat buzz roll
Tempo: 76
Time: 4/4
SD | z---z---o-------
BD | o-------o-------
```

Buzz-roll combinations:

Source	Result
`SD	z---inGrid: 16`
`SD	z-z-inGrid: 16`
`SD	zzzzzzzzinGrid: 32`
z stacked with another row in the same column	Snare plays a buzz texture while the other instrument plays its normal hit.
z followed by o	Buzz roll followed by a clean release note.
z with d, r, g, f, c, or accent in the same snare cell	Not supported because each instrument row uses one character per slot. Use adjacent slots or written-out Grid: 32 notes when you need more detail.

Thirty-Second Notes And Diddles

Use Grid: 32 when you want to write every thirty-second-note slot directly:

```drums
Title: Written 32nd fill
Tempo: 96
Time: 4/4
Grid: 32
SD | oooooooo------------------------
HT | --------oooooooo----------------
FT | ----------------oooooooo--------
BD | o---------------o---------------
```

Use d when you want compact drummer-style diddle notation. The two strokes divide the inferred rendered note value evenly:

```drums
Title: Diddle groove
Tempo: 100
Time: 4/4
Grid: 16
HH | x-x-x-x-x-x-x-x-
SD | d-------d-------
BD | o---o---o---o---
```

Combinations:

Source	Result
Grid: 16 + d-d-	Two visible diddled eighth notes, each played as two evenly spaced sixteenth-note strokes.
Grid: 16 + d---	One visible diddled quarter note, played as two evenly spaced eighth-note strokes.
Grid: 32 + d	The two strokes divide that note's inferred Grid-32 duration evenly.
Grid: 32 + written hits like oooo	Four explicit thirty-second notes.
d stacked with another row in the same column	The diddled instrument plays twice; the other stacked instrument plays once.
d with X, g, f, r, or c in the same cell	Not supported because each instrument row uses one character per slot. Use written-out Grid: 32 notes when you need an accented, ghosted, flammed, dragged, or choked double.

Full Kit Example

This example is inspired by the reference image and includes every supported row: cymbals, hi-hats, ride bell, cowbell, snare, cross-stick, ghost/flam/drag/choke strokes, rack toms, floor toms, kick, second kick, foot hi-hat, foot splash, and a stacked kick plus foot-hat hit.

```drums
Title: Full kit notation map
Author: Test Author
Comment: Test Comment
Tempo: 92
Time: 4/4
Count: 1 e & a 2 e & a 3 e & a 4 e & a 5 e & a 6 e & a 7 e & a 8 e & a
HH    | x-------------------------------
OH    | -o------------------------------
HO    | --x-----------------------------
CR    | --->----c-----------------------
SP    | ----x---------------------------
China | -----x--------------------------
Stack | ------x-------------------------
RD    | -------x------------------------
RB    | --------x-----------------------
CB    | ---------x----------------------
SD    | ----------g-----------f---------
RS    | ----------->--------------------
HT    | ------------o-------------------
MT    | -------------o------------------
LT    | --------------o-----------------
FT    | ---------------o----------------
LFT   | ----------------o---------------
BD    | -----------------o-------------X
BD2   | --------------------o-----------
HF    | ------------------x------------X
HFS   | -------------------x------------
```

Because rows share the same grid, the final X on BD and HF creates a kick plus hi-hat-foot stack.

Odd Time Example

```drums
Title: Seven-eight groove
Tempo: 132
Time: 7/8
Grouping: 2+2+3
Count: 1 & 2 & 3 & 4 & 5 & 6 & 7 &
HH | x-x-x-x-x-x-x-
SD | ----o-----o---
BD | o-----o-o-----
```

Each pattern character remains a sixteenth-note slot for spacing and playback. Grouping: 2+2+3 beams the seven written eighth notes as two, two, and three without changing their timing.

Rest slots keep the rhythm spaced correctly and inferred rest symbols are visible by default. Use Rests: off to hide those symbols while retaining the same timing and spacing. Fully silent bars currently use beat-group rests; centered whole-measure rests are planned separately.

Repetition And Looping

Use Repeat: to repeat the full block during normal playback:

```drums
Title: Repeated groove
Tempo: 108
Time: 4/4
Repeat: 4
HH | x-x-x-x-x-x-x-x-
SD | ----o-------o---
BD | o-------o-o-----
```

Use % on its own line for a one-bar measure repeat. Add a count suffix such as %x3 to repeat the previous bar three times. Counted measure repeats support 1–99 copies:

```drums
Title: Repeated bar
HH | x-x-x-x-x-x-x-x-
SD | ----o-------o---
BD | o-------o-o-----
%x3
```

During Play and Loop All, the compact x3 marker shows repeat progress as 1/3, 2/3, and 3/3, then returns to x3 outside playback. Loop Bar keeps the static count because it loops only one expanded bar.

Use Loop Bar in the rendered view to loop the bar containing the current cursor position. Click a note in another bar first, then press Loop Bar to loop that bar.

Development

Install dependencies:

npm install

Build once:

npm run build

Watch during development:

npm run dev

To test in Obsidian, copy or symlink this folder into:

<vault>/.obsidian/plugins/drum-notation

Then enable Drum Notation in Obsidian's community plugins settings.

Installation

After Community directory approval, install Drum Notation from Obsidian's Community plugins browser.

Until Community directory approval, install the GitHub release with BRAT, or install manually:

1. Download main.js, manifest.json, and styles.css from a release.
2. Create this folder in your vault:

   <vault>/.obsidian/plugins/drum-notation
   

3. Copy those three files into that folder.
4. Reload Obsidian and enable Drum Notation.

Privacy

The Obsidian plugin makes no network requests and includes no telemetry. Notes, settings, and generated notation stay in your vault.

When you press Copy in the visual editor, the plugin writes a generated one-bar notation snippet to the system clipboard. It never reads clipboard contents.

The web playground runs entirely in the browser. It uses localStorage to keep the current playground notation and light/dark preference for the current browser profile. It does not send notation to a server.

License And Third-Party Notices

Drum Notation is released under the MIT License. Production builds include VexFlow 5.0.0 for music engraving, also under the MIT License. See THIRD_PARTY_NOTICES.md for the full VexFlow notice.