-
-
Notifications
You must be signed in to change notification settings - Fork 10
Configuration
luak edited this page Jan 27, 2022
·
10 revisions
By default the rusty-krab-manager
uses dirs to find the config folder ($CONFIG
). Then, it looks for the file $CONFIG/rusty-krab-manager/config.toml
to read from. If it doesn't find one, it automatically uses the example file in the assets/
directory.
Alternatively, one can call rusty-krab-manager
with a -c,--config
option. Using this, one can place the config file anywhere their heart desires. Also, note that environment variables like $HOME
won't work. rusty-krab-manager
doesn't have access to these.
Currently, all fields must be specified in this config file. See below example:
# this is an example configuration
# path to the task file
task_filepath = "/home/USERNAME/PATH_TO_TASKS"
# put tags for each assignment. Order dictates the rest
tags = [ "schoolwork", "job", "other" ]
# boolean to indicate if we should use due dates to weight the assignments
## when 'true' assignments due earlier will have a higher probability of
## being pulled (see wiki FAQ for more info).
## When 'false' equal weight to all assignments
use_due_dates = [ false, true, true ]
# timings for tasks/breaks/longbreaks in minutes
short_break_time = 1
long_break_time = 5
task_time = 20
# number of small breaks before big break
maxno_short_breaks = 2
[sound]
# path to notification sound
file = "/home/USERNAME/PATH_TO_SOUND" #NOTE: Ocean_man.mp3 is included in repo!
volume = 0.6
# weights for each tag project are broken down by day of the week.
## i.e. if you have two tags: ["schoolwork", "personal"] and weights
## on monday are given as [0.8, 0.2] then a new assignment from the
## schoolwork tag will be given with 80% probability, and a new one
## from the personal tag will be given with 20% probability
[weights]
mon = [ 0.2, 0.7, 0.1 ]
tue = [ 0.4, 0.5, 0.1 ]
wed = [ 0.6, 0.3, 0.1 ]
thu = [ 0.7, 0.2, 0.1 ]
fri = [ 0.6, 0.4, 0.0 ]
sat = [ 0.2, 0.3, 0.5 ]
sun = [ 0.3, 0.2, 0.5 ]