Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/itsmeichigo/fretboard

Guitar & Ukulele chords with SwiftUI 🎸🎡🎢
https://github.com/itsmeichigo/fretboard

chords guitar-chords swiftui ukulele-chords

Last synced: 4 months ago
JSON representation

Guitar & Ukulele chords with SwiftUI 🎸🎡🎢

Awesome Lists containing this project

README

        

# Fretboard

![Logo](https://github.com/itsmeichigo/Fretboard/blob/main/logo.png?raw=true)

Lightweight guitar & ukulele chords in SwiftUI.

Supports iOS 13 and MacOS 10.15 upwards.

## Features
🎡 Chord positions

πŸŒ— Light / Dark modes

🎸 Guitar & ukulele chords with basic tunings

⏳ More to come

## Installation
#### Swift Package Manager
Add https://github.com/itsmeichigo/Fretboard.git as the source and you're good to go.

#### Manual install
Copy contents from Sources folder to your project.

## Usage
Get your desired instruments:
```Swift
let guitar = Instrument.guitar
let ukulele = Instrument.ukulele
```

Each instrument comes with their own name, keys, suffixes and chords. Get a list of positions for a chord using key and suffix:
```Swift
let dAug9Positions = guitar.findChordPositions(key: "D", suffix: "aug9")
let cMajorUkuPositions = Instrument.ukulele.findChordPositions(key: "C", suffix: "major")
```

Display any chord by sending it to `FretboardView`:

```Swift
FretboardView(position: dAug9Position)
.frame(width: 100, height: 200)
```

## Demo app
![screenshot](https://github.com/itsmeichigo/Fretboard/blob/main/screenshot.png?raw=true)