2 Commits

Author SHA1 Message Date
8d5a106ab3 docs: Update documentation 2026-05-26 16:02:43 +05:30
4e7c53d79f docs: Update README to remove video and add asset link
Removed video demo from README and added a link to GitHub assets.
2026-05-26 15:57:15 +05:30

View File

@@ -2,10 +2,7 @@
A fullscreen splash-screen wrapper for launching a game or app. It displays an image (or a fallback black screen), starts your executable, and closes when the process exits or loses focus after launch.
<video src="docs/assets/demo.mp4" controls loop muted playsinline style="max-width:100%;height:auto;">
Your browser does not support the video tag. View or download the video directly:
<a href="docs/assets/demo.mp4">docs/assets/demo.mp4</a>
</video>
https://github.com/user-attachments/assets/22da49b4-0f1f-4208-8d0b-9eeef14e35e5
## Features
@@ -44,6 +41,36 @@ sudo make install
DESTDIR=/some/staging/path make install
```
## Usage
```bash
gsplash <image_or_video_path> <game_executable> [game_arguments...]
```
Example:
```bash
gsplash assets/splash.jpg /path/to/game --fullscreen --profile=default
# Video splash (supported formats depend on ffmpeg build)
gsplash assets/splash.mp4 /path/to/game --fullscreen --profile=default
```
Gsplash allows you to configure how the image or video is displayed with 3 modes:
- `center` (default): letterbox
- `crop`: fill screen by cropping
- `stretch`: Distort to fill screen
You can set these by using the `-m` or `--mode` flag:
```bash
build/gsplash [--mode=stretch|center|crop] <background> <executable> [args...]
build/gsplash -m stretch|center|crop <background> <executable> [args...]
```
## Testing
Gsplash includes several testing utilities to ensure proper functionality without requiring a heavy game binary.
@@ -76,31 +103,3 @@ For manual testing, a `dummy_game` binary is built alongside `gsplash`. It mimic
./build/gsplash path/to/image.png ./build/dummy_game 10
```
## Usage
```bash
gsplash <image_or_video_path> <game_executable> [game_arguments...]
```
Example:
```bash
gsplash assets/splash.jpg /path/to/game --fullscreen --profile=default
# Video splash (supported formats depend on ffmpeg build)
gsplash assets/splash.mp4 /path/to/game --fullscreen --profile=default
```
Gsplash allows you to configure how the image or video is displayed with 3 modes:
- `center` (default): letterbox
- `crop`: fill screen by cropping
- `stretch`: Distort to fill screen
You can set these by using the `-m` or `--mode` flag:
```bash
build/gsplash [--mode=stretch|center|crop] <background> <executable> [args...]
build/gsplash -m stretch|center|crop <background> <executable> [args...]
```