Skip to content

Latest commit

 

History

History
157 lines (104 loc) · 9.88 KB

README.md

File metadata and controls

157 lines (104 loc) · 9.88 KB
Raw

steam-lancache-prefill

view - Documentation ko-fi

GitHub all releases dockerhub

Automatically fills a Lancache with games from Steam, so that subsequent downloads for the same content will be served from the Lancache, improving speeds and reducing load on your internet connection.

Overview

Features

  • Selecting which apps to prefill can be done through an interactive menu.
  • Supports login with Steam Guard, and Steam Guard Mobile Authenticator
  • No installation required! A completely self-contained, portable application.
  • Multi-platform support (Windows, Linux, MacOS, Arm64, Docker, Unraid)
  • High-performance! Downloads are significantly faster than using Steam. Downloads can scale all the way up to 100gbit/s!
  • Game downloads write no data to disk, so there is no need to have enough free space available. This also means no unnecessary wear-and-tear to SSDs!
  • Includes a built in benchmark feature for diagnosing performance bottlenecks!

Table of contents

Installation

SteamPrefill is flexible and portable, and supports multiple platforms and configurations. It can be run on directly on the Lancache server itself, or on your gaming machine as an alternative Steam client. You should decide which one works better for your use case.

Detailed setup guides are available for the following platforms:

Linux   Docker   unRAID   Windows

Getting Started

Selecting what to prefill

Warning

This guide was written with Linux in mind. If you are running SteamPrefill on Windows you will need to substitute ./SteamPrefill with .\SteamPrefill.exe instead.

Prior to prefilling for the first time, you will have to decide which apps should be prefilled. This will be done using an interactive menu, for selecting what to prefill from all of your currently owned apps. To display the interactive menu, run the following command

./SteamPrefill select-apps

Once logged into Steam, all of your currently owned apps will be displayed for selection. Navigating using the arrow keys, select any apps that you are interested in prefilling with space. Once you are satisfied with your selections, save them with enter.

Interactive app selection

These selections will be saved permanently, and can be freely updated at any time by simply rerunning select-apps again at any time.

Initial prefill

Now that a prefill app list has been created, we can now move onto our initial prefill run by using

./SteamPrefill prefill

The prefill command will automatically pickup the prefill app list, and begin downloading each app. During the initial run, it is likely that the Lancache is empty, so download speeds should be expected to be around your internet line speed (in the below example, a 300mbit/s connection was used). Once the prefill has completed, the Lancache should be fully ready to serve clients cached data.

Initial Prefill

Updating previously prefilled apps

Updating any previously prefilled apps can be done by simply re-running the prefill command, which will use same prefill app list as before.

SteamPrefill keeps track of which version of each app was previously prefilled, and will only re-download if there is a newer version of the app available. Any apps that are currently up to date, will simply be skipped. The number of apps already up to date will be displayed in the end of run summary table:

Prefilled app up to date

However, if there is a newer version of an app that is available, then SteamPrefill will re-download the app. Due to how Lancache works, this subsequent run should complete much faster than the initial prefill (example below used a 10gbit connection). Any data that was previously downloaded, will be retrieved from the Lancache, while any new data from the update will be retrieved from the internet. Any apps that have been updated will be counted towards the "Updated" column in the end of run summary.

Prefill run when app has an update

Frequently Asked Questions

Note

FAQs have been moved to the project wiki. A table of contents is provided here for convenience and visibility : Frequently Asked Questions

Detailed Command Usage

More in depth documentation on SteamPrefill's various commands can be found on the project wiki.

  • Looking to see what other options can be used with prefill? See prefill
  • Interested to seeing the total download size of your selected apps? Try select-apps status
  • Getting slow downloads from your cache, and interested in diagnosing it? Use the benchmark

Updating

SteamPrefill will automatically check for updates, and notify you when an update is available :

Update available message

Automatically updating

  • Windows
    • Run the .\update.ps1 script in the executable directory
  • Linux
    • First time only : Grant executable permissions to the update script with chmod +x ./update.sh
    • Run the ./update.sh script in the executable directory
  • Docker
    • docker pull tpill90/steam-lancache-prefill:latest

Manually updating:

  1. Download the latest version for your OS from the Releases page.
  2. Unzip to the directory where SteamPrefill is currently installed, overwriting the previous executable.
  3. Thats it! You're all up to date!

Need Help?

If you are running into any issues, feel free to open up a Github issue on this repository.

You can also find us at the LanCache.NET Discord, in the #steam-prefill channel.

Want to Contribute?

There is additional documentation over on the project wiki that can help you get started! Interested in modifying and compiling the project from source? See Compiling From Source. Noticed something in the documentation needs updating? See Working With Project Documentation

Acknowledgements

  • @dlrudie for all your help with debugging and testing!