mirror of https://github.com/zeropingheroes/lancache-autofill synced 2024-11-22 15:43:04 +00:00

No description

Find a file

ilumos 9bfc565d01 Disabling creation of Vagrant / Virtualbox log file		2017-08-28 00:39:02 +01:00
src/Console/Commands	Removing unnecessary variable	2017-08-27 22:17:44 +01:00
.env.example	Changing environment variables and initialisation commands	2017-08-17 04:05:07 +01:00
.gitattributes	Forcing Unix line edings	2017-08-27 22:17:00 +01:00
.gitignore	Adding Vagrantfile for development	2017-08-27 22:17:18 +01:00
composer.json	Moving configuration to .env file	2017-08-17 00:32:47 +01:00
composer.lock	Moving configuration to .env file	2017-08-17 00:32:47 +01:00
install.sh	Updating install script	2017-08-27 22:16:20 +01:00
lancache-autofill	Updating code style to PSR-2	2017-08-21 21:38:32 +01:00
README.md	Updating requirements	2017-08-21 22:03:24 +01:00
Vagrantfile	Disabling creation of Vagrant / Virtualbox log file	2017-08-28 00:39:02 +01:00

README.md

lancache-autofill

Automatically fill a lancache with the content of your choosing, so that subsequent downloads for the same content will be served from the lancache, improving speeds and reducing load on your internet connection.

Features

Choose which platform(s) to download an app for
Use multiple Steam accounts to download apps
See which apps downloaded successfully
See which apps failed, and what the error message was

Requirements

A working lancache
Ubuntu 16.04 x64, configured to download via the lancache
Sufficient disk space to (temporarily) store the downloaded content
PHP 7.0

Installation

git clone https://github.com/zeropingheroes/lancache-autofill.git
cd lancache-autofill
sudo ./install.sh

Quick Start

Set the default Steam account to be used when queueing apps for download:

nano .env
Search for the apps you wish to download to find their app ID:

./lancache-autofill steam:search-apps "team fortress 2"

440 Team Fortress 2 [...]
Queue the app for download by ID:

./lancache-autofill steam:queue-app 440
Start downloading items in the download queue:

./lancache-autofill steam:start-downloading
View the download queue to see the status of the downloads:

./lancache-autofill steam:show-queue
Clear the temporary download location:

./lancache-autofill app:initialise-downloads-directory

Command Reference

app:initialise-database

Initialise the database.

app:initialise-downloads-directory

Initialise the downloads directory.

steam:authorise-account [account]

Authorise a Steam account to allow download of apps in their library.
If no account is specified, the DEFAULT_STEAM_USER account is used

steam:queue-app appid [platform(s)] [--account=account]

Queue a Steam app for downloading.
Optionally the platform(s) to download can be specified as a comma-separated list
Available platforms are: windows, osx, linux
If no platform is specified, the Windows version of the app will be queued

steam:dequeue [--app_id=] [--platform=] [--account=] [--status=]

Dequeue a items from the download queue.
Optionally specify any combination of app ID, platform, account and status
Calling with no arguments clears the queue

steam:requeue [status=failed]

Requeue failed and/or completed items in the download queue.
By default failed items are requeued

steam:search-apps name

Search Steam apps by name.

steam:show-queue [status]

Show the Steam app download queue.
Optionally only show items with specified status
Available statuses are: queued, failed, completed

steam:start-downloading

Start downloading the Steam apps in the queue.
The account(s) specified in the queue to download from are checked before any app downloads are attempted

steam:update-app-list

Get the latest list of apps from Steam.

Limitations & Known Issues

Steam is the only supported platform currently
Paid apps can only be cached with access to a Steam account that owns them
No support for forcing download of 32 bit apps
Yes, it's written in PHP. No shame.