Skip to content

rfgil/MusicBooker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MusicBooker

Creates a lyric and a chorded songbook and a presentation written in LaTeX, from a collection of files.


Using MusicBooker

In the begining of the file Music.py are the following variables:

CHORUS_INDENTIFIER = '{CHORUS}'
ORDER_INDENTIFIER = '{ORDER}'
COMMENT_INDENTIFIER = '//'

CHORUS_INDENTIFIER is used to identify the chorus in the music file.

COMMENT_INDENTIFIER is used to comment lines source files.

ORDER_INDENTIFIER is used to set the order in which verses are suposed to be displayed in the presentation file. Here is a example of a music file:

{ORDER}: 1, {CHORUS}, 1, 2
F#-                         A
Esta sede de Te encontrar em mim
C#-                                 D
de correr p’ra Ti, de estar junto de Ti.
  B-                              F#-
Guias pelos vales o decurso do meu rio,
D             E C-             F#-
única razão és Tu, único sustento, Tu,
  D                E             A
a minha vida existe porque existes Tu.

{CHORUS}
     F#-       D                 E F#-
Tudo gira à Tua volta em função de Ti;
      C#-          D           E
não importa quando, onde e o porquê.

Gira o firmamento sem nunca ter paz,
mas existe um ponto a brilhar para mim,
a Estrela Polar que fixa os meus passos,
a Estrela Polar és Tu, a estrela segura, Tu.
A minha vida existe, porque existes Tu.

According to the position where the chorus identifier was used, the following verse is going to be considered the chorus:

Tudo gira à Tua volta em função de Ti;
não importa quando, onde e o porquê.

The presentation file will have the following structure according to ORDER_INDENTIFIER:

Slide 1: 1st verse
Slide 2: Chorus
Slide 3: 2nd verse
Slide 3: 1st verse
Note:

ORDER_INDENTIFIER is optional. The programm will select a standard order to display slides if this variable is not present in the music file.


Runing MusicBooker

Windows

Install Python3 and using Windows command line navigate to MusicBooker folder and run:

$ python3 main.py
Linux

In order to run this script on a Linux system you just need to navigate to the folder containing main.py and run the following command:

$ ./main.py

Console Interface

Once the application is running console will ask for the needed information, such as document title, date and music files. The application will automatically save a log of the musics used.

This log can later be used to run the application again, using the log file name as argument:

$ ./main.py log
Tip:

When selecting music file you can double press TAB for a list of available musics. And press TAB just once to autocomplete a music file name partially typed.

Once the application is finished it is generated a folder called resultcontains two files: chords.tex and lyrics.tex. These can be compiled to obtain the songbook, as explained next.


Using the resulting files

In order to compile the resulting files of this script you need to have a LaTeX compiler and LaTeX Songs package installed on your computer.

Windows

On a Windows sytem you can use MiKTeX. Once again in Windows command line navigate to result folder and run:

$ pdflatex file.tex

Linux

On a debian based Linux system you can use the following command line code to install the LaTeX compiler and Songs package:

$ sudo apt-get install texlive-full

And this one to compile a file named file.tex.

$ pdflatex file.tex

The MIT License

The MIT License (MIT)

Copyright (c) 2015 Rafael Gil

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

Creates a lyric and a chorded songbook

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages