Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New User's Guide to Lutris #84

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

metalllinux
Copy link

I have written up a new user's guide for Lutris, aimed at new users to gaming on Linux whom wish to use Lutris. It would be greatly appreciated if this was accepted into the project.

If there are any issues with spelling, syntax or technical misinformation, please do not hesitate to let me know and I will correct it accordingly.

Thank you so much for all the amazing work you do for the Linux ecosystem and gaming as a whole.

I have written up a new user's guide for Lutris, aimed at new users to gaming on Linux. It would be greatly appreciated if this was accepted into the project.

If there are any issues with spelling, syntax or technical misinformation, please do not hesitate to let me know and I will correct it accordingly.

Thank you so much for all the amazing work you do for Linux and gaming in general.

In Lutris, there are many ways to install games from your game collections.

### Manual Game Installation
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We discourage manual installation so this section shouldn't in a guide for new users.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I have removed the Manual Game Installation section and placed the explanation for System options under Global options

Suggested change
### Manual Game Installation
**Global options**
These settings are global and affect all the games in your library. However, you can change each setting on a game by game basis if you so prefer.
- **Default installation folder** – the default place where you install your games.
- **Disable Lutris Runtime** – Off by default. If switched on, Lutris will load some libraries that can cause incompatibilities with some games.
- **Prefer system libraries** – enabled by default and utilises the libraries that come with your system as opposed to the ones that Lutris provides.
- **Restore resolution on game exit** – Disabled by default, but can be enabled if some games are not automatically restoring your native desktop resolution after exiting the game.
- **Disable screen saver** – Enabled by default, so your system’s screen saver doesn’t interfere with the currently running game.
- **FPS counter (MangoHud)** – if you have [MangoHud](https://github.com/flightlessmango/MangoHud) installed to check your game’s FPS and more, set this option to Enabled with either Vulkan or OpenGL (depending on what Graphics API the game is using).
- **Enable Feral GameMode** – if you have [Feral Interactive’s GameMode](https://github.com/FeralInteractive/gamemode) installed to optimise your system for games, this option by default will be enabled. If GameMode is not installed, the option will be greyed out.
- **Enabled NVIDIA Prime Render Offload** – if you have the [latest NVIDIA drivers installed with a patched X.Org server](https://download.nvidia.com/XFree86/Linux-x86_64/470.63.01/README/primerenderoffload.html), a specific game can be ran on your Nvidia GPU, then return to your system’s power-saving Intel GPU once the game is closed. This is a great option if configured correctly for laptops with Nvidia Optimus.
- **Switch resolution to** – before a game starts, Lutris can change your desktop resolution to something that fits the game better. By default, Lutris runs the game at your native desktop resolution.
- **Environment variables** - enabling specific adjustments to things like translation layers such as DXVK can be applied here. For example, in the **Key** column, you can add ```DXVK_HUD``` and in the **Value** column, you can place ```frametimes``` to display a frametime graph in games that use DXVK.


Welcome to Lutris, [a game library manager](https://github.com/lutris/lutris) that allows you to bring your entire game collection together regardless of platform.

This is a guide for new users that are just starting out with Lutris. Once you have [installed the Lutris client](https://lutris.net/downloads) for your distribution, [updated your Nvidia and AMD/Intel drivers](https://github.com/lutris/docs/blob/master/InstallingDrivers.md) and have a [recent version of WINE](https://wiki.winehq.org/Download), you’ll be ready to go on your Lutris journey.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We don't require a Wine version installed, it just so happens that installing Wine is the easiest way to pull in all dependencies. And it should link to https://github.com/lutris/docs/blob/master/WineDependencies.md.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for looking through my guide and for your comments. Here is the correction I have included:

Suggested change
This is a guide for new users that are just starting out with Lutris. Once you have [installed the Lutris client](https://lutris.net/downloads) for your distribution, [updated your Nvidia and AMD/Intel drivers](https://github.com/lutris/docs/blob/master/InstallingDrivers.md) and have a [recent version of WINE](https://wiki.winehq.org/Download), you’ll be ready to go on your Lutris journey.
This is a guide for new users that are just starting out with Lutris. Once you have [installed the Lutris client](https://lutris.net/downloads) for your distribution, [updated your Nvidia and AMD/Intel drivers](https://github.com/lutris/docs/blob/master/InstallingDrivers.md) and and while not a requirement, it is recommended to have a [recent version of WINE](https://github.com/lutris/docs/blob/master/WineDependencies.md) to pull in all the required dependencies. After that, you’ll be ready to go on your Lutris journey.


Installing games from a Source is usually straightforward with Lutris.

1. Connect or sign in to a Source (be it GOG, Steam, Humble Bundle and so forth).
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not all sources require signing in. Lutris source doesn't for example.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I have edited this section and removed the part about signing in to stop confusion:

Suggested change
1. Connect or sign in to a Source (be it GOG, Steam, Humble Bundle and so forth).
## Installing a Game
In Lutris, there are many ways to install games from your game collections. For this guide, it will only concentrate on installing a game from a Source.
### Installation of a Game from a Source
Installing games from a Source is usually straightforward with Lutris.
1. Select the game you wish to install. Lutris will then open a dialogue box and offer you some options for installation (downloading the base game, additional audio files, mods and the like). Depending on the Source used, the options presented will vary.
2. Once you click install, Lutris will handle the rest for you. For example. this includes downloading and running the installer for GOG games (with any associated community written installers for additional configuration) or for a Steam game, opening your Steam client, downloading the game and closing the client when it is done.


Right-clicking on any installed game in Lutris, provides the user with these options:
- **Play** – runs the game.
- **Show Logs** - opens a separate window and is useful for finding out why particular games are not running.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, it won't output anything useful unless you enable logging. I would describe it as "useful for debugging purposes".

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I have changed the line to this:

Suggested change
- **Show Logs** - opens a separate window and is useful for finding out why particular games are not running.
- **Show Logs** - opens a separate window and is useful for debugging purposes.


Clicking **Favorites** shows you every game you have selected as your favourites, either via right-clicking the game in your library and selecting “Add to favorites” or the drop-down menu next to the game’s “Play” button at the bottom of the client and then selecting “Add to favorites”.

## Sources
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sources were mentioned before, I think it would be nice to only have them mentioned once in the guide.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I have moved the section discussing the Sources to the top of the file. Now, under Installing a Game, the next section down is Configuring your Sources and the next one down after that is Installation of a Game from a Source

Suggested change
## Sources
## Installing a Game
In Lutris, there are many ways to install games from your game collections. For this guide, it will only concentrate on installing a game from a Source.
### Configuring your Sources
Under **Sources** on the left-hand side of the client, you’ll find a list of all the Sources you currently have enabled. Clicking one shows all the games that are available from that particular Source.
**Lutris Source**
The **Lutris** source displays all of the games you have registered in your [Lutris.net](https://lutris.net/) library and allows you to search for any community installers that are available for a particular game. Both of these options are placed in tabs at the top of the client after selecting the source.
**Local Source**
The **Local** source displays all of your native Linux games.
**GOG Source**
The **GOG** source lists every game in your [GOG](https://www.gog.com/) library.
**Humble Bundle Source**
The **Humble Bundle** source shows all the games in your [Humble Bundle](https://www.humblebundle.com/) library.
**Epic Games Store Source**
The **Epic Games Store** source will display every game in your [Epic Games Store](https://www.epicgames.com/store/en-US/) library.
**Note – for GOG, Humble Bundle and the Epic Games Store, you have to log into the appropriate source via the connect button that appears after hovering over the source itself, otherwise none of the games linked with the associated source are displayed.**
**Steam**
Once you have the native Linux Steam client installed on your distribution and logged in successfully, all of your Steam games (regardless of platform), will appear here.
**Steam for Windows Source**
The Steam for Windows source lists every Steam game available in your library, run via the Wine Steam Runner. This option is available, in case you do not wish to use the native Linux Steam client with Proton.
**The Lutris team [has said](https://twitter.com/LutrisGaming/status/1454539182647377920) that integration for Steam for Windows will be removed, whilst leaving the Wine Steam Runner for those who still wish to use it.**
### Installation of a Game from a Source
Installing games from a Source is usually straightforward with Lutris.
1. Select a Source, then the game you wish to play and click "Install" at the bottom of the client.
2. Lutris will then open a dialogue box and offer you some options for installation (downloading the base game, additional audio files, mods and much more). Depending on the Source used, the options presented will vary.
3. Once you click the "Install" button in the dialogue box, Lutris will handle the rest for you. For example. this includes downloading and running the installer for GOG games (with any associated community written installers for additional configuration) or for a Steam game, opening your Steam client, downloading the game and closing the client when the installation is done.

@metalllinux
Copy link
Author

Under Interface, I had not written a description for:

  • Hide text under icons (requires a restart)
    If you would be so kind, would you be able to explain what this option does? I have tested it on my own client and researched online, but couldn't find out what exactly this feature does.
    Many thanks for al of your comments so far.

- Removed the Manual Game Installation section and placed the explanation for System options under Global options
- Corrected the section about Wine being a required for installation.
- Removed the part that was misleading about all Sources required to be signed in.
- Changed the section about Logging to "debugging purposes".
- Moved the section about Sources to the top of the file and under Installing a Game, the next section down is Configuring your Sources and the next one down after that is Installation of a Game from a Source.
- Various changes to grammar.
@metalllinux
Copy link
Author

I have also added various changes to the grammar.

Copy link
Author

@metalllinux metalllinux left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the document with all changes as requested. Thank you for the comments.


Welcome to Lutris, [a game library manager](https://github.com/lutris/lutris) that allows you to bring your entire game collection together regardless of platform.

This is a guide for new users that are just starting out with Lutris. Once you have [installed the Lutris client](https://lutris.net/downloads) for your distribution, [updated your Nvidia and AMD/Intel drivers](https://github.com/lutris/docs/blob/master/InstallingDrivers.md) and have a [recent version of WINE](https://wiki.winehq.org/Download), you’ll be ready to go on your Lutris journey.
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for looking through my guide and for your comments. Here is the correction I have included:

Suggested change
This is a guide for new users that are just starting out with Lutris. Once you have [installed the Lutris client](https://lutris.net/downloads) for your distribution, [updated your Nvidia and AMD/Intel drivers](https://github.com/lutris/docs/blob/master/InstallingDrivers.md) and have a [recent version of WINE](https://wiki.winehq.org/Download), you’ll be ready to go on your Lutris journey.
This is a guide for new users that are just starting out with Lutris. Once you have [installed the Lutris client](https://lutris.net/downloads) for your distribution, [updated your Nvidia and AMD/Intel drivers](https://github.com/lutris/docs/blob/master/InstallingDrivers.md) and and while not a requirement, it is recommended to have a [recent version of WINE](https://github.com/lutris/docs/blob/master/WineDependencies.md) to pull in all the required dependencies. After that, you’ll be ready to go on your Lutris journey.


In Lutris, there are many ways to install games from your game collections.

### Manual Game Installation
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I have removed the Manual Game Installation section and placed the explanation for System options under Global options

Suggested change
### Manual Game Installation
**Global options**
These settings are global and affect all the games in your library. However, you can change each setting on a game by game basis if you so prefer.
- **Default installation folder** – the default place where you install your games.
- **Disable Lutris Runtime** – Off by default. If switched on, Lutris will load some libraries that can cause incompatibilities with some games.
- **Prefer system libraries** – enabled by default and utilises the libraries that come with your system as opposed to the ones that Lutris provides.
- **Restore resolution on game exit** – Disabled by default, but can be enabled if some games are not automatically restoring your native desktop resolution after exiting the game.
- **Disable screen saver** – Enabled by default, so your system’s screen saver doesn’t interfere with the currently running game.
- **FPS counter (MangoHud)** – if you have [MangoHud](https://github.com/flightlessmango/MangoHud) installed to check your game’s FPS and more, set this option to Enabled with either Vulkan or OpenGL (depending on what Graphics API the game is using).
- **Enable Feral GameMode** – if you have [Feral Interactive’s GameMode](https://github.com/FeralInteractive/gamemode) installed to optimise your system for games, this option by default will be enabled. If GameMode is not installed, the option will be greyed out.
- **Enabled NVIDIA Prime Render Offload** – if you have the [latest NVIDIA drivers installed with a patched X.Org server](https://download.nvidia.com/XFree86/Linux-x86_64/470.63.01/README/primerenderoffload.html), a specific game can be ran on your Nvidia GPU, then return to your system’s power-saving Intel GPU once the game is closed. This is a great option if configured correctly for laptops with Nvidia Optimus.
- **Switch resolution to** – before a game starts, Lutris can change your desktop resolution to something that fits the game better. By default, Lutris runs the game at your native desktop resolution.
- **Environment variables** - enabling specific adjustments to things like translation layers such as DXVK can be applied here. For example, in the **Key** column, you can add ```DXVK_HUD``` and in the **Value** column, you can place ```frametimes``` to display a frametime graph in games that use DXVK.


Installing games from a Source is usually straightforward with Lutris.

1. Connect or sign in to a Source (be it GOG, Steam, Humble Bundle and so forth).
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I have edited this section and removed the part about signing in to stop confusion:

Suggested change
1. Connect or sign in to a Source (be it GOG, Steam, Humble Bundle and so forth).
## Installing a Game
In Lutris, there are many ways to install games from your game collections. For this guide, it will only concentrate on installing a game from a Source.
### Installation of a Game from a Source
Installing games from a Source is usually straightforward with Lutris.
1. Select the game you wish to install. Lutris will then open a dialogue box and offer you some options for installation (downloading the base game, additional audio files, mods and the like). Depending on the Source used, the options presented will vary.
2. Once you click install, Lutris will handle the rest for you. For example. this includes downloading and running the installer for GOG games (with any associated community written installers for additional configuration) or for a Steam game, opening your Steam client, downloading the game and closing the client when it is done.


Right-clicking on any installed game in Lutris, provides the user with these options:
- **Play** – runs the game.
- **Show Logs** - opens a separate window and is useful for finding out why particular games are not running.
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I have changed the line to this:

Suggested change
- **Show Logs** - opens a separate window and is useful for finding out why particular games are not running.
- **Show Logs** - opens a separate window and is useful for debugging purposes.


Clicking **Favorites** shows you every game you have selected as your favourites, either via right-clicking the game in your library and selecting “Add to favorites” or the drop-down menu next to the game’s “Play” button at the bottom of the client and then selecting “Add to favorites”.

## Sources
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay, I have moved the section discussing the Sources to the top of the file. Now, under Installing a Game, the next section down is Configuring your Sources and the next one down after that is Installation of a Game from a Source

Suggested change
## Sources
## Installing a Game
In Lutris, there are many ways to install games from your game collections. For this guide, it will only concentrate on installing a game from a Source.
### Configuring your Sources
Under **Sources** on the left-hand side of the client, you’ll find a list of all the Sources you currently have enabled. Clicking one shows all the games that are available from that particular Source.
**Lutris Source**
The **Lutris** source displays all of the games you have registered in your [Lutris.net](https://lutris.net/) library and allows you to search for any community installers that are available for a particular game. Both of these options are placed in tabs at the top of the client after selecting the source.
**Local Source**
The **Local** source displays all of your native Linux games.
**GOG Source**
The **GOG** source lists every game in your [GOG](https://www.gog.com/) library.
**Humble Bundle Source**
The **Humble Bundle** source shows all the games in your [Humble Bundle](https://www.humblebundle.com/) library.
**Epic Games Store Source**
The **Epic Games Store** source will display every game in your [Epic Games Store](https://www.epicgames.com/store/en-US/) library.
**Note – for GOG, Humble Bundle and the Epic Games Store, you have to log into the appropriate source via the connect button that appears after hovering over the source itself, otherwise none of the games linked with the associated source are displayed.**
**Steam**
Once you have the native Linux Steam client installed on your distribution and logged in successfully, all of your Steam games (regardless of platform), will appear here.
**Steam for Windows Source**
The Steam for Windows source lists every Steam game available in your library, run via the Wine Steam Runner. This option is available, in case you do not wish to use the native Linux Steam client with Proton.
**The Lutris team [has said](https://twitter.com/LutrisGaming/status/1454539182647377920) that integration for Steam for Windows will be removed, whilst leaving the Wine Steam Runner for those who still wish to use it.**
### Installation of a Game from a Source
Installing games from a Source is usually straightforward with Lutris.
1. Select a Source, then the game you wish to play and click "Install" at the bottom of the client.
2. Lutris will then open a dialogue box and offer you some options for installation (downloading the base game, additional audio files, mods and much more). Depending on the Source used, the options presented will vary.
3. Once you click the "Install" button in the dialogue box, Lutris will handle the rest for you. For example. this includes downloading and running the installer for GOG games (with any associated community written installers for additional configuration) or for a Steam game, opening your Steam client, downloading the game and closing the client when the installation is done.

@metalllinux
Copy link
Author

@tannisroot a Happy New Year to you. Just to politely ask, this pull request has been open for some time, are there still plans to merge this user guide into the project? Many thanks as always.

@mmvanheusden
Copy link
Contributor

LGTM i hope this gets merged soon as it looks very helpful for beginners!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants