Config Documentation

Config Documentation

Empty config:

settings:
  Playnite location: 
  Playnite exe: 
  Restart after sync: 
libraries:
  name: 
    status: 
    path: 
    folder data type: 
    data file: 
    name type: 
    time type: 
    ignore time: 
    time line: 

Settings

Playnite location:

Path to the Playnite folder

---

Playnite exe:

Path to the Playnite exe, used for the restarting feature.

---

Restart after sync:

true - Restarts after closing . false - doesn't restart after closing.

Since success story only updates manual achievements after restarting playnite you can use this feature to immediately restart playnite after closing a game. For more information see here LINK TO BE ADDED.

---

libraries

name:

Can be any string used to differentiate libraries.

---

status:

true - library will be used to sync achievements. false - library will be skipped.

---

path:

Path to a folder that contains all the game data folders. For Goldberg this would be a folder containing bunch of folders named after steam ids. You can start the path with different parameters:

APPDATA - starts in appdata\roaming

LOCALAPPDATA - starts in appdata\local

PUBLIC - starts in the public folder (This one might not work)

---

folder data type:

game_name - Folders inside are named by the name of the game steam_id - Folders inside are named by the steam id

---

data file:

Name of the file that has all the achievements data, remember to include a file extension at the end

.json - This will use the json parser

.ini - This will use the ini parser

Input might be achievements.json

---

name type:

This decides how to search for achievements inside the data file, the input can be name or apiname - You should check the json file inside the extension data where each achievement has both name and apiname and find how it corresponds to your data file.

---

time type:

Success story doesn't have a toggle for unlocked achievements or rather for the achievement to get unlocked we have to convert a time of each achievement from our data file into the success story extension data.

The time format can be unix timestamp more info here

Or the time format can be combination of yyyy mm dd hh nn ss, you can combine this with added symbols such as . to match the layout your data file uses.

---

ignore time:

This is a time that might appear in your data file for achievements that have not yet been unlocked, this is used to filter out the achievements that have not been unlocked yet. Important, you are using the time that is part of the data file and has not been converted yet so basically if the time in your data file is 0 you should place 0 here.

---

time line:

This is where the line with the time appears, for json file you want to include the string in "" marks without the quotation marks and for ini files include everything before =