lancache-autofill/README.md

3.1 KiB
Executable file

lancache-autofill

Automatically fill a Lancache with content.

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

  • Ubuntu 16.04 x64

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
  • No support for forcing download of 32 bit apps
  • Yes, it's written in PHP. No shame.

Reference