(
    title: "Gfret",
    summary: Some("A tool for luthiers"),
    published: Some((
        year: 2022,
        month: 4,
        day: 14,
        hour: 15,
        minute: 39,
        second: 54,
    )),
    tags: [
        "software",
        "gfret",
        "lutherie",
        "rust",
        "gtk",
    ],
)
---
## Introduction
Gfret renders an svg image template of a fretboard for a stringed instrument. It has a Gtk interface as well as a command line interface and can produce templates for instruments ranging from a piccolo mandolin to an upright bass. Multiscale designs are also supported. Currently, all measurements are expressed in metric units only.
## Getting Gfret
Gfret is distributed primarily in source form. The main repo is at codeberg.org) with a mirror at github.com. Releases are recommended.
=> https://aur.archlinux.org/packages/eva-browser Codeberg repo
=> https://github.com/nfisher1226/gfret Github mirror
## Usage
Gfret can be used from the command line or using the Gtk+ interface.
## Running the command line interface
```
gfret-cli

Output an svg without running the interface

USAGE:
   gfret cli [OPTIONS] [OUTPUT]

ARGS:
   <OUTPUT>    Name of the output file [default: output.svg]

OPTIONS:
   -b, --bridge <BRIDGE>
           Bridge spacing [default: 56]

   -c, --count <COUNT>
           Total fret count [default: 24]

   -e, --external <EXTERN>
           Open output file in external program [default: inkscape]

   -h, --help
           Print help information

   -l, --left
           Multiscale fretboard reversed (left handed)

   -m, --multi <MULTI>
           Creates a multiscale fretboard with <MULTI> as the treble scale. [default: 610]

   -n, --nut <NUT>
           Nut width [default: 43]

   -o, --output <OUTPUT>
           Name of the output file [default: output.svg]

   -p, --perpendicular <PERPENDICULAR>
           Set which fret is perpendicular to the centerline [default: 8]
   -s, --scale <SCALE>
           Scale length in mm [default: 648]
```
## Running the gui
Calling the program by invoking gfret without any arguments will run the Gtk interface. Additionally, a .desktop file and icon are included, and can be used for launching the program from desktop menus or creating shortcuts.
## Keybindings
```
| Key          | Action                        |
| ------------ | ----------------------------- |
| Ctrl/S       | save file                     |
| Ctrl/Shift/S | save file as                  |
| Ctrl/E       | open with an external program |
| Ctrl/O       | load a template from file     |
| Ctrl/Shift/P | open the `preferences` dialog |
| Ctrl/A       | open the `about` dialog       |
| Ctrl/Q       | quit the program              |
```
## Templates
Along with the svg output, Gfret will save the specifications used to generate the rendering in a Toml file with it's name corresponding to the name of the svg file. These templates can be loaded later, either as an argument when invoking the program, in which case the output will be immediately generated, or else loaded from the Gui interface for further editing. This is useful for sharing a common scale among multiple designs to use as a starting point.
## Configuration
On Unix systems the default configuration directory is ~/.config/gfret. Gfret will maintain a configuration file here in Toml format.
> Note: The graphical interface has a preferences dialog and will take care of maintaining the preferences file for you. There will be no need to edit this file by hand in normal use.
## Building
You will need a Rust toolchain installed, including cargo. Gtk+4x is also required.
```
cargo build --release
```
If desired, a release distribution can then be generated which will include the binary, svg and png icons, Unix man pages, XDG .desktop file and shell completions.
```
cargo xtask dist
```
## Roadmap
* For the gui, it would be nice to save state and allow loading specs   from and saving to templates. **partial implementation 4/7/21** | **completed 5/5/21**
* Port to Gtk4 **completed 12/21**
* Support changing from metric to imperial measurements **completed 12/21**
* Support left handed multiscale fretboards **completed 12/21**
* Orient left handed output with bass strings on top **completed 1/22**