gt-wiki

Helper for Guardian Tales wiki data and assets management

TODO

write small shell scripts for automating stuff
fetch assets from patch-w domain
optional fetch from global 0000 patches
allow traversing between tracked versions, opposed to one-way progression
try auto-pushing edits to wiki using MediaWiki API
create organized directories for versions
create a custom strings-enUS.json
write own unpacker and unpremultiplier

Cloning

Graphics are stored in the form of Git LFS in order to avoid bloated repository. When cloning, you can choose to either download all LFS assets (recommended):

$ git clone https://github.com/SuggonM/gt-wiki

…or opt out from it:

$ git clone --config lfs.fetchexclude="*" https://github.com/SuggonM/gt-wiki

Installing Dependencies

Dependencies, and other required repositories can be installed by running the install-deps.bat script.

The script works outside Windows environment as well:

$ sh ./install-deps.bat

Running the Script

In order to run the main update script, you can simply run one of these commands:

$ node .
# -- OR --
$ npm start

Fetch Index

The repository currently only fetches the following static files from the bucket. (Dynamic file tracking coming soon™!)

// index.js#L13-L18
const fetchIndex = [
	'spritesheets/heroes',     // character sprites, portraits
	'spritesheets/items',      // icons, weapons, cards
	'spritesheets/ui/main_s3', // UI icons
	'ui/common'                // stickers
]