ribbon-studios / protontweaks-db

Collection of tweaks for protontweaks
https://protontweaks.com/#/apps
GNU General Public License v3.0
2 stars 0 forks source link
database linux proton protontricks steam

[!IMPORTANT]
This is the Protontweaks UI repository, you can find its sister repositories at the following links!

Protontweaks DB + API

Tweak database for your favorite games!

Usage

Its highly recommended that if you're planning on fetching tweaks from our api that you lock into a specific version.

https://api.protontweaks.com/v4/<app-id>.json

Old versions will get any new apps that are added, however if a feature isn't supported in the old api it won't get mapped.

Prior versions will be removed approximately a year after they're added.

Adding a tweak?

[!TIP] You can discover the app id by using https://steamdb.info!

Example Tweak File

{
  "name": "They Are Billions",
  "tweaks": {
    // Specify any protontricks here
    "tricks": ["gdiplus"],
    // Set any environment variables here
    "env": {},
    // Set any cli args here
    "args": ["--use-d3d11"],
    // true      => cli is confirmed to work.
    // false     => cli is confirmed to cause problems.
    //
    // If the option is not present then the given cli has not been tested.
    // Consumers of the API can interpret this however they want.
    // In the case of `protontweaks` it will do the following:
    // - gamemode => run unless the user has explicitly disabled it (or it isn't installed)
    // - mangohud => not run unless the user has explicitly enabled it and it is installed
    //
    // Because of how mangohud functions it tends to be safer to assume it'll cause problems unless confirmed
    "settings": {
      "gamemode": true,
      "mangohud": false
    }
  }
}

TODO