{"id":24266060,"url":"https://github.com/stex/songbooks","last_synced_at":"2025-10-28T01:10:36.221Z","repository":{"id":59155983,"uuid":"40021591","full_name":"stex/songbooks","owner":"stex","description":null,"archived":false,"fork":false,"pushed_at":"2016-07-24T13:02:19.000Z","size":5619,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-09-23T21:39:44.260Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stex.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-07-31T19:30:21.000Z","updated_at":"2019-03-07T23:28:23.000Z","dependencies_parsed_at":"2022-09-13T18:13:18.714Z","dependency_job_id":null,"html_url":"https://github.com/stex/songbooks","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stex%2Fsongbooks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stex%2Fsongbooks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stex%2Fsongbooks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stex%2Fsongbooks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stex","download_url":"https://codeload.github.com/stex/songbooks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241947423,"owners_count":20047193,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-15T10:59:07.197Z","updated_at":"2025-10-28T01:10:36.165Z","avatar_url":"https://github.com/stex.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Songbooks\n\nThis gem will run a simply web server to format / display chord files.   \nA chord file - at least here - is a text file with lyrics and chords for a certain song:\n \n```\n    Bm                    A        Bm\nOur Hero, our Hero claims a warrior's heart\n  Bm                     A         Bm\nI tell you, I tell you the Dragonborn comes\n       Bm                       A9         Bm\nWith a voice wielding power of the ancient Nord Art\n  Bm                 A9         Bm\nBelieve, believe the Dragonborn comes\n```\n([Malukah](www.malukah.com/)'s version of Skyrim's \"The Dragonborn comes\")\n\nIt allows you to view all songs in a certain directory and generate PDF songbooks from them.\n\n![Server](docs/server_screenshot.png)\n\n## Installation\n\nSimply install the gem using a ruby version \u003e= 2.2:\n\n    $ gem install songbooks\n\n## Usage\n\nTo start a songbooks server in a certain directory, use the following command:\n\n    $ sb_server start [DIRECTORY]\n    \nIf you don't specify a directory, the server will use the directory you are currently in.\nThis means, the following commands are equivalent:\n\n    $ sb_server start /path/to/chords\n    $ cd /path/to/chords \u0026\u0026 sb_server start\n    \nAfterwards, open http://localhost:4567 in your browser and you're good to go.\n\n## Annotations / Special Lines\n\nThe server automatically searches for certain patterns in the chord files: \nSong metadata and formatting information.\n\n### Metadata\nCurrently, only song title and artist are available as metadata. You may specify them by adding \nthe following lines to your chord files:\n\n    @artist NAME\n    @title SONG_TITLE\n    \nName/Title don't have to be in the same line as the annotation, the following lines are totally \nvalid as well:\n\n```\n@title\nThe Dragonborn comes\n\n@artist\nSkyrim OST (Cover by Malukah)\n```\n\n### Formatting\n\nAs seen in the above screenshot, it is possible to specify sections in your \nchord files. Each file starts with an initial unnamed section. To create a named section,\nadd a line in the following format to your file:\n\n    ## SECTION NAME\n\n## Planned features\n\n- Chord transposing\n- Better handling of chord files without annotations\n- Better PDF formatting\n- PDF generation from command line, e.g. `sb_server generate_songbook --out file.pdf [DIRECTORY]`\n\n## Development\n\nAfter checking out the repo, run `bin/setup` to install dependencies. \n\nThe project contains a `Guardfile` to automatically generate css and javascript files from \ncoffeescript and scss, so make sure you start guard before changing anything in `app/assets`:\n\n    $ guard\n\nTo install this gem onto your local machine, run `bundle exec rake install`. \n\n## Contributing\n\nBug reports and pull requests are welcome on GitHub at https://github.com/stex/songbooks.\n\n## License\n\nThe gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstex%2Fsongbooks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstex%2Fsongbooks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstex%2Fsongbooks/lists"}