README.md

Fun Facts! Splashscreens for RetroPie

A tool for RetroPie to generate splashscreens with random video game related Fun Facts!.

WARNING: Splashscreens are only available on the Raspberry Pi.

Installation

cd /home/pi/
git clone https://github.com/hiulit/RetroPie-Fun-Facts-Splashscreens.git
cd RetroPie-Fun-Facts-Splashscreens/
sudo chmod +x fun-facts-splashscreens.sh

You can also install Fun Facts! Splashscreens as a scriptmodule via the RetroPie-Extra repository. Check the supplementary section.

Usage

sudo ./fun-facts-splashscreens.sh [OPTIONS]

If no options are passed, you will be prompted with a usage example:

USAGE: sudo ./fun-facts-splashscreens.sh [OPTIONS]

Use '--help' to see all the options.

Options

• --help: Print the help message and exit.
• --splash-path [OPTIONS]: Set the image to use as Fun Facts! Splashscreen.
• --text-color [OPTIONS]: Set the text color to use on the Fun Facts! Splashscreen.
• --bg-color [OPTIONS]: Set the background color to use on the Fun Facts! Splashscreen.
• --add-fun-fact [OPTIONS]: Add new Fun Facts!.
• --remove-fun-fact: Remove Fun Facts!.
• --create-fun-fact: Create a new Fun Facts! Splashscreen.
• --apply-splash: Apply the Fun Facts! Splashscreen.
• --enable-boot: Enable script at boot.
• --disable-boot: Disable script at boot.
• --gui: Start GUI.
• --edit-config: Edit config file.
• --reset-config: Reset config file.
• --update: Update script.
• --version: Show script version.
• --enable-log: Enable logging.
• --disable-log: Disable logging.
• --restore-defaults: Restore default files.

If --splash-path, --text-color, --bg-color, --enable-boot, disable-boot, enable--log or disable-log are not set, the script takes the defaults:

• splashscreen_path: ./retropie-default.png
• text_color: white
• boot_script: false
• log: false

See the config file.

Examples

--help

Print the help message and exit.

Example

sudo ./fun-facts-splashscreens.sh --help

--splash-path [OPTIONS]

Set the image to use as Fun Facts! Splashscreen.

Options

Must be an absolute path (e.g /home/pi/my-awesome-splashscreen.png).

• path/to/splashscreen: Path of the image to use as Fun Facts! Splashscreen.

Example

sudo ./fun-facts-splashscreens.sh --splash-path "/home/pi/my-awesome-splashscreen.png"

--text-color [OPTIONS]

Set the text color to use on the Fun Facts! Splashscreen.

Options

• color: Text color of the Fun Facts! Splashscreen.

Example

sudo ./fun-facts-splashscreens.sh --text-color "white"

--bg-color [OPTIONS]

Set the background color to use on the Fun Facts! Splashscreen.

Options

• color: Background color of the Fun Facts! Splashscreen.

Example

sudo ./fun-facts-splashscreens.sh --bg-color "black"

--add-fun-fact [OPTIONS]

Add new Fun Facts!.

Options

• text: Fun Fact! text.

Example

sudo ./fun-facts-splashscreens.sh --add-fun-fact "You're new and amazing Fun Fact!"

--remove-fun-fact

Remove Fun Facts!.

Example

sudo ./fun-facts-splashscreens.sh --remove-fun-fact

--create-fun-fact

Create a new Fun Facts! Splashscreen.

The resulting splashscreen will be in /home/pi/RetroPie/splashscreens/.

Example

sudo ./fun-facts-splashscreens.sh --create-fun-fact

--apply-splash

Apply the Fun Facts! Splashscreen.

This command must be run in order to use the Fun Facts! Splashscreen.

Example

sudo ./fun-facts-splashscreens.sh --apply-splash

--enable-boot

Enable script at boot.

Example

sudo ./fun-facts-splashscreens.sh --enable-boot

--disable-boot

Disable script at boot.

Example

sudo ./fun-facts-splashscreens.sh --disable-boot

--gui

Start GUI.

It lets you perform all the functions, but in a more friendly manner.

Example

sudo ./fun-facts-splashscreens.sh --gui

Set splashscreen path (--splash-path [options])

Enter splashscreen path

Set text color (--text-color [options])

Basic colors

Choose a color

Full list of colors

Choose a color

Add a new Fun Fact! (--add-fun-fact [options])

Enter a new Fun Fact!

