Thunderforge/RetroPie-Fun-Facts-Splashscreens

A tool for RetroPie to generate splashscreens with random video game related fun facts.

Fun Facts! Splashscreens for RetroPie

This script generates splashscreens for RetroPie with random 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 which splashscreen to use.
• --text-color [options]: Set which text color to use.
• --create-fun-fact: Create a new Fun Facts! splashscreen.
• --apply-splash: Apply Fun Facts! splashscreen.
• --enable-boot: Enable script to be launch at boot.
• --disable-boot: Disable script to be launch at boot.
• --gui: Start GUI.
• --update: Update script.

If --splash-path or --text-color are not set, the script takes the splashscreen and the text color defaults, default-splashscreen.png and white, respectively.

Examples

--help

Print the help message and exit.

Example

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

--splash-path [options]

Set which splashscreen to use.

Options

• path/to/splashscreen: Path to the splashscreen to be used.

Example

sudo ./fun-facts-splashscreens.sh --splash-path /home/pi/Downloads/retropie-2014.png

--text-color [options]

Set which text color to use.

Options

• color: Text color to be used.

Example

sudo ./fun-facts-splashscreens.sh --text-color black

--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 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 to be launch at boot.

Backing up /etc/rc.local is most recommended before using this option. It could erase important stuff. Use it at your own risk.

Example

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

--disable-boot

Disable script to be launch at boot.

Backing up /etc/rc.local is most recommended before using this option. It could erase important stuff. Use it at your own risk.

Example

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

--gui

Start GUI.

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

Example

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

Set splashscreen path (--splash-path)

Enter path to splashscreen

Set text color (--text-color)

Choose a color

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

Apply Fun Facts! splashscreen (--apply-splash)

Enable at boot (--enable-boot)

Disable at boot (--disable-boot)

Update script (--update)

--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

Config file

When setting the splashscreen path using --splash-path or setting the text color using --text-color, whether it's done via the command line or the GUI, the generated values are stored in fun-facts-settings.cfg.

# Settings for Fun Facts!

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

splashscreen_path = ""

# 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 = ""

You can edit this file directly instead of using --splash-path or --text-color.

Add a new Fun Fact!

• Open fun-facts.txt.
• Add a new Fun Fact! (each Fun Fact! must be in one line).

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.
• All the people at the RetroPie Forum.

License

MIT License.