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

History

catloversg 8553bcb8fc MISC: Support compression of save data (#1162 ) * Use Compression Streams API instead of jszip or other libraries. * Remove usage of base64 in the new binary format. * Do not convert binary data to string and back. The type of save data is SaveData, it's either string (old base64 format) or Uint8Array (new binary format). * Proper support for interacting with electron-related code. Electron-related code assumes that save data is in the base64 format. * Proper support for other tools (DevMenu, pretty-save.js). Full support for DevMenu will be added in a follow-up PR. Check the comments in src\DevMenu\ui\SaveFileDev.tsx for details.		2024-03-27 21:08:09 -07:00
..
bump-version	Add `npm version` support to build releases	2022-04-07 07:50:47 -04:00
bundle-doc	DOCUMENTATION: Better npm run doc, plus minor folder reorganization (#693 )	2023-08-01 00:59:33 -04:00
engines-check	fmt and lint	2022-04-06 19:30:08 -04:00
fetch-changelog	VERSION: Update game version to 2.2 (#240 )	2022-12-01 16:07:46 -05:00
build-release.sh	Add `npm version` support to build releases	2022-04-07 07:50:47 -04:00
build.sh	Fix build test passing on failed builds	2023-04-25 09:12:17 -04:00
doc.sh	DOCUMENTATION: Better npm run doc, plus minor folder reorganization (#693 )	2023-08-01 00:59:33 -04:00
fetch-steam-achievements-data.js	fmt and lint	2022-04-06 19:30:08 -04:00
package-electron.sh	Fix order of operations for electron build script	2023-05-24 12:10:29 -04:00
pretty-save.js	MISC: Support compression of save data (#1162 )	2024-03-27 21:08:09 -07:00
README.md	Fix a doc typo (#858 )	2023-10-07 18:44:28 -04:00
steamdev.vdf	Changelog update and steam dev updater v2	2023-03-11 17:07:08 -05:00
tsconfig.json	lint	2022-05-25 11:43:43 -04:00

README.md

Tools

Pretty Save

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

It decodes the save and prettifies the output. Cannot 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

Bump Version

Used to update the game's various version identifier. Requires pandoc installed to convert .md to .rst

Usage

cd ./tools/bump-version
npm install
node index.js --version=1.10.3 --versionNumber=10 < changes.md