Gfret

Contents

• Introduction
• Getting Gfret
• Usage
  • Cli
  • Gui
    • Keybindings
  • Templates
• Configuration
• Building
• Roadmap

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 mirrors at gitlab and github.com. Releases are recommended.

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 will be installed if the program is installed using the included Makefile, and can be used for launching the program from desktop menus or creating shortcuts.

Keybindings

Note: See KEYS.md for information on changing keybindings

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, gschema.xml and shell completions.

cargo xtask dist

To install, copy the contents of target/dist to the appropriate prefix and compile the gschemas.

cp -Rv target/dist/* /usr/local
glib-compile-schemas /usr/local/share/glib-2.0/gschemas/

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

3.0

• Subclass application window from AdwApplicationWindow
• Subclass GfretApplication from AdwApplication
• Create a gio::Settings object and store application state in it
• Move Config into GfretApplication
• Provide theme switcher
• Subclass preferences window from AdwPreferencesWindow
• Make a property action and menu entry for Units
• Add AdwToastOverlay and set toast when a file is saved
• Replace gfret::File type for glib::File
• Make a changed boolean property of GfretWindow to track saved state
• Create all dialogs as needed instead of persisting for the program lifespan
• Replace templates with the ability to re-open svg files created by this application
• Prepare for FlatPak packaging and distribution