Skip to content

Latest commit

 

History

History
148 lines (99 loc) · 8.13 KB

README.md

File metadata and controls

148 lines (99 loc) · 8.13 KB

battlenet-lancache-prefill

view - Documentation ko-fi

GitHub all releases dockerhub

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

Prefilling game

Features

  • Downloads specific games by product ID
  • High-performance! Downloads are significantly faster than using Battle.net, and can easily reach 10gbit/s or more!
  • Game install writes 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!
  • Multi-platform support (Windows, Linux, MacOS, Arm64)
  • No installation required! A completely self-contained, portable application.

Table of contents

Initial Setup

BattleNetPrefill is flexible and portable, and supports multiple platforms and configurations. It can be run directly on the Lancache server itself, or on your gaming machine as an alternative Battlenet 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 BattleNetPrefill on Windows you will need to substitute ./BattleNetPrefill with .\BattleNetPrefill.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

./BattleNetPrefill select-apps

All of your currently owned apps will be now 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

./BattleNetPrefill 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 games

Updating any previously prefilled games can be done by simply re-running the prefill command, with the same games specified as before.

BattleNetPrefill keeps track of which version of each game was previously prefilled, and will only re-download if there is a newer version of the game available.
Any games that are currently up to date, will simply be skipped.

Prefilled game up to date

However, if there is a newer version of a game that is available, then BattleNetPrefill will re-download the game.
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.

Prefill run when game has an update

Frequently Asked Questions

Can I run BattleNetPrefill on the Lancache server?

You certainly can! All you need to do is download BattleNetPrefill onto the server, and run it as you regularly would!

If everything works as expected, you should see a message saying it found the server at 127.0.0.1 Prefill running on Lancache Server

Running from a Docker container on the Lancache server is also supported! You should instead see a message saying the server was found at 172.17.0.1 Prefill running on Lancache Server in Docker

Running on the Lancache server itself can give you some advantages over running BattleNetPrefill on a client machine, primarily the speed at which you can prefill apps.
Since there is no network transfer happening, the prefill should only be limited by disk I/O and CPU throughput.
For example, using a SK hynix Gold P31 2TB NVME and running prefill --force on previously cached game yields the following performance Prefill running on Lancache Server in Docker

Detailed Command Usage

Note Detailed command documentation has been moved to the wiki : Detailed Command Usage

Updating

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

Update available message

To update:

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

Docker update:

sudo docker pull tpill90/battlenet-lancache-prefill:latest

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 #battlenet-prefill channel.

Additional Documentation

External Docs

Acknowledgements