March 10th, 2024: The style guide has had an overhaul to make it easier to understand! Please check what's changed, and chime in with feedback so that our wiki can continue to improve.

FLUX

FLUX
Type Ghost
Developer(s) Zichqec
Origin Original1)
Language(s) English, Polski, Français, Русский, Deutsch
Translator(s) Zdzisiu2), Levidre3), SmokyCinnamonroll4), Koguri31085)
Sakura FLUX
SHIORI YAYA
Release date May 12th, 2021
Download

This article is about the music player ghost named FLUX. For the shell/character of the same name, see FLUX.

FLUX is a ghost made by Zichqec, as a spiritual successor to the ghost FLELE. It has an improved music player with support for more file types and options, supports multiple languages in the menus, backwards compatibility for FLELE shells, and is able to automatically check for updates to shells.

Additionally, each shell can have its own file for custom YAYA code, allowing the developer to easily add custom dialogue.

Features

  • A fluid music player.
  • Support for multiple languages in the menus.6)
  • Discord integration that will display your current shell and song in your Discord status, if you use the Discord plugin for SSP.
  • Shells can include custom dialogue and functions.
  • Automatic checks for shell and balloon updates, in addition to checks for ghost updates.
  • Dark and light mode options if using the Notes balloon.
  • Integrated shell and dressup menus, including an option to randomize dressups.

Music player

FLUX's music player is one of its key features. It has some similarities to FLELE's music player, including hotspots and customizable hotkeys for various controls. It also has a lot of differences, such as playing music via SakuraScript commands instead of a SAORI.

The user may drag and drop music files onto the ghost to add songs to the playlist.

Supported file types

FLUX supports any file types that the baseware it is running on supports. In the case of SSP, these types are supported by default:

  • .mp3
  • .wav
  • .wma
  • .mid

Additionally, if the user has LAV Filters installed, it can support many more filetypes. This includes .ogg, .flac, and .m4a.

Click for the list of all supported filetypes.

Options

The user can change the volume, speed, and left/right balance of the player. This will affect songs as soon as the OK button is clicked on the slider input.

There are also 4 play modes available:

  • Loop Playlist
  • Shuffle and Loop
  • Loop One Song
  • Play One Song

The user may also toggle an option to stop playback after the current song completes.

Playlists

Playlists can be saved as .m3u files, and be reloaded at any time. This is the same filetype that FLELE uses, so FLUX playlists are compatible with FLELE, and vice versa.

Playlists are saved in the FLUX/playlists/ folder, and can be edited in a text editor if the user so chooses.

Additionally, the user may drag and drop playlists onto FLUX from elsewhere on their computer, and FLUX will automatically copy the playlist into its own folder.

Hotspots

FLUX supports all the same hotspots that FLELE does. These include:

  • Play
  • Stop
  • Menu
  • Music Menu7)
  • Clear Playlist
  • Minimize
  • Close

Additionally, FLUX has a few extra hotspots:

  • Pause/Resume
  • Next
  • Previous
  • Stop playback after current song

All hotspots have tooltips, to make it easy for the user to tell which hotspot does what, for any shell. These can be turned off in the config menu.

Hotkeys

FLUX supports the following hotkeys:

  • Play/Pause
  • Next song
  • Previous song
  • Stop song
  • Open menu

These may be bound to any key that is not reserved. Reserved keys are:

  • T (Random dialogue)
  • R (Repeat last dialogue)
  • F1 (Open readme)
  • V (Debug key)

Custom Shell Dialogue

FLUX supports some custom options for shells. This is intended for developers who would like to add a little extra to their shells, or who can't/don't want to make a full ghost, but would still like a little customization.

Custom dialogue/functions can be turned off at any time in the config menu. Toggling this option off will cause any shell to behave like a FLELE shell. Additionally, if there are any errors in the custom shell code, FLUX will still be able to run and will inform the user/developer of the issue. While errors persist, the shell will behave like a FLELE shell.

Custom options can be added by including a file called dialogue.dic in the shell's folder. The contents of this file will be copied into one of FLUX's files when the shell is loaded, in effect allowing the shell developer to write any YAYA code they want.

Below is a list of events that are provided, which custom dialogue and behavior can be added to. It is also possible to add any SHIORI events that FLUX does not already have, but this is not recommended, as future FLUX updates may add more SHIORI events and break the shell.

Click for the list of custom events.

There are also some extra functions and variables that a shell developer may find useful.

Click for the list of extra functions and variables.

Shell developers are urged to pick unique function and variable names, and to consider prefixing any new variables with the name of their shell, or their name as a developer, to prevent collisions with the variables of other shells.

Balloon

FLUX uses a custom balloon called Notes, and can make use of both the dark and light mode of the balloon.

Shells

Name Description
FLUX The default shell. A tall skeleton with 4 arms that animate independently, and holographic synthesizers with colors that the user can change with dressups. He speaks only in music notes. This shell has been released separately so that it can also be used with FLELE; more information about the shell is available on its specific page.
External Shells
Aimaina & Doushite-Chan A vocaloid shell drawn traditionally, featuring two characters.
cga A girl based on CGA colors.
Cibus A mysterious human girl. Comes with custom dialogue and some dressup options.
Cookie Band A shell featuring up to 12 characters from Cookie Run.
Gordon Freeman Gordon Freeman, from Half Life. Has several idle animations.
Gourmet Ravioli A can of ravioli in a pixel art style. Comes with dressups for different ravioli colors.
Jockey A shell of Jazaaboo's female Jockey design, based on Zarla's respectawoman Left 4 Dead AU. Comes with several dressup items.
Ordis (100% normal and alone)
Starset Messenger A mysterious figure, dressed in a space suit akin to the ones worn by Starset. Will display song symbols on its visor if playing Starset music.
Wooseok A shell of Wooseok, from Pentagon.
1)
FLUX Player is considered a separate entity from FLUX the character. The origin of the FLUX default shell can be found on its shell page.
2)
Polski
3)
Français
4)
Русский
5)
Deutsch
6)
See info card for currently supported languages.
7)
In FLELE, this would open the song bar.