First-run Wizard - Login

The first thing to configure is the administrators mysql login which will be used to create the nessecary database tables and the 'lyricue' mysql user.

The user chosen must have full access to the database.  This user is normally called 'root' and has no password by default. Note: this user is different to the 'root' login on the computer

Wizard - Database Login

First-run Wizard - Projector Settings

Here you can do some basic setup of how the projector screen will look.

Setting the width and height will help with ensuring the previews look correct.

You can set where the main lyrics will display on the screen (at the top/centre/bottom and left/centre/right of the screen) as well as what the text justification is. Wizard - Projector Screen Setup

First-run Wizard - Font Settings

Here you can specify the fonts used by the header, lyrics and footer Wizard - Font Selection

First-run Wizard - Image Directories

From here you can specify where the images and videos used by lyricue are stored.

Each sub-directory of whatever location you specify will show up as a seperate 'category' in Lyricue

You can set the directories as the same or seperate locations.  This can help you to keep images and videos unsuitable for use as backgrounds seperate.

If you are going to be running the interface and the server on separate machines these paths must be the same and accessible on both machines.  Sharing the directory as an NFS share is the best method of doing this.  It is recommended that the directory be shared from the server machine if you are going to be using videos.

Wizard - Directories

First-run Wizard - Most-used Items

Here you can enter the items that you want to always appear at the top of their respective lists.

You can also select your default bible translation.

Wizard - Special Items Selection

First-run Wizard - Confirm

You are all done.

Now you can continue to the main interface of Lyricue

Wizard - Confirmation

Playlist Selection

If no playlist is loaded the middle section shows a list of available playlists. From here you can create new playlists and load,rename or delete existing playlists. Double-clicking on a playlist will load it or you can select the playlist then click "Load"

Playlist selection

Using the Playlist

At the top of the playlist area is the name of the current playlist and a 'refresh' icon.

Underneath that the playlist is shown as a hierarchical tree view. Wherever you see a small triangle at the start of a line you can click on it to expand that item.

At the bottom of the playlist area are a number of toolbar buttons. They are

• Move selected item up
  • This works on the current item in the playlist and moves it within it's own level. This means that items will not move to other songs, nor to the main playlist unless they are already at that level.
• Move selected item down
  • This works the same as above, only in the other direction
• Remove selected item from playlist
  • Does what it says
• Add a new sublist
  • You can use this to organise your playlist by putting images within a playlist, or even seperating songs into seperate sublists

Playlist - with context menu

You can also right-click on an item in the playlist to bring up a context-sensitive menu.

• Duplicate Item
  • Makes a copy of the selected item and adds it to the end of the current playlist, sublist or song (at whatever level the item is on)  This can be used to temporarily modify a song to ease usage during the service.  For example: The worship leader is going to sing the first verse twice, the chorus once and then go back to the first verse before continuing as normal.  To make this easier to remember during the service you can copy the first verse twice and chorus once, then move them to the top of the song via the 'Move up' button
• Remove from Playlist
  • Removes the selected item
• Refresh Playlist
  • Forces an updates of the playlist
• Invert Line Display
  • Normally the first line of each page is shown as the text in the playlist, this option will display the last line instead
• Loop this playlist item
  • Selecting this item will bring up a dialog where you can choose how often Lyricue will automatically advance to the next page (and loop back to the beginning once at the end)  This is helpful to display a series of images/slides in a slideshow style
• Associate background
  • Selecting this item will cause then next background you double-click on to become associated with the selected page
• Dis-associate background
  • Removes any association for that item
• Move to sublist
  • Moves an item to a sublist. The sublist must already exist

Using the Sources area

Lyricue can source playlist items from a variety of locations.
To assist in adding to/modifying items on the playlist the 'Sources' area is split into five tabs.

Using preview area

The preview area can contain three sections: Preview window Miniview window Quick update area The preview window contains a small preview of the item you click on in the playlist. It can be used to check how a playlist item will look, if the text will fit and/or how the background/image looks. The miniview window contains a duplicate of whatever is being displayed on the server. This is helpful when the projector screen is not easily visible. Videos will not play in the preview or miniview as performance is impacted too much. The preview and miniview can be enabled/disabled in the preferences dialog. The quick update area is used to make immediate changes to a song, or to quickly put any text on the screen.  When a playlist item is selected it's contents will be copied into this area. The area is editable and so you can edit a page and click 'Save' to quickly correct errors in the page. You can also put any text you want in this area and click 'Show' to quickly show that text on the server screen.

