Skip to content

Commit 407d558

Browse files
authored
Merge pull request #303 from avi951/main
docs: add instructions to change Plymouth splash screen
2 parents a4b3237 + cea781e commit 407d558

1 file changed

Lines changed: 39 additions & 27 deletions

File tree

source/vicharak_sbcs/axon/axon-os-configuration/splash-screen.rst

Lines changed: 39 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -82,55 +82,67 @@ You may require to restart lightdm service to use GUI interface again.
8282
8383
sudo update-initramfs -u
8484
85-
Creating a Custom Theme
86-
=======================
8785
88-
1. Create a new directory under ``/usr/share/plymouth/themes/your-theme-name/``
89-
2. Add the following files:
9086
91-
- ``your-theme-name.plymouth``:
87+
Change Splash Screen
88+
====================
9289

93-
.. code-block:: ini
90+
Follow the steps below to change the system splash screen using Plymouth.
9491

95-
[Plymouth Theme]
96-
Name=Your Theme Name
97-
Description=Custom Splash
98-
ModuleName=script
92+
1. `Download the example theme <https://downloads.vicharak.in/vicharak-application/fedora-logo.zip>`_
9993

100-
[script]
101-
ImageDir=/usr/share/plymouth/themes/your-theme-name
102-
ScriptFile=/usr/share/plymouth/themes/your-theme-name/script.lua
94+
2. Extract the theme into the Plymouth themes directory and replace the logo
95+
with your own logo if required.
10396

104-
- ``script.lua`` (minimal example):
97+
.. code-block:: bash
98+
99+
unzip <theme>.zip -d /usr/share/plymouth/themes/
105100
106-
.. code-block:: lua
101+
3. Register the theme using the following command:
107102

108-
-- Simple splash screen
109-
image = Image("splash.png")
110-
screen_width, screen_height = Window.GetSize()
111-
image:Move((screen_width - image:GetWidth()) / 2, (screen_height - image:GetHeight()) / 2)
112-
image:Show()
103+
.. code-block:: bash
113104
114-
- ``splash.png``: Your custom splash image.
105+
sudo update-alternatives --install \
106+
/usr/share/plymouth/themes/default.plymouth default.plymouth \
107+
/usr/share/plymouth/themes/fedora-logo/fedora-logo.plymouth 100
115108
116-
3. Register custom theme:
109+
4. Select the default theme.
117110

118111
.. code-block:: bash
119112
120-
sudo update-alternatives --install /usr/share/plymouth/themes/default.plymouth default.plymouth /usr/share/plymouth/themes/your-theme-name/your-theme-name.plymouth 100
113+
sudo update-alternatives --config default.plymouth
121114
122-
4. To Set theme:
115+
Example output:
123116

124-
.. code-block:: bash
117+
.. code-block:: text
125118
126-
sudo update-alternatives --config default.plymouth
119+
There are 10 choices for the alternative default.plymouth
120+
(providing /usr/share/plymouth/themes/default.plymouth).
127121
128-
5. To apply in next boot, User need to update initramfs :
122+
Selection Path Priority Status
123+
-----------------------------------------------------------------------------------------------
124+
0 /usr/share/plymouth/themes/ubuntu-mate-logo/ubuntu-mate-logo-scale-2.plymouth 149 auto mode
125+
1 /usr/share/plymouth/themes/avi/theme.conf 100 manual mode
126+
2 /usr/share/plymouth/themes/bgrt/bgrt.plymouth 110 manual mode
127+
3 /usr/share/plymouth/themes/eos-bgrt/eos-bgrt.plymouth 100 manual mode
128+
* 4 /usr/share/plymouth/themes/fedora-logo/fedora-logo.plymouth 100 manual mode
129+
5 /usr/share/plymouth/themes/logo-mac-style/logo-mac-style.plymouth 100 manual mode
130+
6 /usr/share/plymouth/themes/spinner/spinner.plymouth 70 manual mode
131+
7 /usr/share/plymouth/themes/steamdeck/steamdeck.plymouth 100 manual mode
132+
8 /usr/share/plymouth/themes/test/test.plymouth 100 manual mode
133+
9 /usr/share/plymouth/themes/ubuntu-mate-logo/ubuntu-mate-logo-scale-2.plymouth 149 manual mode
134+
10 /usr/share/plymouth/themes/ubuntu-mate-logo/ubuntu-mate-logo.plymouth 100 manual mode
135+
136+
Select the corresponding number for the **Fedora theme**.
137+
138+
5. Apply the changes for every boot by updating the initramfs:
129139

130140
.. code-block:: bash
131141
132142
sudo update-initramfs -u
133143
144+
You can edit **fedora-logo.plymouth** according to use cases.
145+
134146
Debugging Plymouth Issues
135147
=========================
136148

0 commit comments

Comments
 (0)