Home

TODO

Most Important

• Get a good chunk of raw documentation on all the data-driven files into the website.
  • bridgesInfo.json
  • buildableWorldResourcesInfo.json
  • buildingCategoriesInfo.json
  • buildinginfo.json
  • buildingUpgradesInfo.json
  • cityUpgradesInfo.json
  • decorationsInfo.json
  • policiesInfo.json
  • stories.json
  • Custom Scenario JSON
  • skyColors property in scenarios
  • lang_xx.csv localization documentation
  • languageInfo.json
  • modInfo.json
• Document some undocumented behavior on certain ModTools functions.
  • makeBuilding (document custom fields)
  • makeBuildingUpgrade (document custom fields)
• Document extra important ingame variables
  • MaterialsHelper
  • Resources
  • common_Localize
• Copy over the rest of the normal docs to complete the index
  • makeBuilding
  • buildingAddEntertainmentProperties
  • buildingEnableMerging
  • buildingAddAnimatedSprite
  • makeBuildingUpgrade
  • makeCityUpgrade
  • addUpgradeToBuilding
  • addBuildBasedUnlock
  • addStatBasedUnlock
  • addMaterial
  • produce
  • consume
  • onCityUpdate
  • onCityCreate
  • onModsLoaded
  • onLoadStart
  • addSaveData
  • addSaveDataEarly
  • setModEnabled
  • modIsEnabled
• Make a few tutorials that can walk someone through the process of making a mod. Ideas include:
  • Setting up the mod folder
  • Custom decorations
  • Custom resources
  • Custom buildings
  • Custom world resources
  • Custom upgrades
  • Custom categories
  • Custom complex buildings
  • Custom UI elements
  • Custom scenario
  • Custom scenario goals
  • Custom randomly generated scenario

Least Important

• Lastly after all that is done, if I'm still interested in this project, make a few tools
  • Generators for JSON files (such as buildinginfo.json, custom scenarios, etc)
  • Sprite viewer and packer for PIXI spritesheets

GitHub repository • Official modding guide