Song Tools Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Quick Start Guide ======

===== Download =====
Go to [[https://songtools.its-best.com|https://songtools.its-best.com]] and download the latest release.

===== System requirements =====
[[songmanager:start|Song Manager]] and [[songviewer:start|Song Viewer]] will run on any modern 64bit Windows 10 or 11 PC with at least [[https://dotnet.microsoft.com/en-us/download/dotnet-framework|.NET Framework 4.7.2]] runtime installed.

===== Installation =====
Run the downloaded "Song Tools Setup - X.X.X.exe" file to install Song Tools to your preferred directory.

===== Song Manager: first start =====
Start [[songmanager:start|Song Manager]] first and go to [[songmanager:settings|Settings]] to select your [[songmanager:settings#select_song_folder|Song Folder]] first.

It can be any folder on your system, where you want to store your song files in.\\
If you don't have created a folder yet, create one and select it.

===== Your First Song File =====
Copy the following into your [[songmanager:editing|Song Manager: Edit Section]]:

//This is not the full song. It's just used for demonstration.//
<code>
[Verse 1]
D              A     Bm           G       
Once a jolly swagman camped by a billabong
D                   A7      
Under the shade of coolibah tree
        D          A           Bm              G
And he sang as he watched and waited 'til his billy boiled
 D                       A7          D
You'll come a-waltzing Matilda with me

[Chorus]
 D                 G          
Waltzing Matilda, waltzing Matilda
 D                        A
You'll come a waltzing Matilda with me
        D          A           Bm              G
And he sang as he watched and waited 'til his billy boiled
  D                      A7          D
You'll come a-waltzing Matilda with me
</code>
You can also enter your own text and chords here. Make sure you set the correct title and artist in the next step in this case.

Enter //Waltzing Matilda// into title and //Misc Traditional// into artist field in the [[songmanager:editing#song_information_section|Song Information Section]].

Click [[songmanager:editing#the_convert_button|Convert]] and all chord lines will be recognized automatically and marked with **>**.\\
Also, there should be an [[filesyntax:start#information_line|Information Line]] on top of the file now.

Click [[songmanager:editing#save_a_file|Save]]. A window will open to save your file. The filename will be **//artist//-//title//.txt** and the selected folder should be your configured [[songmanager:settings#select_song_folder|Song Folder]].\\
Save the file, and we are done with editing your first song file.

===== Song Viewer: first start =====
Start [[songviewer:start|Song Viewer]] and go to [[songviewer:controlwindow:settings|Settings]] to select your [[songviewer:controlwindow:settings#select_song_folder|Song Folder]] first.

It should be the same folder, where [[songmanager:start|Song Manager]] stored your file in the last step.

===== View the file =====
You should [[songviewer:contentwindow:resize|resize and position]] the [[songviewer:contentwindow|Content Window]] to your needs first.

After you are happy with your positioning, click [[songviewer:controlwindow:modes#fodler_mode|Folder]] to load the local files list for the first time.

Select the file we created before, and the [[songviewer:contentwindow|Content Window]] will show your first song file now.

===== Next steps =====
Great. You created and viewed your first file now. Go on and play around with the different functions of both programs.

You should read [[filesyntax:start|Song Tools File Syntax]] next to learn everything about the right formatting of your files.