2014-09-12 14:57:34 +00:00
|
|
|
******
|
2010-08-31 00:44:09 +00:00
|
|
|
Lutris
|
2014-09-12 14:57:34 +00:00
|
|
|
******
|
2010-08-31 00:44:09 +00:00
|
|
|
|
2018-07-12 00:05:48 +00:00
|
|
|
Lutris is an open source gaming platform for GNU/Linux.
|
|
|
|
It makes gaming on Linux easier by managing, installing and providing optimal
|
|
|
|
settings for games.
|
2010-01-22 18:38:20 +00:00
|
|
|
|
2018-07-12 00:05:48 +00:00
|
|
|
Lutris does not sell games; you have to provide your own copy of the games
|
|
|
|
unless they are open source or freeware.
|
|
|
|
Games can be installed anywhere on your system; Lutris does not impose
|
|
|
|
anything.
|
2014-09-12 14:57:34 +00:00
|
|
|
|
2018-07-12 00:05:48 +00:00
|
|
|
Lutris relies on various programs referenced as 'runners' to provide a vast
|
|
|
|
library of games.
|
|
|
|
These runners (with the exception of Steam and web browsers) are provided by
|
|
|
|
Lutris, you don't need to install them with your package manager.
|
2017-03-07 13:32:42 +00:00
|
|
|
|
2014-09-12 14:57:34 +00:00
|
|
|
We currently support the following runners:
|
|
|
|
|
|
|
|
* Linux (Native games)
|
|
|
|
* Steam
|
2017-03-07 13:32:42 +00:00
|
|
|
* Web
|
2014-09-12 14:57:34 +00:00
|
|
|
* Wine
|
|
|
|
* Wine + Steam
|
2016-09-29 03:34:06 +00:00
|
|
|
* Libretro
|
2017-03-07 13:32:42 +00:00
|
|
|
* DOSBox
|
|
|
|
* MAME
|
|
|
|
* MESS
|
2014-09-12 14:57:34 +00:00
|
|
|
* ScummVM
|
2015-09-30 04:29:31 +00:00
|
|
|
* ResidualVM
|
2017-03-07 13:32:42 +00:00
|
|
|
* Adventure Game Studio
|
2014-09-12 14:57:34 +00:00
|
|
|
* Mednafen
|
|
|
|
* FS-UAE
|
|
|
|
* Vice
|
|
|
|
* Stella
|
|
|
|
* Atari800
|
|
|
|
* Hatari
|
|
|
|
* Virtual Jaguar
|
2017-03-07 13:32:42 +00:00
|
|
|
* Snes9x
|
|
|
|
* Mupen64Plus
|
2015-11-10 21:51:23 +00:00
|
|
|
* Dolphin
|
2016-03-22 16:43:19 +00:00
|
|
|
* PCSX2
|
2017-03-07 13:32:42 +00:00
|
|
|
* PPSSPP
|
2014-09-12 14:57:34 +00:00
|
|
|
* Osmose
|
2015-11-10 21:51:23 +00:00
|
|
|
* Reicast
|
2014-09-12 14:57:34 +00:00
|
|
|
* Frotz
|
2017-03-07 13:32:42 +00:00
|
|
|
* jzIntv
|
|
|
|
* O2EM
|
2015-12-29 09:27:35 +00:00
|
|
|
* ZDoom
|
2017-03-07 13:32:42 +00:00
|
|
|
* Citra
|
|
|
|
* DeSmuME
|
|
|
|
* DGen
|
2014-09-12 14:57:34 +00:00
|
|
|
|
|
|
|
|
|
|
|
Installer scripts
|
|
|
|
=================
|
|
|
|
|
2018-07-12 00:05:48 +00:00
|
|
|
Lutris automates installation of games using configuration scripts written in
|
|
|
|
JSON or YAML, which list the various files needed to install a game and can
|
|
|
|
perform a series of actions on them.
|
|
|
|
The syntax of installers is described in ``docs/installers.rst``, and is also
|
|
|
|
available on `lutris.net <https://lutris.net>`_ when writing installers.
|
2014-09-12 14:57:34 +00:00
|
|
|
|
|
|
|
A web UI is planned to ease the creation of these scripts.
|
|
|
|
|
|
|
|
Game Library
|
|
|
|
============
|
|
|
|
|
2018-07-12 00:05:48 +00:00
|
|
|
You can optionally create an account on `lutris.net <https://lutris.net>`_ and
|
|
|
|
connect this account to the client.
|
|
|
|
This will allow you to sync your game library from the website to the client
|
|
|
|
(not the other way around).
|
|
|
|
If you wish, you can also sync your Steam library with your Lutris library on
|
|
|
|
the website.
|
2014-09-12 14:57:34 +00:00
|
|
|
|
2018-07-12 00:05:48 +00:00
|
|
|
The client does not store your `lutris.net <https://lutris.net>`_ credentials
|
|
|
|
on your computer.
|
2014-09-12 15:09:17 +00:00
|
|
|
Instead, when you authenticate, the website will send a token which will
|
2018-07-12 00:05:48 +00:00
|
|
|
be used to sync your library.
|
|
|
|
This token is stored in ``~/.cache/lutris/auth-token``.
|
2010-01-22 18:38:20 +00:00
|
|
|
|
|
|
|
Configuration files
|
2014-09-12 14:57:34 +00:00
|
|
|
===================
|
|
|
|
|
2018-07-12 00:05:48 +00:00
|
|
|
The client, runner, and game configuration files are stored in
|
|
|
|
``~/.config/lutris``.
|
|
|
|
There is no need to manually edit these files as everything should be done from
|
|
|
|
the client.
|
2014-09-12 14:57:34 +00:00
|
|
|
|
2018-07-12 00:05:48 +00:00
|
|
|
``lutris.conf``: preferences for the client's UI
|
2014-09-12 14:57:34 +00:00
|
|
|
|
2018-07-12 00:05:48 +00:00
|
|
|
``system.yml``: default configuration for every game
|
2014-09-12 14:57:34 +00:00
|
|
|
|
2018-07-12 00:05:48 +00:00
|
|
|
``runners/*.yml``: runner-specific default configurations
|
2014-09-12 14:57:34 +00:00
|
|
|
|
2018-07-12 00:05:48 +00:00
|
|
|
``games/*.yml``: game-specific configurations
|
2014-09-12 14:57:34 +00:00
|
|
|
|
|
|
|
The game configuration can override previously defined runner and system
|
|
|
|
configuration and runner configuration can override system configuration.
|
|
|
|
|
2018-07-12 00:05:48 +00:00
|
|
|
Runners and the game database
|
2014-09-12 14:57:34 +00:00
|
|
|
=========================
|
|
|
|
|
|
|
|
The data necessary to manage your library and run the game is stored in
|
2018-07-12 00:05:48 +00:00
|
|
|
``~/.local/share/lutris``.
|
2014-09-12 14:57:34 +00:00
|
|
|
|
2018-07-12 00:05:48 +00:00
|
|
|
``pga.db``: your game library, game installation status, locations on the
|
|
|
|
filesystem, and some additional metadata, all stored in an SQLite
|
|
|
|
database
|
2014-09-12 14:57:34 +00:00
|
|
|
|
2018-07-12 00:05:48 +00:00
|
|
|
``runners/*``: runners downloaded from `lutris.net <https://lutris.net>`_
|
2010-01-22 18:38:20 +00:00
|
|
|
|
2018-07-12 00:05:48 +00:00
|
|
|
``icons/*.png`` and ``banners/*.jpg``: game images
|
2010-01-22 18:38:20 +00:00
|
|
|
|
2014-09-12 14:57:34 +00:00
|
|
|
Command line options
|
|
|
|
====================
|
2010-01-22 18:38:20 +00:00
|
|
|
|
2014-09-12 14:57:34 +00:00
|
|
|
The following command line arguments are available::
|
2010-01-22 18:38:20 +00:00
|
|
|
|
2014-09-12 14:57:34 +00:00
|
|
|
--version show program's version number and exit
|
|
|
|
-h, --help show this help message and exit
|
|
|
|
-v, --verbose Verbose output
|
|
|
|
-d, --debug Show debug messages
|
|
|
|
-i INSTALLER_FILE, --install=INSTALLER_FILE
|
|
|
|
Install a game from a yml file
|
|
|
|
-l, --list-games List all games in database
|
2016-09-29 03:21:05 +00:00
|
|
|
-o, --installed Only list installed games
|
|
|
|
-j, --json Display the list of games in JSON format
|
|
|
|
--list-steam-games List available Steam games
|
|
|
|
--list-steam-folders List all known Steam library folders
|
2014-09-12 14:57:34 +00:00
|
|
|
--reinstall Reinstall game
|
2010-01-22 18:38:20 +00:00
|
|
|
|
2017-03-07 13:32:42 +00:00
|
|
|
Additionally, you can pass a ``lutris:`` protocol link followed by a game
|
2014-09-12 15:00:03 +00:00
|
|
|
identifier on the command line such as::
|
2014-11-11 15:00:43 +00:00
|
|
|
|
2014-09-12 15:00:03 +00:00
|
|
|
lutris lutris:quake
|
|
|
|
|
|
|
|
This will install the game if not already installed or launch the game
|
2017-03-07 13:32:42 +00:00
|
|
|
otherwise (unless the ``--reinstall`` flag is passed).
|
2010-01-22 18:38:20 +00:00
|
|
|
|
2014-09-12 15:50:13 +00:00
|
|
|
Planned features
|
|
|
|
================
|
|
|
|
|
2018-07-12 00:05:48 +00:00
|
|
|
Lutris is far from complete and some of the more interesting features have yet
|
|
|
|
to be implemented.
|
2014-09-12 15:50:13 +00:00
|
|
|
|
2018-07-12 00:05:48 +00:00
|
|
|
Here's what to expect from the future versions of Lutris:
|
2014-09-12 15:50:13 +00:00
|
|
|
|
2014-09-12 15:07:54 +00:00
|
|
|
* Integration with GOG and Humble Bundle
|
2017-09-16 19:35:29 +00:00
|
|
|
* Integration with the TOSEC database
|
2014-09-12 15:50:13 +00:00
|
|
|
* Management of Personnal Game Archives (let you store your games files on
|
|
|
|
private storage, allowing you to reinstall them on all your devices)
|
|
|
|
* Game saves sync
|
|
|
|
* Community features (friends list, chat, multiplayer game scheduling)
|
2017-05-30 02:59:57 +00:00
|
|
|
* Controller configuration GUI (with xboxdrv support)
|
2014-09-12 15:50:13 +00:00
|
|
|
|
|
|
|
Come with us!
|
|
|
|
=============
|
|
|
|
|
2018-07-12 00:05:48 +00:00
|
|
|
Want to make Lutris better? Help implement features, fix bugs, test
|
|
|
|
pre-releases, or simply chat with the developers?
|
2014-09-12 15:50:13 +00:00
|
|
|
|
|
|
|
You can always reach us on:
|
2015-03-03 16:31:48 +00:00
|
|
|
|
2014-09-12 15:50:13 +00:00
|
|
|
* IRC: #lutris on the Freenode servers
|
2017-09-16 19:35:29 +00:00
|
|
|
* Github: https://github.com/lutris
|
2014-09-12 15:50:13 +00:00
|
|
|
* Twitter: https://twitter.com/LutrisGaming
|
|
|
|
* Google+: https://plus.google.com/+LutrisNet
|
|
|
|
* Email: contact@lutris.net
|