BuboBubo/Cagire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

A ton of bug fixes

Browse Source
This commit is contained in:
Raphaël Forment
2026-01-28 01:09:23 +01:00
parent a9ce70d292
commit 322885b908
13 changed files with 400 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files

57
docs/welcome.md
View File

@@ -1,55 +1,16 @@
# Welcome to Cagire
Cagire is a terminal-based step sequencer for live music. Each step in a pattern contains a Forth script that controls sound synthesis and effects.
Cagire is a terminal-based step sequencer for live coding music. Each step in a pattern contains a **Forth** script that produces sound and create events. It is made by BuboBubo (Raphaël Maurice Forment): [https://raphaelforment.fr](https://raphaelforment.fr). Cagire is open-source (AGPL-3.0 licensed) and available on GitHub : [https://github.com/BuboBubo/cagire](https://github.com/BuboBubo/cagire). This help view will teach you everything you need to know to start using Cagire and and to live code with it.
## Pages
Navigate between pages with **Ctrl+Left/Right**:
Cagire is organized in several views. Navigate between them using **Ctrl+Left/Right/Up/Down**:
- **Sequencer**: Edit patterns, write Forth scripts, manage playback slots
- **Patterns**: Browse and select across 16 banks x 16 patterns
- **Engine**: Audio device selection, sample loading, CPU and voice monitoring
- **Options**: Application settings
- **Dict**: Forth word reference, organized by category
- **Help**: Documentation (you are here)
- **Sequencer**: Main view. Edit or preview patterns and scripts. Write Forth scripts.
- **Patterns**: Project patterns management. 32 banks of 32 patterns per project. Edit pattern properties (name, length, etc).
- **Engine**: Internal audio engine management: device selection, sample loading, performance options and voice / state monitoring.
- **Options**: General application settings.
- **Dict**: Forth word dictionary, organized by category. Learn about the internal programming language and its features.
- **Help**: Documentation. This is the page view you are looking at right now.
## Quick Start
1. Press **Space** to start the transport
2. Use **arrow keys** to navigate steps
3. Press **Tab** to focus the editor
4. Write a Forth script (e.g. `/sound/sine`)
5. Press **Ctrl+E** to compile
6. Press **Tab** to return to the sequencer
7. Press **Enter** to activate the step
8. Press **g** to queue the pattern to a slot
## Example Script
A step that plays a filtered saw with reverb:
```
"saw" s c4 note 0.5 dur 0.3 decay
0.6 gain 2000 lpf 0.4 lpq
0.3 verb 2.0 verbdecay .
```
A rhythmic pattern using subdivisions and probability:
```
"kick" s 0.8 gain .
div
"hat" s < 0.3 0.5 0.7 > gain . .
~
{ "snare" s 0.6 gain . } often
```
## Concepts
**Banks and Patterns**: 16 banks of 16 patterns each. Each pattern has up to 32 steps with configurable length and speed.
**Slots**: 8 concurrent playback slots. Queue patterns into slots with **g**. Slot changes are quantized to bar boundaries.
**Ableton Link**: Cagire syncs tempo and phase with other Link-enabled applications on your network.
**Forth**: The scripting language used in each step. Open the **Dict** page to browse all available words.
Have fun with Cagire! Remember that live coding is all about experimentation and exploration!