Configuration

Configuration#

`[fretboard][general]`#

Name	Type	Description	Default
x_start	float	x position for starting fretboard	30.0
y_start	float	y position for starting fretboard	30.0
x_end_offset	float	x offset based on the lower right point	30.0
y_end_offset	float	y offset based on the lower right point	30.0
fret_height	float	Fret height	50
fret_width	float	Fret width	70
first_fret	float	Number of the first fret to display	0
last_fret	float	Number of the last fret to display	12
show_tuning	bool	Display the tuning	True
show_frets	bool	Display the frets	True
show_nut	bool	Display the nut	True
show_degree_name	bool	Display the name of degrees	False
show_note_name	bool	Display the name of notes	True
open_color_scale	bool	Color the open notes	False
fretted_color_scale	bool	Color the fretted notes	True
enharmonic	bool	Preprocess the scale and trensform it to enharmonic	True

`[fretboard][general][open_colors]`#

See open_colors

`[fretboard][general][fretted_colors]`#

See fretted_colors

`[fretboard][background]`#

`[fretboard][frets]`#

`[fretboard][fret_numbers]`#

See fret_numbers

`[fretboard][neck_dots]`#

`[fretboard][nut]`#

See nut

`[fretboard][strings]`#

`[fretboard][tuning]`#

`[fretboard][open_notes]`#

`[fretboard][fretted_notes]`#

See fretted_notes

Elements#

`[background]`#

Name	Type	Description	Default
color	str	Color of the background	rgb(150,150,150)
opacity	float	Opacity of the background	0.2

`[frets]`#

Name	Type	Description	Default
color	str	Color of the frets	“rgb(150,150,150)”
width	int / float	Width of the frets line	3

`[fret_numbers]`#

Name	Type	Description	Default
color	str	Text color of the fret number	“rgb(150,150,150)”
fontsize	int / float	Font size	20
fontweight	str	Font weight	“bold”

`[neck_dots]`#

Name	Type	Description	Default
color	str	Color of the dot	“rgb(200,200,200)”
stroke_color	str	Color of the stroke	“rgb(0,0,0)”
stroke_width	int / float	Width of the stroke	2
radius	int / float	Radius of the stroke	7

`[nut]`#

Name	Type	Description	Default
color	str	Color of the nut	“rgb(0,0,0)”
width	int / float	Width of the nut	6

`[strings]`#

Name	Type	Description	Default
color	str	Color of the strings	“rgb(0,0,0)”
width	int / float	Width of the strings line	3

`[tuning]`#

Name	Type	Description	Default
color	str	Color of the	“rgb(150,150,150)”
fontsize	int / float	Font size	20
fontweight	str	Font weight	“normal”

`[open_notes]`#

Name	Type	Description	Default
color	str	Color of the	“rgb(255,255,255)”
radius	int / float	Radius of the note	20
stroke_color	str	Stroke color of the note	“rgb(0,0,0)”
stroke_width	int / float	Stroke width of the note	3
text_color	str	Text color of the text inside the note	“rgb(0,0,0)”
fontsize	int / float	Font size of the text inside the note	20
fontweight	str	Font weight of the text inside the note	“bold”

`[fretted_notes]`#

Name	Type	Description	Default
color	str	Color of the	“rgb(255,255,255)”
radius	int / float	Radius of the note	20
stroke_color	str	Stroke color of the note	“rgb(0,0,0)”
stroke_width	int / float	Stroke width of the note	3
text_color	str	Text color of the text inside the note	“rgb(0,0,0)”
fontsize	str	Font size of the text inside the note	20
fontweight	str	Font weight of the text inside the note	“bold”

Colors#

`[open_colors]`#

Name	Type	Description	Default
root	str	Color of the root	“rgb(231, 0, 0)”
minor_second	str	Color of the minor second	“rgb(249, 229, 0)”
major_second	str	Color of the major second	“rgb(249, 165, 0)”
minor_third	str	Color of the minor third	“rgb(0, 94, 0)”
major_third	str	Color of the major third	“rgb(0, 108, 0)”
perfect_fourth	str	Color of the perfect fourth	“rgb(0, 154, 0)”
diminished_fifth	str	Color of the diminished fifth	“rgb(0, 15, 65)”
perfect_fifth	str	Color of the perfect fifth	“rgb(0, 73, 151)”
minor_sixth	str	Color of the minor sixth	“rgb(168, 107, 98)”
major_sixth	str	Color of the major sixth	“rgb(222, 81, 108)”
minor_seventh	str	Color of the minor seventh	“rgb(120, 37, 134)”
major_seventh	str	Color of the major seventh	“rgb(120, 25, 98)”

`[fretted_colors]`#

Name	Type	Description	Default
root	str	Color of the root	“rgb(231, 0, 0)”
minor_second	str	Color of the minor second	“rgb(249, 229, 0)”
major_second	str	Color of the major second	“rgb(249, 165, 0)”
minor_third	str	Color of the minor third	“rgb(0, 94, 0)”
major_third	str	Color of the major third	“rgb(0, 108, 0)”
perfect_fourth	str	Color of the perfect fourth	“rgb(0, 154, 0)”
diminished_fifth	str	Color of the diminished fifth	“rgb(0, 15, 65)”
perfect_fifth	str	Color of the perfect fifth	“rgb(0, 73, 151)”
minor_sixth	str	Color of the minor sixth	“rgb(168, 107, 98)”
major_sixth	str	Color of the major sixth	“rgb(222, 81, 108)”
minor_seventh	str	Color of the minor seventh	“rgb(120, 37, 134)”
major_seventh	str	Color of the major seventh	“rgb(120, 25, 98)”