flstudio-scripting

# FL Studio Python Scripting

Complete reference for FL Studio's Python API: MIDI controller scripting (14 modules, 427+ functions), piano roll note manipulation, Edison audio editing, and FLP file parsing with PyFLP.

## Quick Start

### Requirements
- FL Studio 20.8.4+, Python 3.6+

### Check API Version
```python
import general
print(f"API Version: {general.getVersion()}")
```

### Script Installation
Place scripts in `Shared\Python\User Scripts` folder.

---

## Three Scripting Contexts

### 1. MIDI Controller Scripting

**Purpose:** Control FL Studio through hardware MIDI controllers and send feedback to devices.
**Runs:** Continuously while FL Studio is open.
**Available modules:** transport, mixer, channels, arrangement, patterns, playlist, device, ui, general, plugins, screen, launchMapPages, utils, callbacks

**Entry points:**
```python
def OnInit():
    """Called when script starts."""
    pass

def OnDeInit():
    """Called when script stops."""
    pass

def OnMidiMsg(msg):
    """Called for incoming MIDI messages."""
    pass

def OnControlChange(msg):
    """Called for CC messages."""
    pass

def OnNoteOn(msg):
    """Called for note-on messages."""
    pass

def OnRefresh(flags):
    """Called when FL Studio state changes."""
    pass
```

### 2. Piano Roll Scripting

**Purpose:** Manipulate notes and markers in the piano roll editor.
**Runs:** Once when user invokes through Scripts menu.
**Available modules:** `flpianoroll`, `enveditor`

```python
import flpianoroll
score = flpianoroll.score
for note in score.notes:
    note.velocity = 0.8  # Set all velocities to 80%
```

### 3. Edison Audio Scripting

**Purpose:** Edit and process audio samples in Edison.
**Runs:** Once within Edison's context.
**Available modules:** `enveditor`

---

## API Module Reference Map

Navigate to the appropriate reference file based on what you need to control.
Read these files ONLY when you need specific API signatures.

### Core Workflow Modules

| Module | Function...