This project contains function definitions to provide intellisense while working on scripts for FL Studio's Python API, as well as a partially-complete model of FL Studio, which allows for scripts to be tested outside of FL Studio.
The documentation is also available as an online reference if Image-Line's own documentation isn't up to scratch.
To avoid module conflicts with other Python projects, it is recommended that you install this script in a virtual environment by following these instructions in the official Python documentation.
After activating the environment in your editor, you can install the stub
modules by running the command pip install FL-Studio-API-Stubs on Windows or
pip3 install FL-Studio-API-Stubs on MacOS or Linux.
Video reference for installation instructions
A couple of notes regarding this repo.
Although the stubs are mostly complete, there are a few functions where I don't
fully understand how they work. These functions have a HELP WANTED: label in
their documentation. If you happen to know how to use one, I'd love it if you
helped out by improving the documentation! I may also have incorrect
definitions for some functions. Please
create an issue
if you find anything incorrect.
A small number of tweaks have been made to these stubs in order to ease code writing. These shouldn't have any functional impact on the behavior of the API compared to the implied behavior from the stubs, but should help clarify some properties of certain functions.
- Functions where parameters or returns are boolean by nature are listed as
using a
booltype, even though the implementation uses the integers0and1. This change should help to describe the context in which the functions should be called when writing scripts, which in a language like Python is far more important than the actual implementation of the functions.
Dependencies for this project are managed using Poetry. You'll need to install Poetry to develop it.
To install the required dependencies, run poetry install.