Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
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 πΈπ΅πΆ
- Host: GitHub
- URL: https://github.com/itsmeichigo/fretboard
- Owner: itsmeichigo
- License: mit
- Created: 2021-01-23T15:12:32.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-02T15:10:05.000Z (almost 3 years ago)
- Last Synced: 2024-04-24T08:26:35.946Z (9 months ago)
- Topics: chords, guitar-chords, swiftui, ukulele-chords
- Language: Swift
- Homepage:
- Size: 1.91 MB
- Stars: 11
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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)