Remotely control FL Studio using the MIDI Controller Scripting API
Project description
Flapi
Flapi (pron. "flappy") is a remote control server for FL Studio, using the MIDI Controller Scripting API. It allows you to execute Python code in FL Studio from outside of FL Studio by modifying functions in the FL Studio API Stubs package to forward their calling information to the Flapi server, where they are executed, with their values returned to the client.
$ flapi
>>> import ui
>>> ui.setHintMsg("Hello from Flapi!")
# Hint message "Hello from Flapi!" is displayed in FL Studio
Setup
-
Install the Flapi library using Pip, or any package manager of your choice.
pip install flapi
-
Install the Flapi server to FL Studio by running
flapi install
. If you have changed your FL Studio user data folder, you will need to enter it. -
On Windows, install a virtual MIDI loopback tool such as loopMIDI and use it to create a virtual MIDI port named
Flapi
. On MacOS, Flapi is able to create this MIDI port automatically, so this step is not required. -
Start or restart FL Studio. The server should be loaded automatically, but if not, you may need to set it up in FL Studio's MIDI settings.
Usage
As a library
import flapi
# Enable flapi
flapi.enable()
# Now all calls to functions in FL Studio's MIDI Controller Scripting API will
# be forwarded to FL Studio to be executed.
As a REPL
$ flapi
>>> import transport
>>> transport.start()
# FL Studio starts playback
>>> transport.stop()
# FL Studio stops playback
Server-side execution
Flapi also supports a bare-bones server-side REPL, where all input is executed within FL Studio (as opposed to forwarding function data).
$ flapi -s server
>>> import sys
>>> sys.version
'3.9.1 (default, Oct 14 2021, 10:29:32) [MSC v.1929 64 bit (AMD64)]'
# It's running inside FL Studio!
>>> print("Hello")
Hello
# Stdout is redirected back to the client too!
Credits
This concept was originally created by dimentorium and is available on GitHub at dimentorium/Flappy. I have adapted their code to improve its usability, and make it easier to install.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.