Remove Fun Facts! (--remove-fun-fact)

Choose a Fun Fact! to remove

Create a new Fun Facts! Splashscreen (--create-fun-fact)

Apply the Fun Facts! Splashscreen (--apply-splash)

Apply the Fun Facts! Splashscreen (already applied)

Enable script at boot (--enable-boot)

Disable script at boot (--disable-boot)

Edit config file (--edit-config)

Text editor

Reset config file (--reset-config)

Update script (up to date) (--update)

Update script (there are updates)

Enable logging (--enable-log)

Disable logging (--disable-log)

Restore default files (--restore-defaults)

--edit-config

Edit config file.

Opens a simple text editor.

When using this option from the terminal, it opens the nano text editor. To save the changes, press ctrl + o and then press enter. To exit, press ctrl + x.

When using the GUI, use the tab key to select Save or Back.

Example

sudo ./fun-facts-splashscreens.sh --edit-config

--reset-config

Reset config file.

Removes all values from the config file. Next time the script is executed, it will populate the config file with defaults.

Example

sudo ./fun-facts-splashscreens.sh --reset-config

--update

Update script.

Example

sudo ./fun-facts-splashscreens.sh --update

If you're using Fun Facts! Splashscreens via RetroPie-Setup (if you installed it as a scriptmodule via the RetroPie-Extra repository), this function won't work. The scriptmodules have their own update function.

If that's the case, go to:

• Manage packages
• Manage experimental packages
• fun-facts-splashscreens
• Update from source

--version

Show script version.

Example

sudo ./fun-facts-splashscreens.sh --version

--enable-log

Enable logging.

The log file is fun-facts-splashscreens.log.

Example

sudo ./fun-facts-splashscreens.sh --enable-log

--disable-log

Disable logging.

Example

sudo ./fun-facts-splashscreens.sh --disable-log

--restore-defaults

Restore default files.

• ./retropie-default.png (default splashscreen)
• ./fun-facts-splashscreens-settings.cfg (default config file)
• ./fun-facts.txt (default Fun Facts!)

Example

sudo ./fun-facts-splashscreens.sh --restore-defaults

Config file

When using --splash-path, --text-color, --bg-color, --enable-boot, disable-boot, enable--log or disable-log, whether it's done via the terminal or the GUI, the generated values are stored in fun-facts-splashscreens-settings.cfg.

# Fun Facts! Splashscreens Settings.

# Set splashscreen path
#
# Must be an absolute path (e.g /home/pi/my-awesome-splashscreen.png).
splashscreen_path = ""

# Set splashscreen text color
#
# Short list of available colors:
#
# black, white, gray, gray10, gray25, gray50, gray75, gray90,
# pink, red, orange, yellow, green, silver, blue, cyan, purple, brown.
#
# TIP: run the 'convert -list color' command to get a full list.
text_color = ""

# Set background color
bg_color = ""

# Enable/disable script at boot
#
# Boolean: true/false.
boot_script = ""

# Enable/disable logging
#
# Boolean: true/false.
log = ""

You can edit this file directly instead of using --splash-path, --text-color, --bg-color, --enable-boot, disable-boot, enable--log or disable-log.

Add a new Fun Fact!

• Open fun-facts.txt.
• Add a new Fun Fact! (see style guide).

Style guide

• Each Fun Fact! must be in one line.
• All video game names must be enclosed in double quotes (e.g. "Sonic the Hedgehog").
• Check the names using the TheGamesDB or any other reliable source.
• Fun Facts! aren't funnier even if they're written with exclamations marks. Don't use them.
• Tacky Fun Facts! aren't funnier either.
• Stick to Fun Facts! about video games that can be played with RetroPie (see supported systems).
• Try not to make Fun Facts! too long.

If you have an awesome Fun Fact! that you'd like to share, you can create a new issue with your awesome Fun Fact! and I'll gladly add it to the repository for everyone to enjoy! 😃🎉

Also (and preferably), if you know how, you can create a pull request 😉

Changelog

See CHANGELOG.

Contributing

See CONTRIBUTING.

Authors

Me 😛 @hiulit.

Credits

Thanks to:

• Parviglumis - For the idea of creating the Fun Facts! Splashscreens.
• meleu - For all his help and wisdom with the code and for all the PRs! :D
• zerojay - For adding Fun Facts! Splashscreens to the RetroPie-Extra repository.
• Thunderforge - For adding more Fun Facts!.
• All the people at the RetroPie Forum.

License

MIT License.