Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Splash screen for linux modification #2557

Open
wants to merge 2 commits into
base: development
Choose a base branch
from
Open

Splash screen for linux modification #2557

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a26d4f0
Splash screen for linux modification
Fireronin May 14, 2024
85a4edc
updated documentation
Fireronin Jun 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions content/docs/user-guide/interactivity/user-interface/load-screens.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,17 @@ game_load_screen_bink_path="Videos\GameLoadingScreen.bk2"
game_load_screen_minimum_time=5
```

## Modifying a Splash Screen (Renderer Loading Screen) on Linux

A splash screen serves as a loading screen for the renderer. Typically, the renderer takes a few seconds to boot up, during which time even the game's loading screen cannot be displayed. To prevent an awkward black screen during this period, you can use the splash screen settings to display a static PNG image. Please note that transparency will not be respected and should be replaced with black.

It is required that `xdd` linux utility is installed for this feature to work.

To set a custom splash screen, place your logo in your project under `Resources/Splash.png`. Alternatively, set the `SPLASH_FILE` environment variable to the path of such a file. The only image requirement is that it must be an 8-Bit PNG. This image will be injected into the O3DE code during compilation, so a rebuild is necessary for the change to take effect.

For the best results, follow up this splash screen with a UI-based game loading screen, as it loads quickly. If you don't, you may still see a black screen during the period when Atom has started loading, taken control over the display, but has not yet begun to output the rendered scene.


## Defining a Level Loading Screen

To define a level loading screen, first do one of the following:
Expand Down
3 changes: 2 additions & 1 deletion content/docs/welcome-guide/requirements.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,7 @@ O3DE also requires some additional library packages to be installed:
* libxcb-xinput-dev
* libxcb-xfixes0-dev
* libxcb-xkb-dev
* libxcb-image0-dev
* libxkbcommon-dev
* libxkbcommon-x11-dev
* libfontconfig1-dev
Expand All @@ -231,7 +232,7 @@ O3DE also requires some additional library packages to be installed:
You can download and install these packages through `apt`.

```shell
sudo apt install libglu1-mesa-dev libxcb-xinerama0 libxcb-xinput0 libxcb-xinput-dev libxcb-xfixes0-dev libxcb-xkb-dev libxkbcommon-dev libxkbcommon-x11-dev libfontconfig1-dev libpcre2-16-0 zlib1g-dev mesa-common-dev libunwind-dev libzstd-dev
sudo apt install libglu1-mesa-dev libxcb-xinerama0 libxcb-xinput0 libxcb-xinput-dev libxcb-xfixes0-dev libxcb-xkb-dev libxkbcommon-dev libxkbcommon-x11-dev libfontconfig1-dev libpcre2-16-0 zlib1g-dev mesa-common-dev libunwind-dev libzstd-dev libxcb-image0-dev
```

### Ninja Build System (Optional)
Expand Down