Library for working with Civilization V save files
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
dist Bump to v0.2.1 Jul 10, 2018
docs Bump to v0.2.1 Jul 10, 2018
scripts Add script for removing compressed section of save files Dec 31, 2017
src Add test for bmaupin/civ5save-editor#6 Jul 10, 2018
wiki Change property definitions from JSON to JS Jan 2, 2018
.babelrc
.eslintrc.js Remove eslint JSON plugin since we're not using it Jan 29, 2018
.gitignore
.travis.yml Switch from jsdoc to esdoc Sep 12, 2017
LICENSE Initial commit Jul 6, 2017
NOTICE Add NOTICE for files from external sources Aug 24, 2017
README.md Add some basic instructions Nov 24, 2017
package.json Bump to v0.2.1 Jul 10, 2018
webpack.config.js Combine separate use sections per environment for simplicity Dec 20, 2017
yarn.lock Remove eslint JSON plugin since we're not using it Jan 29, 2018

README.md

Build Status Coverage Status NPM version License Documentation

Features

  • Documented API
  • Support for reading general game information (difficulty, turn number, player civilizations and statuses, etc.)
  • Support for reading and writing victory types (time, science, etc.)
  • Support for reading and writing advanced options (policy saving, promotion saving, etc.)
  • Support for reading and writing hidden options (always peace, always war, etc.)
  • Support for reading and writing certain multiplayer options (pitboss, private game, turn mode, turn timer)

For an example of actual usage, see https://github.com/bmaupin/civ5save-editor

Installation

yarn add civ5save

Or:

npm install civ5save

Development

  1. Install Yarn (https://yarnpkg.com/docs/install)

  2. Clone the repository and install dependencies

    git clone https://github.com/bmaupin/js-civ5save.git
    cd js-civ5save
    yarn install
    

Testing

yarn test

Building (includes documentation)

yarn build

Credits

References