No description
Find a file
2021-06-25 16:37:00 -07:00
.github Update issue templates 2021-02-08 08:55:58 -08:00
bin Remove bullshit log message 2021-01-22 21:54:52 -08:00
debian Change project statement 2021-03-22 15:21:50 -07:00
docs Remove custom-name directive from script 2021-04-13 22:05:41 -07:00
lutris Remove experimental label from Dolphin service 2021-06-25 16:37:00 -07:00
po i18n: update readme and POTFILES readability 2021-04-26 23:01:43 -07:00
share Include runner configuration inside main settings window 2021-04-26 20:49:57 -07:00
snap Snap progress 2020-05-16 09:44:06 -07:00
tests Fix tests 2021-04-26 22:42:38 -07:00
utils Add prototype script for wine prefix cleanup 2021-05-24 18:24:06 -07:00
.agignore Add .agignore file 2016-09-28 23:31:27 -07:00
.editorconfig Increased max line length to 120 2020-04-27 19:52:01 +03:00
.flake8 Add game.py to exclude because travis ignores C901 exception 2020-04-27 19:52:01 +03:00
.gitignore Add config option to use long platform names 2020-10-07 21:10:29 -07:00
.isort.cfg Remove min-similarity-lines 2020-10-04 13:10:00 -07:00
.pylintrc Fix pylint warnings 2021-01-22 22:11:16 -08:00
.travis.yml Try with system_site_packages set to false 2021-02-15 19:51:19 -08:00
.yapf Minor update to configs 2020-04-27 19:52:01 +03:00
AUTHORS Update to current year again 2020-04-13 09:39:54 -07:00
CONTRIBUTING.md Change stance regarding PRs 2021-03-22 15:26:48 -07:00
INSTALL.rst Fix a typo, remove missing directories, and add lutris/database to the list of installed directories (#4) 2020-10-03 17:51:48 -07:00
LICENSE Fix typo in file name: LICENCE → LICENSE. 2016-11-18 13:49:57 +01:00
lutris.spec More wording changes 2021-03-22 16:38:23 -07:00
Makefile Cleanup 2021-04-25 16:15:08 -07:00
MANIFEST.in Fix a typo, remove missing directories, and add lutris/database to the list of installed directories (#4) 2020-10-03 17:51:48 -07:00
meson.build po: make meta files translatable 2020-11-05 01:44:06 -08:00
optional_settings.py.in i18n: find locale dir from the optional configuration file generated by meson 2020-06-18 19:11:32 -07:00
Pipfile Fix pylint warnings 2021-01-22 22:11:16 -08:00
Pipfile.lock Fix pylint warnings 2021-01-22 22:11:16 -08:00
README.rst Switch IRC to Libera chat 2021-05-31 14:45:03 -07:00
requirements-dev.txt update lockfile and generate new requirements from it 2020-10-16 07:17:44 -07:00
requirements.txt update lockfile and generate new requirements from it 2020-10-16 07:17:44 -07:00
setup.py Add scanners package 2021-05-10 23:16:15 -07:00

******
Lutris
******

|LiberaPayBadge|_

Lutris helps you install and play video games from all eras and from most
gaming systems. By leveraging and combining existing emulators, engine
re-implementations and compatibility layers, it gives you a central interface
to launch all your games.

The client can connect with existing services like Humble Bundle, GOG and Steam
to make your game libraries easily available. Game downloads and installations
are automated and can be modified through user made scripts.

Running Lutris
==============

If you have not installed Lutris through your package manager and are using the
source package, it is recommended that you install lutris at least once, even an
older version to have all dependencies available.
Once all dependencies are satisfied, you can run lutris directly from the source
directory with `./bin/lutris`

If you need to run lutris through gdb to troubleshoot segmentation faults, you
can use the following command:

`gdb -ex r --args "/usr/bin/python3" "./bin/lutris"`

Installer scripts
=================

Lutris installations are fully automated through scripts, which can be written
in either JSON or YAML.
The scripting syntax is described in ``docs/installers.rst``, and is also
available online at `lutris.net <https://lutris.net>`_.

Game library
============

Optional accounts can be created at `lutris.net
<https://lutris.net>`_ and linked with Lutris clients.
This enables your client to automatically sync fetch library from the website.
**It is currently not possible to sync from the client to the cloud.**
Via the website, it is also possible to sync your Steam library to your Lutris
library.

The Lutris client only stores a token when connected with the website, and your
login credentials are never saved.
This token is stored in ``~/.cache/lutris/auth-token``.

Configuration files
===================

* ``~/.config/lutris``: The client, runners, and game configuration files

   There is be no need to manually edit these files as everything should be done from the client.

* ``lutris.conf``: Preferences for the client's UI

* ``system.yml``: Default game configuration, which applies to every game

* ``runners/*.yml``: Runner-specific configurations

* ``games/*.yml``: Game-specific configurations

Game-specific configurations overwrite runner-specific configurations, which in
turn overwrite the system configuration.

Runners and the game database
=============================

``~/.local/share/lutris``: All data necessary to manage Lutris' library and games, including:

* ``pga.db``: An SQLite database tracking the game library, game installation status, various file locations, and some additional metadata

* ``runners/*``: Runners downloaded from `lutris.net <https://lutris.net>`

* ``banners/*.jpg``: Game banners

``~/.local/share/icons/hicolor/128x128/apps/lutris_*.png``: Game icons

Command line options
====================

The following command line arguments are available::

-v, --version              Print the version of Lutris and exit
-d, --debug                Show debug messages
-i, --install              Install a game from a yml file
-b, --output-script        Generate a bash script to run a game without the client
-e, --exec                 Execute a program with the lutris runtime
-l, --list-games           List all games in database
-o, --installed            Only list installed games
-s, --list-steam-games     List available Steam games
--list-steam-folders       List all known Steam library folders
-j, --json                 Display the list of games in JSON format
--reinstall                Reinstall game
--display=DISPLAY          X display to use

Additionally, you can pass a ``lutris:`` protocol link followed by a game
identifier on the command line such as::

    lutris lutris:quake

This will install the game if it is not already installed, otherwise it will
launch the game. The game will always be installed if the ``--reinstall`` flag is passed.

Planned features
================

Lutris is far from complete, and some features have yet
to be implemented.

Here's what to expect from future versions of Lutris:

* TOSEC database integration
* Management of personal game data (i.e. syncing games across devices using private cloud storage)
* Community features (friends list, chat, multiplayer game scheduling, etc.)

Support the project
===================

Lutris is 100% community supported, to ensure a continuous development on the
project, please consider donating to the project.
Our main platform for supporting Lutris is Patreon: https://www.patreon.com/lutris
but there are also other options available at https://lutris.net/donate

Come with us!
=============

Want to make Lutris better? Help implement features, fix bugs, test
pre-releases, or simply chat with the developers?

You can always reach us on:

* Discord: https://discordapp.com/invite/Pnt5CuY
* IRC: ircs://irc.libera.chat:6697/lutris
* Github: https://github.com/lutris
* Twitter: https://twitter.com/LutrisGaming


.. |LiberaPayBadge| image:: http://img.shields.io/liberapay/receives/Lutris.svg?logo=liberapay
.. _LiberaPayBadge: https://liberapay.com/Lutris/