mirror of https://github.com/bitburner-official/bitburner-src.git synced 2024-12-19 12:45:45 +01:00

History

Martin Fournier c367de24a8 Add tool & workflow to fetch changelog Rewrote the changelog script to use primarily merged pull requests between "commit A" and "commit B". It uses the GitHub rest api. The resulting data is pushed to a draft gist. Manual usage is in the README. Also adds a GitHub workflow action to run the tool on demand, through the GitHub action's interface.		2022-01-25 10:20:36 -05:00
..
fetch-changelog	Add tool & workflow to fetch changelog	2022-01-25 10:20:36 -05:00
fetch-steam-achievements-data.js	Add achievements to base game	2022-01-08 05:45:32 -05:00
pretty-save.js	Add SaveTimestamp to saveString, used in import	2022-01-07 09:02:35 -05:00
README.md	Add tool & workflow to fetch changelog	2022-01-25 10:20:36 -05:00

README.md

Tools

Pretty Save

Useful to analyze a player's save game for anomalies.

It decodes the save and prettifies the output. Canno be used to modify a save game directly since it drops some properties.

Usage

node ./pretty-save.js 'C:\\Users\\martin\\Desktop\\bitburnerSave_1641395736_BN12x14.json' 'C:\\Users\\martin\\Desktop\\pretty.json'

Fetch Steam Achievements Data

Used to synchronize the achievements info in steamworks to the game's data.json

Usage

# Get your key here: https://steamcommunity.com/dev/apikey
node fetch-steam-achievements-data.js DEVKEYDEVKEYDEVKEYDEVKEY

Fetch Changelog

Used to generate a changelog of merged pull requests & commits between A & B. The key is a personnal access token, from https://github.com/settings/tokens. It requires the "gist" scope as the result is pushed to a secret gist.

Usage

cd ./tools/fetch-changelog
npm install
export GITHUB_API_TOKEN=tokenhere # this could go into your .bashrc or .profile etc.
node index.js --from=31ebdbb139981a604bd0e8fc1e364916762e11b9 > ../bump-version/changes.md