FreeShow

https://freeshow.app/docs
Admin
FreeShow is a free and open-source program to show slides and lyrics on a screen, available on...
Tokens:15,763
Snippets:284
Trust Score:7.7
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install FreeShow using Snap

Source: https://freeshow.app/docs/linux

Use this command to install FreeShow on Linux distributions that support Snap packages.

```bash
sudo snap install freeshow
```

--------------------------------

### Install FreeShow using WinGet

Source: https://freeshow.app/docs/windows

Use this command to install FreeShow via the Windows Package Manager.

```bash
winget install --id=ChurchApps.FreeShow  -e
```

--------------------------------

### Install FreeShow using Arch PKGBUILD

Source: https://freeshow.app/docs/linux

Install the FreeShow package from the Arch User Repository (AUR) using pacman. Note that this format may not be regularly updated.

```bash
sudo pacman -S freeshow-git
```

--------------------------------

### Quick Lyrics: Metadata Import Example

Source: https://freeshow.app/docs/show-type

Import metadata by using field names followed by an equals sign and the value. This includes Title, CCLI, Copyright, and Author.

```text
        Title=Song Title
CCLI=1234567
Copyright=© 2011 The Best Words Ever Sung; © 2011 ACME Song Factory LTD.
Author=John Doe | Jill Doe | Samuel Somebody

      
```

--------------------------------

### Quick Lyrics: Custom Metadata Import

Source: https://freeshow.app/docs/show-type

Supports custom metadata fields. Fields with spaces can be written with or without spaces, as shown in the examples.

```text
        custom title with spaces=Some Text
customtitlewithspaces=Some Text

      
```

--------------------------------

### Example CCLI Song Usage Data

Source: https://freeshow.app/docs/advanced/ccli-reporting

This is an example of a snippet from the generated JSON usage log file. It includes song name, timestamp, and metadata such as title, author, copyright, and CCLI ID.

```json
{
            "name": "We Are His People",
            "time": 1762981107864,
            "metadata": {
                "number": "251",
                "title": "We Are His People",
                "author": "Philip Percival",
                "copyright": "2002 Emu Music",
                "CCLI": "3687233"
            }
        },
```

--------------------------------

### Quick Lyrics: Song Parts Example

Source: https://freeshow.app/docs/show-type

Use square brackets to define song parts like Verse, Chorus, and Bridge. FreeShow automatically numbers duplicate part names.

```text
        [Verse]
Line 1
Line 2
Line 3
Line 4

[Chorus]
Line 1
Line 2
Line 3

[Verse]
Line 5
Line 6
Line 7
Line 8

[Bridge]
Line 1
Line 2

[Chorus]
Line 1
Line 2
Line 3

      
```

--------------------------------

### Quick Lyrics: Slide Division Example

Source: https://freeshow.app/docs/show-type

Insert blank lines between song part lines to divide them into separate slides. This is an alternative to setting max lines per slide in settings.

```text
        [Verse]
Line 1
Line 2

Line 3
Line 4

      
```

--------------------------------

### FreeShow .project JSON Format

Source: https://freeshow.app/docs/format-project

Defines the structure of a FreeShow project file in JSON format. Use this for simple projects or as the base for zipped media projects.

```json
{
	"project": {
		"name": "Project Name",
		"created": 0, // date in Unix time
		"modified": 0, // date in Unix time
		"parent": "/", // leave as / (root)
		"shows": [
			// a list of the different project parts
			// supported types: show (song/presentation), section (text divider), image, video, audio, overlay, pdf, ppt
			// default "type" is "show"
			// a few examples:
			{ "id": "<show_id>" }, // see "shows" down below
			{
				"id": "section_id", // must be unique
				"type": "section",
				"name": "Section Name",
				"notes": "Further details...",
				"color": "" // optional, a color value in hex
			},
			{ "id": "image_path", "type": "image", "name": "Image Name" },
			{ "id": "video_path", "type": "video", "name": "Video Name" }
		]
	},
	"shows": {
		"<show_id>": {
			// a JSON formatted SHOW object
			// a show can be a song/presentation etc. (see below)
		}
	},
	// optional, if used in a show or in the project list add them here
	"overlays": {
		"<overlay_id>": {
			// very similar to a SHOW object
			"name": "Overlay Name",
			"color": null,
			"category": null,
			"items": []
		}
	},
	// optional, this is only needed if you create a ZIP project file with media files
	// can be any path/name.ext, but the basename (name.ext) must be the same as placed in the zip file
	"files": ["image_path", "video_path"]
}

```

