https://github.com/mbcom/salt-plymouth-formula
A SaltStack formula to configure a nice looking boot animation to your Debian/ Ubuntu PC.
https://github.com/mbcom/salt-plymouth-formula
debian plymouth plymouth-theme saltstack-formula splashscreen ubuntu
Last synced: 3 months ago
JSON representation
A SaltStack formula to configure a nice looking boot animation to your Debian/ Ubuntu PC.
- Host: GitHub
- URL: https://github.com/mbcom/salt-plymouth-formula
- Owner: MBcom
- License: apache-2.0
- Created: 2025-05-11T16:53:43.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-05-11T18:52:36.000Z (about 1 year ago)
- Last Synced: 2025-07-08T10:44:24.786Z (about 1 year ago)
- Topics: debian, plymouth, plymouth-theme, saltstack-formula, splashscreen, ubuntu
- Language: SaltStack
- Homepage:
- Size: 44.9 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Plymouth Formula
**Do you want to create a custom boot experience? Do you want to show your companies logo oder your own logo during startup of your Ubuntu oder Debian based PC?** This formula will configure anything for you.
A SaltStack formula to configure Plymouth boot splash screen with custom themes.
## Features
- Installs Plymouth and required firmware packages
- Configures GRUB for Plymouth compatibility
- Sets up custom boot splash themes
- Includes example theme "mbcom" with:
- [@MBcom](https://github.com/MBcom) logo
- Progress bar
- Message display support
- Configurable background colors
### Example: MBcom example theme and customization Note
The "mbcom" theme provided in this formula is just an example to demonstrate the structure and functionality of a Plymouth theme. You can use it as a starting point to create your own custom theme. Refer to the [Creating Custom Themes](#creating-custom-themes) section for detailed instructions.
**Important:** You are not permitted to use the [@MBcom](https://github.com/MBcom) logo/ profile image in your custom themes. Replace it with your own logo or design assets.
## Configuration
The formula can be configured through pillar data. Default settings are:
```yaml
plymouth:
theme: mbcom # Default theme name
```
## Usage
1. Include the formula in your state:
```sls
include:
- plymouth
```
2. Optionally override the default theme in your pillar:
```yaml
plymouth:
theme: mytheme
```
## Creating Custom Themes
To create a custom theme:
1. Create a new directory under `plymouth/files/mytheme/`
2. Add required theme files:
- `mytheme.plymouth` - Theme configuration
- `custom-splash.script` - Theme script
- Image assets (logo, progress bar, etc.)
Example theme structure:
```
plymouth/files/mytheme/
├── custom-splash.script
├── logo.png
├── progress-bar.png
├── progress-box.png
└── mytheme.plymouth
```
I would recommend images not larger than 720 x 350 px.
## Testing
Test the theme after installation:
```bash
plymouth-set-default-theme -l # List available themes
plymouth-set-default-theme mytheme -R # Set and test new theme
```
## License
Apache-2.0
## Contributing
1. Fork the repository
2. Create a feature branch
3. Submit a Pull Request