Lume is a personal project and isn’t ready for general use. Running it requires working with the source code directly, and may not provide a smooth experience for non-technical users.
Lume can be downloaded with git:
git clone git@github.com:johnrcd/lume.git
cd lume
Install dependencies with npm:
npm i
Lume make heavy usage of enviornmental variables, using an .env file for configuring the project. This is intended to be changed in the future, but in the meanwhile you must have a properly configured .env file to run Lume locally.
Here is an example of a minimal .env file:
VITE_MIDI_FILE_PATH="test.mid"
# This section is used by some CanvasDrawer classes
VITE_MIDI_SONG_NAME="Name of Song"
VITE_MIDI_CREDIT="Rovi Decena"
VITE_MIDI_BPM="140"
VITE_MIDI_TIME_SIGNATURE="4/4"
VITE_MIDI_KEY="F Minor"
VITE_LUME_LAYOUT="simple_basicanalysis"
# Color Palette and Font
VITE_COLOR_BACKGROUND="#131010"
VITE_COLOR_NOTE_ACTIVATED="#CCCCCC"
VITE_COLOR_NOTE_HELD="#AAAAAA"
VITE_COLOR_NOTE_INACTIVE="#444444"
VITE_COLOR_NOTE_ACCENT="#003030"
VITE_FONT="Inter Regular"
Run the project locally.
npm run dev
Generates documentation site. Accessable in the docs/ folder.
npm run docs
Format code:
npm run linter
Run test cases:
npm run test
Lume is not an open-source project, and is not available for outside contributions.