Skip to content

Commit ed1260b

Browse files
committed
website: promote beta to stable
1 parent a2fa81e commit ed1260b

35 files changed

+1069
-532
lines changed

website/versioned_docs/version-stable/about-the-project/beta-testing.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,6 @@ Beta releases install just like stable releases and will overwrite any existing
5555

5656
Version numbers indicate release order: for example, v1.0.0-beta.2 is newer than v1.0.0-beta.1, but both are preview versions that come before the final v1.0.0 release.
5757

58+
## Always Stay Updated
59+
60+
Always have the latest version of Floe - including beta features - by enabling _Include beta version when checking for updates_ in the preferences panel. This way, Floe will let you know when there's a new version available, whether it's stable or beta.

website/versioned_docs/version-stable/about-the-project/sponsorship.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,9 @@ SPDX-License-Identifier: CC-BY-SA-4.0
1212

1313
# Sponsorship
1414

15-
Sponsoring Floe helps support its ongoing development and maintenance. As a sponsor, you can receive priority support and influence the direction of the project. Additionally, you can propose professional packages to the [Package Directory](/packages).
16-
e can also offer services to anyone interested in Floe library development.
15+
Sponsoring Floe helps support its ongoing development and maintenance. As a sponsor, you can receive priority support and influence the direction of the project. Additionally, you can submit professional high-quality packages to the [Package Directory](/packages).
16+
17+
As another service, we can also help with converting or creating Floe sample libraries.
1718

1819
Please contact [Sam](mailto:[email protected]) to discuss more details.
1920

website/versioned_docs/version-stable/changelog.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,14 @@ For instance: 0.0.1. Don't change the headings.
1414
-->
1515

1616
# Changelog
17+
## 1.1.0
18+
- Fix pop sometimes possible at ping-pong loop boundary
19+
- Fix possible crash related to file paths on Windows.
20+
- Fix possible crash related to error reporting.
21+
- Fix possible package installation failure
22+
- Fix sometimes not correctly loading in Reaper or FL Studio, leaving UI looking correct but audio not reflective of the current state.
23+
- Major infrastructure improvements to how we build and release Floe.
24+
1725
## 1.1.0-beta.1
1826
- **Browser UI overhaul** (instruments, presets, IRs)
1927
- Filtering mode is now 'one' mode by default, and alternate modes for 'AND' or 'OR' filtering are selected in the 3-dots menu

website/versioned_docs/version-stable/develop/develop-libraries.mdx

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,12 @@ Creating sample libraries for Floe **requires programming knowledge**. While Flo
1919

2020
In the future, we're looking at tools that convert/generate Floe Lua scripts to allow non-programmers to create libraries.
2121

22+
:::note
23+
24+
We made these tools for our own use and are sharing them with the community. Consider contributing or [sponsorship](../about-the-project/sponsorship) if you'd like to see further investment in this area.
25+
26+
:::
27+
2228
### What you'll need
2329
- Basic programming concepts (variables, functions, loops) or willingness to learn
2430
- Familiarity with text editors (Sublime Text, VS Code, etc.)
@@ -98,7 +104,7 @@ Here's a made-up example of a `floe.lua` file:
98104

99105
## How to get started
100106

101-
1. Create a new folder in one of Floe's [sample library folders](../usage/sample-libraries). We recommend naming it 'Author Name - Library Name'.
107+
1. Create a new folder in one of Floe's [sample library folders](../key-concepts/folders). We recommend naming it 'Author Name - Library Name'.
102108
1. Create a file in that folder called `my-library.floe.lua`.
103109
1. Create a subfolder called `Samples` and put your audio files in there.
104110
1. Open the Lua file in your text editor. If you're not already familiar with an editor, then Sublime Text or Visual Studio Code are reasonable choices.
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
id: develop-preset-packs
3+
title: Develop Preset Banks
4+
hide_table_of_contents: true
5+
description: Best practices for developing preset banks for Floe
6+
---
7+
8+
<!--
9+
SPDX-FileCopyrightText: 2025 Sam Windell
10+
SPDX-License-Identifier: CC-BY-SA-4.0
11+
-->
12+
13+
Floe's preset management is open; it's just based on the files and folders on your computer.
14+
15+
Presets are saved as individual files using the <FAIcon icon="fa-solid fa-floppy-disk" /> save button at the top of Floe's UI. These files can be freely renamed and put into subfolders; this is how categories and hierarchies are created in the preset browser.
16+
17+
## Preset Banks
18+
19+
A _preset bank_ is small, optional, extension to this concept. By creating a `floe-preset-bank.ini` inside a folder of presets, it becomes a preset bank, where the entire tree of presets in the folder and all its subfolders become more easily identifiable and can feature metadata such as a subtitle and ID.
20+
21+
The preset bank file is a simple INI text file with the following fields - all are optional:
22+
23+
```ini
24+
; A short and descriptive name for the preset bank.
25+
subtitle = My Preset Bank Name
26+
27+
; Any kind of unique identifier. Typically you might use a reverse
28+
; domain style string. Used so Floe can identify the bank uniquely.
29+
id = com.myname.mypresetbank
30+
31+
; A version number - just a single integer. When installing a
32+
; package, Floe can use this alongside the ID to determine if a bank
33+
; can be updated rather than installed to a new location. Versioning
34+
; is only designed for simple additions/fixes. If you make major
35+
; changes, it's probably better to create a new preset bank,
36+
; "My Bank 2", with a new ID.
37+
minor_version = 1
38+
```
39+
40+
You can create this INI file with any text editor such as Notepad or TextEdit. You just need to type in the various `field = value` with new lines between them.
41+
42+
A side note for the particularly discerning user: Floe automatically identifies some well-known factory preset folders as preset banks even without the metadata file present. This is because some banks were created before the preset bank feature was added. We chose to enrich them with metadata retroactively.
43+
44+
## Packaging
45+
46+
Once you've created your folder of presets and added a `floe-preset-bank.ini` file (optional but recommended), you can ZIP it up for distribution.
47+
48+
Read about packaging on the [packaging](./packaging) page.
49+
50+
Use the packager command-line tool, or alternatively package it manually. To manually package your bank first rename your bank folder to something like `My Preset Bank`. Next, put that into a folder called `Presets`. Next, put `Presets` into another folder `My Preset Bank - Floe Package`, then right-click and ZIP that folder. You should now have a ZIP called `My Preset Bank - Floe Package.zip` with a subfolder `Presets` and your bank folder inside that. The resulting ZIP file will contain the structure that _Floe packages_ require (Presets subfolder at the top level). Test your package by trying to install it using Floe's _Install package_ button. Refer to the packaging page for more details if needed.
51+
52+
## Best Practices
53+
- Make presets all feel the same volume: the master peak meter on Floe's GUI should just be the yellow zone when the preset is played at its fullest.
54+
- Give each preset a unique, descriptive name suggesting its tone or usage. Don't use all capital letters. Don't include a 'type' prefix such as "PAD - " or "LD - ".
55+
- Add as many tags as is relevant to the preset. Read more about tags on the [tags and folders](./tags-and-folders) page.
56+
- Keep the description short and ending with a period.
57+
- Organise presets into folders using your file browser. You can rename presets and folders as you like. See the best practises for folders on the tags and folders page.

website/versioned_docs/version-stable/develop/develop-preset-packs.mdx

Lines changed: 0 additions & 20 deletions
This file was deleted.

website/versioned_docs/version-stable/develop/packaging.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,11 +13,11 @@ SPDX-License-Identifier: CC-BY-SA-4.0
1313
import data from "@site/static/generated-data.json";
1414
import CodeBlock from '@theme/CodeBlock';
1515

16-
The easiest and most reliable way to distribute your Floe content is with [Floe Packages](../packages/about-packages).
16+
The easiest and most reliable way to distribute your Floe content is with [Floe Packages](../key-concepts/components#packages).
1717

1818
Floe Packages are ZIP files containing **sample libraries** (which provide instruments and IRs) and/or **presets** (ready-to-use professional sounds). Packages are what users download and install into Floe.
1919

20-
Floe offers an easy-to-use GUI for [installing packages](../packages/install-packages). This installation process carefully considers existing content, versions, installation preferences, and whether installed libraries have been modified. The result should 'just work' or provide clear instructions on what to do next.
20+
Floe offers an easy-to-use GUI for [installing packages](../installation/install-packages). This installation process carefully considers existing content, versions, installation preferences, and whether installed libraries have been modified. The result should 'just work' or provide clear instructions on what to do next.
2121

2222
As with Floe's sample library format, openness is key. That's why Floe Packages are just normal ZIP files with a specific structure. Anyone can create them and anyone can open them. Additionally, it gives the user the option to extract them manually rather than use Floe's GUI if they wish.
2323

website/versioned_docs/version-stable/getting-started/quick-start-guide.mdx

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ Get up and running with Floe in just a few simple steps.
1515

1616
Floe is an **engine** it's empty without sample libraries.
1717

18-
If you already have packages (perhaps sent to your email), begin _Setting up Floe_. Otherwise, browse the [packages](/packages) page first to discover free and paid options.
18+
If you already have packages (perhaps sent to your email), jump below to _Setting up Floe_. Otherwise, browse the [packages](/packages) page first to discover free and paid options.
1919

2020
## Setting up Floe
2121

2222
1. **[Download Floe](/download)** and install it on your computer.
2323
1. **Download your packages** of your choice. **No need to unzip/extract them**.
2424
1. **Open your DAW**.
25-
1. **Add the Floe plugin** - often found under 'Floe Audio' in your plugin list.
26-
1. **Install your packages** by opening the Floe's Preferences <FAIcon icon="fa-solid fa-cog" /> and clicking the **Install package** button.
25+
1. **Add the Floe plugin** - often found as a 'virtual instrument' under 'Floe Audio' in your plugin list.
26+
1. **[Install your packages](../installation/install-packages)** by opening the Floe's Preferences <FAIcon icon="fa-solid fa-cog" /> and clicking the **Install package** button.
2727
1. **Select your downloaded package** ZIP file(s). After a few moments, your libraries and presets will be available to use.
2828

2929
## Load a preset
@@ -47,4 +47,10 @@ Instruments are the building blocks in Floe. Sometimes an instrument is a single
4747
1. **Choose an instrument** by clicking on one from the list on the right.
4848
1. **Play some notes** on your MIDI keyboard or DAW piano roll and notice how the sound has changed.
4949

50+
<div style={{marginBottom: '4em'}}></div>
5051

52+
:::note
53+
54+
Floe is continuously improving. Share your feedback or feature ideas on GitHub, forums or via email.
55+
56+
:::

website/versioned_docs/version-stable/installation/download-and-install-floe.mdx

Lines changed: 0 additions & 71 deletions
This file was deleted.

0 commit comments

Comments
 (0)