Preview area

Adding an individual song

Add song dialog

 

To add a new song you can either choose 'Add Song' from the 'Edit' menu or click 'New' in the song tab.

This will bring up a dialog at which you can enter a new song or import a single song.

Importing songs

The quickest way to add songs to Lyricue is to import a songlist from http://www.lyricue.org/songs

The importing of songs from other formats is done song-by-song on the 'Add song' screen.

Then go to the 'File->Import Songlist' menu item. This will bring up the following screen Import songs dialog

At this screen you can select the previously downloaded file.

Once you have accepted this you will be taken to the following screen from where you can choose which individual songs you wish to import.

Import songs selection dialog

Once you have chosen the ones you want click OK to add them to your available songs

Bible Downloads

Lyricue can load bible verses from either via it's own SQL format, or any sword bible module

Sword Format

Lyricue can use bible translations from the Sword project as long as you have a small utility called 'diatheke' installed.  If diatheke is installed any sword bibles installed will show up automatically without configuration. You may need to add/install the 'diatheke' tool from your package manager

Sword bibles are also used by Bibletime and Gnomesword/Xiphos

The most common method is to download from Crosswire.org.

The Sword project provides a number of bible translations in a number of different languages. When downloading from there please use the 'Raw ZIP' download.

Your distribution may also provide pre-made packages for some bible texts.

In the case of Ubuntu and Debian the packages are named 'sword-text-*'. On other distributions they may be named differently.

Lyricue Database Format

Lyricue can import bibles in it's own SQL-based format.

• MySQL_create_bible_KJV.sql.gz - King James Version
• MySQL_create_bible_MES.sql.gz - The Message
• MySQL_create_bible_NIV.sql.gz - New International Version
• MySQL_create_bible_NIV_uk.sql.gz - New Internation Version - UK English
• MySQL_create_bible_NIRV.sql.gz - New International Readers Version
• MySQL_create_bible_NLT.sql.gz - New Living Translation
• MySQL_create_bible_NRSV.sql.gz - New Revised Standard Version
• MySQL_create_bible_GNT.sql.gz - Good News Translation
• MySQL_create_bible_NASB.sql.gz - New American Standard Bible

Installation

Installation from within Lyricue

With the release of Lyricue 2.0 the option was introduced to install bibles from within the interface.

To use select "Install New Bibles" from the "Bible" menu. From there you can import a Lyricue SQL format or Sword format bible that you have previously downloaded Import bible dialog

How to install Sword format automatically

Your distribution may also provide pre-made packages for some bible texts.

In the case of Ubuntu and Debian the packages are named 'sword-text-*'. On other distributions they may be named differently. Install using your distributions usual package manager.  You will also need to ensure that the 'diatheke' package is installed.

How to install SQL format Manually

To install a bible translation download one of the files listed below and then run gzip -dc bible.sql.gz | mysql -uroot -p Replace bible.sql.gz with the file you downloaded previously.

This should ask for your mysql root user password then install the bible. The next time you run lyricue it will be in the list of available bibles. If your MySQL install does not require a password for the root user remove the -p from the command above.

How to install Sword format Manually

To install a sword format manually run unzip bible.zip -d ~/.sword

Replace bible.zip with the file you downloaded previously.  You will also need to ensure that the 'diatheke' utility is installed.

Importing Images, Backgrounds and Videos

Importing images, backgrounds and videos is simply a matter of copying them into folders under your image/background directories.
For example, if you set your Images directory to be /home/user/Pictures then any folders inside that folder would show up in Lyricue as categories.
To create a new category you can create a new folder within /home/user/Pictures with the name that you can to give that category/group of images.
To add images to a category you can simply copy any valid image file to one of these created folders. Videos are treated exactly the same as an image.
The same applies for managing backgrounds.

Controlling the server with global hotkeys

