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	Original¹⁾
Language(s)	English, Polski, Français, Русский, Deutsch
Translator(s)	Zdzisiu²⁾, Levidre³⁾, SmokyCinnamonroll⁴⁾, Koguri3108⁵⁾
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
Music player
Custom Shell Dialogue
Balloon
Shells
- External shells
Gallery

Features

A fluid music player.
Support for multiple languages in the menus.⁶⁾
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 Menu⁷⁾
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.

shellver
- Used to indicate the current version of the shell. If included, the version number written here will appear on FLUX's main menu.
- No references.
OnCustom_trayicon
- Used to set a custom tray icon for the shell. Must include a \![set,trayicon,(path)] command.
- No references.
OnCustom_OnBoot
- Same as OnBoot, including references.
OnCustom_OnClose
- Same as OnClose, including references.
- FLUX will add the \-\e tags at the end, and as such, these tags should not be added by the shell developer.
OnCustom_OnGhostChanging
- Same as OnGhostChanging, including references.
OnCustom_OnGhostChanged
- Same as OnGhostChanged, including references.
OnCustom_OnShellChanging
- Same as OnShellChanging, including references.
OnCustom_OnShellChanged
- Same as OnShellChanged, including references.
OnCustom_RandomTalk
- Used to add dialogue to RandomTalk. It is possible to make two different dialogue pools based on if music is currently playing or not.
- No references.
OnCustom_Menu
- Used to add custom options to the main menu, between the Dressups and Config buttons. Recommended for small additions only.
OnCustom_Petting
- Used to add custom dialogue when the shell is pet.
- Same references as OnMouseMove.
OnCustom_MouseMoveSakura
- Used for more detailed mouse stroke interactions for the sakura.
- Same references as OnMouseMove, but reference3 will always be 0.
OnCustom_MouseMoveExtra
- Used for more detailed mouse interactions for the kero/any additional characters.
- Same references as OnMouseMove, but reference3 will never be 0.
OnCustom_MouseDoubleClickSakura
- Used for more detailed mouse double click interactions for the sakura.
- Same references as OnMouseDoubleClick, but reference3 will always be 0.
OnCustom_MouseDoubleClickExtra
- Used for more detailed mouse double click interactions for the kero/any additional characters.
- Same references as OnMouseDoubleClick, but reference3 will never be 0.
OnCustom_Overlap
- Used for if the sakura and kero start overlapping.
- Uses the same references as OnOverlap, but only fires if the sakura and kero have started overlapping.
OnCustom_OverlapExtra
- Used for more defauled overlap interactions.
- Uses the same references as OnOverlap.
OnCustom_IdleSurfaces
- Used to call random surfaces where the character is not singing.
- Called from multiple places in the ghost, including OnSurfaceRestore, so long as FLUX is not currently playing music.
- No consistent set of reference values.
- To check the current surface, the array SHIORI3FW.LastSurface may be used.
OnCustom_SingingSurfaces
- Used to call random surfaces where the character is singing.
- Called from multiple places in the ghost, including OnSurfaceRestore, so long as FLUX is currently playing music.
- No consistent set of reference values.
- To check the current surface, the array SHIORI3FW.LastSurface may be used.
OnCustom_ActionSurfaces
- Used to call random surfaces for various actions the ghost may take, usually the options in the right click menu.
- reference0 will be “Error” if the ghost encountered an error in the current action, “Refuse” if it cannot complete the current action, and “Action” if it's a normal action.
OnCustom_Commu
- Same as OnCommunicate, including references.
OnCustom_CommuStats
- Used to send custom stats when FLUX's stats are requested by another ghost.
- Commas should not be included in the output of this function.
- The | character is recommended as a delimiter instead.
OnCustom_BirthdaySet
- Used if the user sets their birthday, and it happens to be the current day.
- This dialogue should not be ended with a \e tag.
OnCustom_NewYear
- Used when the year rolls over at midnight on January 1st.
OnCustom_OnVanished
- Same as OnVanished.
- May be called either while FLUX is already open, if multiple ghosts were open at the same time, or if SSP switched to FLUX after the previous ghost was uninstalled.
- _argv[0] will contain 'boot' if FLUX was booted after the previous ghost was installed, or will be empty if they were both open at the same time.
OnCustom_TestFunc
- Used for debugging by the shell developer.
- Called when the developer runs the Custom Test Function option on the main menu.

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

Click for the list of extra functions and variables.

Flag
- Checks if a flag is set. Flags can be set with the syntax MiscFlags ,= “Your flag here”
RemoveFlag
- Unsets a flag
Singing
- 1 if music is currently playing, 0 otherwise.
Pronoun functions
- These can be used to refer to the user based on what pronoun option they have chosen in the config menu. There are different functions for each language that FLUX supports.
  - English
    - heshe
    - hisher
    - himher
    - hesshes
  - Polski
    - onona
    - jejjemu
    - jejjego
    - jestsa
  - Français
    - ilelle
    - celuicelle
    - luielle
  - Русский
    - онона
    - егоее
    - негонее (can also be written as негонеё)
    - емуей
    - имей
    - нимней
    - немней (can also be written as нёмней)
    - лла
    - лсялась
    - ойая
    - ийая
    - ыйая
  - Deutsch
    - ersie
    - ihnsie
    - ihmihr
    - seinihr
    - seineihre
    - seinerihrer
- gender
  - Set to “masc” if the user chose he/him pronouns, “fem” if the user chose she/her pronouns, or “Undef” if the user chose they/them pronouns.
  - This can be used if the developer would like to refer to the user by titles/nicknames, or is writing in a language that FLUX doesn't support.
- leapyear
  - 1 if it is currently a leapyear, 0 if it is not.
- Capitalize
  - Can be used to capitalize the first letter of whatever string is sent to it. ie %(Capitalize(heshe))
- MonthName
  - Returns the name of a month in any of the languages FLUX supports. Argument 0 is the number of the month, and argument 1 is the language to translate it to.
  - %(MonthName(11,'Polski')) would return Listopad.
- nowshell
  - The name of the current shell.
- nowballoon[0]
  - The name of the current balloon.
- CurrentSong
  - The name of the currently playing song. Note that this will still work even if the song is paused.
- ARRAYSIZE(CurrentPlaylist)
  - The number of songs currently in the playlist.
- ARRAYSIZE(ShellList)
  - The number of shells the user has installed.
- language
  - The language the user has selected.
  - Note that languages are written as they would be in that language. So Russian is written as Русский.

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

Click to reveal external shells

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.
	Five Rotten Pebbles	An AU version of Five Pebbles. Has custom dialogue and functionality.
	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.
	Hatsune Neon	An eerie, glitchy rendition of Hatsune Miku.
	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)
	Rosette Swan KKHTA	An original character. The shell is extremely large.
	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.