--------------------------------

### FreeShow .show JSON Structure

Source: https://freeshow.app/docs/format-show

Defines the structure for a FreeShow presentation file in JSON format. Includes sections for show metadata, slide content, layout definitions, and media assets. Use this as a template for creating or understanding .show files.

```json
{
	"name": "Show name",
	"category": null, // the category id (can be left as null, unsorted)
	"settings": {
		"activeLayout": "<layout_id>", // the id of the layout, as set below
		"template": null // apply a template (can be left at null)
	},
	"timestamps": {
		"created": 0, // date in Unix time
		"modified": 0, // date in Unix time
		"used": null // can be null initially
	},
	"meta": {
		// these are the default keys, they are all optional
		// custom keys can also be added
		"number": "",
		"title": "",
		"artist": "",
		"author": "",
		"composer": "",
		"publisher": "",
		"copyright": "",
		"CCLI": "",
		"year": "",
		"key": ""
	},
	s"slides": {
		"<slide_id>": {
			"group": "Verse", // slide group name
			"color": "#5825f5", // preview color in hex format
			"settings": {
				// optional params
				"color": "", // slide background color (default is black)
				"resolution": { "width": 1920, "height": 1080 } // defaults to Full HD if unset
			},
			"children": ["<slide_id2>"], // optional, if more slides should be connected to this slide (don't add to layout if set as a child)
			"notes": "", // slide specific notes
			"items": [
				{
					"type": "text", // default is textbox (probably what you need)
					// if type is text lines should be set
					// each object in this array will get a new line
					"lines": [
						{
							"align": "", // text align (horizontal) in CSS format (defaults to "text-align:center;")
							"text": [
								// split text into multiple objects to get different styles on the same line
								{
									"value": "Hello World!", // text content
									"style": "font-size:100px;" // text style in CSS format
								}
							]
						}
					],
					"style": "top:120px;left:50px;height:840px;width:1820px;", // item style in CSS format (position should at least be set)
					"align": "", // text align (vertical) in CSS format (defaults to "align-items:center;")
					"language": "" // optional, if the textbox language is translated from an original textbox
				}
			]
		},
		"<slide_id2>": {
			// if this is used as a child slide, the group must be null
			"group": null,
			"color": null, // color can also be null, as the group parent color is used
			"settings": {},
			"notes": "",
			"items": []
		}
	},
	"layouts": {
		// multiple layouts can be used to rearrange the same slide groups with different orders
		// only one layout is required
		// the same slide groups can be added multiple times in the same layout
		"<layout_id>": {
			"name": "Default", // layout name
			"notes": "", // presentation notes
			"slides": [
				{ "id": "<slide_id>" }, // the slide group id
				{ "id": "<slide_id>", "background": "<media_id>" } // you can optionally add background media to the slide, as set below
				// more layout slide cues can be added like overlays, audio, actions, etc.
			]
		}
	},
	"media": {
		// optional, if background media is used
		"<media_id>": {
			"path": "", // path to background file or base64 encoded data
			"name": "" // media name
		}
	}
}

```

--------------------------------

### FreeShow Application Data Path

Source: https://freeshow.app/docs/linux

This is the default directory where FreeShow stores its application data. Advanced users may need to access or modify this path.

```bash
~/.config/freeshow
```

--------------------------------

### FreeShow Application Data Path on macOS

Source: https://freeshow.app/docs/macos

This is the default directory where FreeShow stores its application data. Advanced users may need to access this path for configuration or troubleshooting.

```bash
~/Library/Application Support/FreeShow/
```

--------------------------------

### FreeShow Application Data Path

Source: https://freeshow.app/docs/windows

This is the default path where FreeShow stores its application data. It is intended for advanced users.

```plaintext
%AppData%/freeshow
```
Tokens:
Raw