Skip to content

About

Indicator catalog for Flowsurface

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Latest commit

 

History

2 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Flowsurface indicators

Optional .ind indicators for Flowsurface. Install these sources without rebuilding the application. The engine and bundled indicators remain in the application repository.

Each indicator is a .ind file defining its calculations and presentation. Its filename must match the final ID segment: alice.rsi goes in rsi.ind. Full IDs must be unique; matching filenames can coexist in separate folders. Folder names do not assign IDs.

Collection IDs License Availability
Bundled core.* GPL-3.0-or-later Included in Flowsurface
Catalog catalog.* Apache-2.0 Optional; install manually

Install and run

Use a build that includes scripted-indicator support. Copy the desired .ind files or folders from sources/ into <data-directory>/indicators/, then restart the app. The data directory is $FLOWSURFACE_DATA_PATH when set, otherwise the platform data directory's flowsurface/ folder. Flowsurface creates this directory at startup and searches subfolders, skipping symlinks.

For development, pass an explicit file (repeat the option for more files):

flowsurface --indicator-path /path/to/example.ind

Or, from a checkout of this catalog, use all sources with an installed application:

FLOWSURFACE_INDICATORS_PATH="$PWD/sources" flowsurface

Bundled indicators remain available when using either option.

Sources load once at startup. Invalid installed sources are skipped with diagnostics. Bundled IDs take precedence over installed duplicates; otherwise, the first installed source with an ID wins.

For authoring, see the language reference and CLI workflow. Run check and test before installing a source.

Catalog contributions

Add sources to sources/ using catalog.<name> IDs and <name>.ind filenames. See CONTRIBUTING.md for validation, Apache-2.0 licensing, and DCO sign-off requirements.

About

Indicator catalog for Flowsurface

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors