Skip to content

dkosmari/SplashscreenModule

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CI-Release

SplashscreenModule

This module is supposed to be loaded with the EnvironmentLoader. It will render a "splash screen" from the sd card while other modules of the environment are loading.

Usage

  1. Place the 01_splashscreen.rpx in the [ENVIRONMENT]/modules/setup folder.
  2. Place your splash images (PNG, JPEG, TGA or WEBP) in the folder SD:/wiiu/splashes/.

Notes:

  • [ENVIRONMENT] is the directory of the environment, for Aroma with would be SD:/wiiu/enviroments/aroma.
  • When using a TGA image, make sure its 24 bit and uncompressed,
  • In theory any (reasonable) resolution is supported, 1280x720 is recommended for best quality on both gamepad and TV screens.

Path priority

The module will attempt to load a splash image from multiple places, in this order:

  1. [ENVIRONMENT]/: an image named splash.EXT
  2. [ENVIRONMENT]/splashes/: a random image in that folder.
  3. SD:/wiiu/: an image named splash.EXT
  4. SD:/wiiu/splashes/: a random image in that folder.

Where EXT can be png, jpg, jpeg, tga or webp.

Buildflags

Logging

Building via make only logs errors (via OSReport). To enable logging via the LoggingModule set DEBUG to 1 or VERBOSE.

  • make Logs errors only (via OSReport).
  • make DEBUG=1 Enables information and error logging via LoggingModule.
  • make DEBUG=VERBOSE Enables verbose information and error logging via LoggingModule.

If the LoggingModule is not present, it'll fall back to UDP (Port 4405) and CafeOS logging.

Building

For building, you need to install (via devkitPro's pacman):

  • wut
  • ppc-libjpeg-turbo
  • ppc-libpng
  • ppc-libwebp

Then use the make command.

Building using the Dockerfile

It's possible to use a docker image for building. This way you don't need anything installed on your host system.

# Build docker image (only needed once)
docker build . -t splashscreenmodule-builder

# make 
docker run -it --rm -v ${PWD}:/project splashscreenmodule-builder make

# make clean
docker run -it --rm -v ${PWD}:/project splashscreenmodule-builder make clean

Format the code via docker

docker run --rm -v ${PWD}:/src ghcr.io/wiiu-env/clang-format:13.0.0-2 -r ./source -i

Credits

  • Maschell
  • Crementif

About

Fork of Aroma splash screen module, with experimental features.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages

  • C++ 66.6%
  • C 25.8%
  • Makefile 6.9%
  • Other 0.7%