Lyricue comes with a small utility called lyricue_remote

If you bind keys to lyricue_remote with various command-line arguments in order to control the server.

The main options are prev_page, next_page, prev_song, next_song and blank

If you are using Gnome with the metacity window manager then run the following commands and those options will be bound to the keys F5, F6, F7. F8 and F9 respectively.  This has the advantage of working even if the interface is not running

 

#!/bin/sh

gconftool-2 --set /apps/metacity/global_keybindings/run_command_1 --type String "F5"

gconftool-2 --set /apps/metacity/global_keybindings/run_command_2 --type String "F6"

gconftool-2 --set /apps/metacity/global_keybindings/run_command_3 --type String "F7"

gconftool-2 --set /apps/metacity/global_keybindings/run_command_4 --type String "F8"

gconftool-2 --set /apps/metacity/global_keybindings/run_command_5 --type String "F9"

gconftool-2 --type string --set /apps/metacity/keybinding_commands/command_1 "lyricue_remote prev_page"

gconftool-2 --type string --set /apps/metacity/keybinding_commands/command_2 "lyricue_remote next_page"

gconftool-2 --type string --set /apps/metacity/keybinding_commands/command_3 "lyricue_remote prev_song"

gconftool-2 --type string --set /apps/metacity/keybinding_commands/command_4 "lyricue_remote next_song"

gconftool-2 --type string --set /apps/metacity/keybinding_commands/command_5 "lyricue_remote blank"

Running the server and interface on separate machines

Multi-computer configuration

Lyricue supports running the interface and server on separate machines.
For instance you can have a computer running the server connected to your projector and then display the interface on a separate computer sitting elsewhere. This can even work with running the interface on a wireless tabletpc, netbook or laptop.
The easiest way to do this is to run both the interface and server on one computer, but use the X-forwarding capability in SSH to forward the interface from the server machine to the client machine.
To do this you can run 'ssh -X user@server /usr/bin/lyricue' which will ssh to the host server as user and run the interface. The interface will come up on your local machine.
The problem with doing it this way is that there is no way to add a file to the playlist that is stored on the local machine. This can make it difficult to do things such as importing presentations.

The other option is to run the interface directly on the local machine.

There are a few restrictions on this though.

• The lyricue package must be installed on both machines
• Both server and interface must be able to access the directories used for images/backgrounds
• The directory path of the images/backgrounds must be the same
• Both machines must either share the ~/.local/share/lyricue directory, or you will need to manually copy the config2 file from the interface computer to the server whenever you make configuration changes.
• MySQL must be configured to listen on the network interface, not just locally

The first thing to do is ensure that MySQL is setup for remote access as by default it is normally only setup for local access. MySQL should be setup/installed on the server (hostB).
To do this check your /etc/mysql/my.cnf and ensure you don't have either of the following:

bind-address = 127.0.0.1
skip-networking

If either of these exist, then remove them and restart the mysql server.

The next thing to do is to ensure that both machines can access the same image/background directories.
To make this easier you should use the same username to login on both machines and share the home directory between computers. The easiest way to do this is via NFS.
If you are planning on displaying videos it is strongly recommended that you share the directory from the server computer to the interface computer.

There are many ways to do this, but the simplest is log into the server machine (hostB) to install nfs-kernel-server and edit /etc/exports. In that file add a line such as:
/home/user *(rw,async)
Then run exportfs -a to export that directory as an NFS share
Now go back to the interface computer (hostA) and mount that directory as your home directory.
To do this edit /etc/fstab and add a line such as:
hostB:/home/user /home/user nfs rw,bg,soft,async,intr 0 0
That will mount the share from hostB over /home/user
Change the server hostname and username as required.
You should now restart the interface machine so that nothing is accessing the old home directory and the new home directory is mounted from NFS.

Once the directory is shared between computers you can specify where the lyricue server and mysql server are located by adding command-line arguments when running lyricue.
For lyricue use '-s' and '-r' to say where the lyricue and mysql
servers are running.
For lyricue_server use '-r' to say where the mysql server is running.

For example run lyricue -s hostB -r hostB on the interface computer and jsut lyricue_server on the server computer.