Skip to content

Latest commit

 

History

History
113 lines (96 loc) · 7.21 KB

README.md

File metadata and controls

113 lines (96 loc) · 7.21 KB
Raw

Arma 3 Preset Generator

Customizable Arma 3 Launcher preset files generated client side from a list of steam workshop IDs.

Features

  • preset sharing made effortless 💚
  • optional mods can be customized on a simple web interface on the fly
  • outputs standard Arma 3 Launcher preset files
  • remembers previously selected optional mods
  • converts existing Arma 3 preset and list files
  • client-side mod data caching

URL format

All the preset information (preset name, mods/collections, DLCs, optional flags) is stored in the app URL's query string component.
Additional information is fetched from various steam APIs but the steam workshop is considered the single source of truth.

Preset name

Custom preset name or file name can be appended to the URL after ?.
Only alphanumeric characters and underscore (_) are allowed.
If the preset name is set, the ID list must be separated with =.

ID list

Comma , separated list of IDs evaluated from left to right in order. Appended to the URL after ? or =.
Mods inherit the optional flag from collections, but the last state in order affecting a mod takes precedence when rendering the UI. (see example C4G RHS KotH)

This means that you can override the optional flags of certain items in collections to extend or restrict them. In other words it allows you to mix and combine existing collections and mods to customize the required and optional mods in any way you like.

The selected optional mods are remembered client-side in relation to the preset name.
You should also take advantage of the workshop collection feature and create permanent links with workshop IDs pointing to the currently used required and optional collections. (see examples FNF and FNF WW2)

Optional mods

Append or prepend a * to flag an ID optional.

Workshop IDs (collection, mod)

Only numbers and the optional * prefix/suffix is allowed.

DLC IDs

Items starting with ! are added to the preset as DLC/CDLC AppIDs.
Only numbers and the optional * prefix/suffix is allowed.

Local mod IDs

Items starting with @ are added to the preset as local mods.
Only alphanumeric characters + _ and the optional * prefix/suffix is allowed.

Limitations

Both the client (web browser) and the server (web server) impose restrictions on the maximum supported length of a URL. A reasonable limit is approximately 2000 characters across various applications. This allows for approximately 150 mods in a single arma3pregen URL.
If you need more then you can use collections to condense the list into a single workshop ID.

Examples

Self hosting

NodeJS, PHP, Python or Docker is required to relay backend calls to the steam API. (CORS disabled 😔)
Spin up an instance on http://localhost/ with one of these commands:

  • nodejs: node server.js
  • python: python server.py
  • php: php -S 0.0.0.0:80
  • docker (php): docker-compose up

The app can be served from under any subdomain or path.

Environmental variables

PORT controls the listener port of NodeJS and Python servers. [default: 80]
CACHE_MAX_AGE controls the browser cache for backend requests in seconds. [default: 0]
STEAM_WEB_API_KEY enables the usage of API key protected steam endpoints. (optional but recommended ⚠) [default: empty]
⤷ the public API fails on some workshop IDs where the key protected one returns details just fine 🤷‍♂️

Similar projects

TODO

  • prompt for the preset name before saving if it's not set
  • resolve unmet workshop dependencies on demand
  • add a section for the most recently updated mods ordered by date DESC
  • show mod size and last update on hover in modlist