Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
MrEliptik committed Sep 5, 2024
1 parent 8692c36 commit b5ad7df
Showing 1 changed file with 22 additions and 4 deletions.
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,19 +34,38 @@ You can also check the [**Fake**](games/Fake) folder to see a game example

A **config.ini** can be used to customize a game. Using the config file you can set extended information such as release date, platforms, and even a QR code.

See the example config.ini file in the [**Fake**](games/Fake/config_fake.ini) for a full list of properties.
See the example `config_fake.ini` file in the [**Fake**](games/Fake/config_fake.ini) folder for a full list of properties.

Note: If used, the "description" key will override the **description.txt**.

## Launcher configuration

The launcher itself is configured using [launcher_config.ini](launcher_config.ini).

- `shortcut_kill_game`: global shortcut used to kill a launched game. Requires [shortcut_listener.py](shortcut_listener.py) to be running. See [shortcut configuration](Shortcut configuration)
- `fullscreen`: true|false, start the launcher in fullscreen

### Shortcut configuration with Python

[shortcut_listener.py](shortcut_listener.py) is a script to listen to a specific shortcut to kill any active game started by the launcher. It communicates with the launcher using websockets (yes a bit overkill).

Requires python 3.10.x with the following package `asyncio, websockets, keyboard`

```
pip install asyncio, websockets, keyboard
```

The python script will be launched automatically by the app if you have a `shortcut_kill_game` set in [launcher_config.ini](launcher_config.ini).

## How to navigate

Navigate using keyboard or gamepad using the usual keys used for navigation (arrows keys, enter).

`alt+enter` to toggle fullscreen
`alt+enter` to toggle fullscreen of the launcher

## Limitations

Right now, the launcher is only working with windows. Supporting linux and mac shouldn't be complicated, we just need to detect the correct extensions or file types.
Right now, the launcher is only working with windows and linux. Supporting mac shouldn't be complicated but I don't have a mac nor experience with macOS. If you want to help, please see https://github.com/MrEliptik/game_launcher/issues/2.

## Development

Expand All @@ -60,7 +79,6 @@ Full time indie gamedev. You can find me everywhere 👇
- [YouTube - Gamedev](https://www.youtube.com/@MrEliptik)
- [YouTube - Godot related](https://www.youtube.com/@mrelipteach)
- [Twitter](https://twitter.com/mreliptik)
- [Instagram](https://www.instagram.com/mreliptik)
- [Itch.io](https://mreliptik.itch.io/)
- [All links](https://bento.me/mreliptik)

Expand Down

0 comments on commit b5ad7df

Please sign in to comment.