Skip to main content

Fretty is a guitar fretboard generator

Project description

fretty

Fretty is a guitar fretboard generator.

Installation

pip install fretty

Usage

how to run fretty:

fretty example/C-major-scale-box1.ft -o C-major-scale-box1.svg

This will produce the file C-major-scale-box1.svg

Basic Format

III
- - o - o #
- - o o - o
- o # - o -
o - o - o -
# - o - o -
o - o - o -

The first line is the position of the starting fret. Every line which follows is the representation on string.

  • 'o' is a node
  • '#' is a note as square shape
  • '-' is an empty place
  • numbers are displayed as notes
II
-5--
---3
--71
3--5
71--
-5--
  • '|' is for a barre note
  • 'X' is a muted string
III
|---
|o--
|-o-
|-o-
|---
X---
  • '+' is a open string
I
--o-
---o
--o-
+---
X---
X---

Extended Format

You can enclose any text with branches.

  • '(' - ')' for circle notes
  • '[' - ']' for square notes
III
  -    -    (vi)    -   (vii)  [I]
  -    -    (iii)  (IV)   -    (V)
  -  (vii)  [I]     -    (ii)   -
(IV)   -    (V)     -    (vi)   -
[I]    -    (ii)    -    (iii)  -
(V)    -    (vi)    -    (vii)  -

If you close the note by using the barre synbol, instead of the closing branch, the note will be part of a barre symbol.

V
(5|   -   -   -
|    (3)  -   -
(7|   -   -   -
|     -  (5)  -
(1|   -   -   -
X     -   -   -

Additional Information

This project was inspired by svguitar.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

fretty-2.0-py3-none-any.whl (9.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page