Skip to main content

FL Studio project file parser

Project description

PyFLP

PyFLP is an unofficial parser for FL Studio project and preset files written in Python.

CI build Documentation Build Status pre-commit-ci
PyPI PyPI - Package Version PyPI - Supported Python Versions PyPI - Supported Implementations PyPI - Wheel
Activity Maintenance PyPI - Downloads
QA codecov CodeFactor Grade Checked with mypy pre-commit Security Status
Other License GitHub top language Code Style: Black covenant

From a very general point-of-view, this is the state of what is currently implemented. Click on a link to go to the documentation for that feature.

Group Feature Issues
Arrangements
open arrangement-general issues closed arrangement-general issues
🎼 Playlist open arrangement-playlist issues closed arrangement-playlist issues
🚩 Timemarkers open arrangement-timemarker issues closed arrangement-timemarker issues
🎞️ Tracks open arrangement-track issues closed arrangement-track issues
Channel Rack
open channel-general issues closed channel-general issues
📈 Automations open channel-automation issues closed channel-automation issues
🎹 Instruments channel-instrument issues closed channel-instrument issues
📚 Layer open channel-layer issues closed channel-layer issues
📁 Sampler open channel-sampler issues closed channel-sampler issues
Mixer
open mixer-general issues closed mixer-general issues
🎚️ Inserts open mixer-insert issues closed mixer-insert issues
🎰 Effect slots open mixer-slot issues closed mixer-slot issues
Patterns
open pattern-general issues closed pattern-general issues
🎛 Controllers open pattern-controller issues closed pattern-controller issues
🎵 Notes open pattern-note issues closed pattern-note issues
🚩 Timemarkers ⏰ Planned
Plugins Native - 8 effects, 1 synth open plugin-native issues closed plugin-native issues
VST 2/3 plugin-3rdparty issues closed plugin-3rdparty issues
Project - Settings and song metadata open project-general issues closed project-general issues

⏬ Installation

Python 3.7+ required (CPython and PyPy are supported):

python -m pip install -U --pre pyflp

The pre-release version is more stable and supported than the current stable version. Please prefer to use it over the legacy 1.x versions.

▶ Usage

Load a project file:

import pyflp
project = pyflp.parse("/path/to/parse.flp")

If you get any sort of errors or warnings while doing this, please open an issue.

Save the project:

pyflp.save(project, "/path/to/save.flp")

It is advised to do a backup of your projects before doing any changes. It is also recommended to open the modified project in FL Studio to ensure that it works as intended.

Check the reference for a complete list of useable features.

🙏 Acknowledgements

✨ Contributors

All Contributors

Thanks goes to these wonderful people (emoji key):


nickberry17

💻

zacanger

🐛 📖

Tim

📖 💻 🚧

This project follows the [all-contributors] specification. Contributions of any kind are welcome!

Please see the contributor's guide for more information about contributing.

📧 Contact

You can contact me either via issues and discussions or through email via demberto(at)proton(dot)me.

© License

The code in this project has been licensed under the GNU Public License v3.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pyflp-2.0.0a4.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

pyflp-2.0.0a4-py3-none-any.whl (71.6 kB view details)

Uploaded Python 3

File details

Details for the file pyflp-2.0.0a4.tar.gz.

File metadata

  • Download URL: pyflp-2.0.0a4.tar.gz
  • Upload date:
  • Size: 1.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for pyflp-2.0.0a4.tar.gz
Algorithm Hash digest
SHA256 cd0fe693ba6373e6360f9ed2b5fb711a34ca37ee81facbd211a7bfb74c89df4d
MD5 3ee09649ae7dd0503fe8d44ca5d16680
BLAKE2b-256 75bf8769b3ef9baac7ef410d724ad591bb9dace1f111668a0617a4ff43076028

See more details on using hashes here.

File details

Details for the file pyflp-2.0.0a4-py3-none-any.whl.

File metadata

  • Download URL: pyflp-2.0.0a4-py3-none-any.whl
  • Upload date:
  • Size: 71.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.15

File hashes

Hashes for pyflp-2.0.0a4-py3-none-any.whl
Algorithm Hash digest
SHA256 778b83d6ac33457be597ec5d88cf588c8a4a6233491f98a94cb7dbe422123992
MD5 8be966ff29f21f557b85c6802c664c1b
BLAKE2b-256 52e781da74151e79d2a630e844d709f2759d36f8ec4dfbb2d204d92b00a1a35d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page