This python app is intended to be used as a game "library" or archiver, it will organize games in lists, those will be navigable using a gamepad. This app is only available for GNU/Linux distributions using Xorg as window server since it makes an intensive use of python Xlib.
To run this app you will need any GNU/Linux distribution using Xorg as a window server. Adittionally systemd is desirable too, since the installation script will install a couple of services to start the app from your gamepad at any time, those services can be found under the services folder.
For install this app please clone this repository:
git clone https://github.com/szz-dvl/GAL.git
cd GAL
And run the installation script:
./install.sh
This must suffice to start running the app. To uninstall the app please run the uninstallation script:
./uninstall.sh
For the application to be able to list your games you may configurate it a little bit. The configuration file, which must reside in the same directory of the source files must be named "confis.json", the file config.skel can be used as a skeleton to create one. This file contains examples to configure yours. However there are three main sections in this json:
Each object of this array will represent a list of games to be run with a particular emulator, here goes an example for Mupen64Plus:
{
"lid": "n64",
"source": "/home/me/n64/",
"ext": ".n64",
"title": "n64 ROM files:",
"class": "n64.N64_Emulator",
"emu": {
"panel": false,
"name": "Mupen64Plus",
"bin": "/usr/games/mupen64plus",
"opt": ["--fullscreen", "--resolution", "1680x1050", "--osd", "--set", "Video-Rice[MultiSampling]=2"]
},
"extra": {
"Super Mario 64": ["--set", "Video-Rice[MultiSampling]=1", "--gfx", "mupen64plus-video-rice"],
"Smash": ["--set", "Video-Rice[MultiSampling]=1", "--gfx", "mupen64plus-video-glide64mk2"],
"Majora's Mask": ["--set", "Video-Rice[MultiSampling]=1", "--gfx", "mupen64plus-video-glide64mk2"],
"Bad Fur Day": ["--set", "Video-Rice[MultiSampling]=1", "--gfx", "mupen64plus-video-rice"],
"Pokemon": ["--set", "Video-Rice[MultiSampling]=1", "--gfx", "mupen64plus-video-rice"],
"Paper Mario": ["--set", "Video-Rice[MultiSampling]=1", "--gfx", "mupen64plus-video-glide64mk2"]
}
}
This object holds the configuration for the gamepad, an example for Logitech F710 gamepad:
"pad": {
"path": "/dev/game_pad",
"keysx": {
"mtr_btn": 316,
"ud_arrows": 17,
"lr_arrows": 16,
"R1": 311,
"R2": 5,
"L1": 310,
"L2": 2,
"X": 304,
"Sqre": 307,
"Circ": 305,
"Tri": 308
},
"keysd": {
"mtr_btn": 313,
"ud_arrows": 17,
"lr_arrows": 16,
"R1": 309,
"R2": 311,
"L1": 308,
"L2": 310,
"X": 305,
"Sqre": 304,
"Circ": 306,
"Tri": 307
}
}
Those are mandatory parameters for the app, they will configurate the behaviour of the application in diferrent scenarios, more details at config.skel
If everything came up right when you press the mtr_btn of your gamepad the application must start a dedicated X session showing you the different game lists you configured above, just select a game and play it. By default there will be button combinations to change the next slot to be loaded (usefull for emulators) binded to the left / right arrow keys lr_arrows and to increse and decrese the volume binded to the up / down arrows of the gamepad ud_arrows. To trigger this functionalities the master button mtr_btn must be pressed. Additionally if one hold the four rear triggers (R1,R2,L1,L2) while master button is pressed the current session will be killed and the game lists will be again navigable.
Moreover, anyone willing to add some functionalities can easely implement extra button responses in a custom plugin, the file emulator.skel may be used as a skeleton file to create it, those will need to reside under the plugins directory and passed in the "class" field of the corresponding list in config file. If no plugin is available for a given game or emulator no extra button functionalities will be mapped.
Have fun!
Mail me if you want to lend a hand.
- Szz
This project is licensed under the Affero GPL license - see the LICENSE file for details
- Any one using this project