PyHelpersForPDXWikis is a tool to parse the game files of some paradox games and generate tables and other information from them and add it to the wiki. The current version generates the output as txt files, but future versions will allow automatically uploading to the wiki. The following games are supported:

• Age of Wonders 4(only rudimentary support for json data files)
• Cities: Skylines II
• Millennia
• Victoria 3

The main components are:

ParadoxParser (common/paradox_parser.py)

parses paradox game scripts with the help of rakaly cli and turns them into Tree objects(a wrapper around dict) and generic python types like list, str, int, float and bool

vic3/vic3lib.py

contains classes for many of the vic3 game entities like Country, State, Technology, Building, ProductionMethod

Vic3Parser (vic3/parser.py)

uses ParadoxParser to read the game files and creates vic3lib objects. These objects can be accessed as properties of the Vic3Parser object. The parser should not be accessed via vic3game.parser so that only one instance exists

Vic3FileGenerator (vic3/vic3_file_generator.py)

base class for the wiki text generators. See Usage for a list of them

Victoria3 (vic3/game.py)

the main purpose of this game object is to hold a reference to the Vic3Parser parser and other game related information, to allow some code to work for multiple games. It can be accessed via the variable vic3game

aow4

Age of Wonders 4 has the same files as vic3 in its aow4 folder. Instead of rakaly, it reads json files with a data dump.

cs2

Cities Skylines II files are parsed with the help of UnityPy

millennia

Millennia follows the same structure as vic3

Installation

Clone this repository or download it as a zip from https://github.com/grotaclas/PyHelpersForPDXWikis. Then fulfill the dependencies and configure it.

Dependencies

This project needs python version 3.10 or above (older versions might work as well). requirements.txt contains the needed python modules. The code for each game only uses some of the requirements. They can be installed with pip (preferably in a venv):

python3 -m pip install -r requirements.txt

To parse the vic3 game files, the rakaly cli is used. It must be either installed somewhere in the PATH or the location has to be configured in the settings.

For aow4, an export of the game data in json format is needed. The Age of Wonders 4 Database hosts a modified version of the files on their github

For cs2 and millennia, the data is read from the unity assets with the help of UnityPy

The pyradox folder contains a modified version of the wiki table generator from pyradox. This is a temporary solution and will be replaced by code which is better suited to generate the needed output without too much boilerplate.

Configuration

Copy localsettings.py.example to localsettings.py and configure the location of the game installation(s) and rakaly for your system. The example file describes the options.

Usage

The wiki text can be generated as .txt files by calling one of the scripts from the vic3 folder. They either generate all files which they support or a specific function can be specified as command line argument by removing the generate_ prefix from the method name. For example python3 vic3/generate_tables.py decree_table. The following scripts exist currently:

generate_tables.py

generates many tables

generate_articles.py

generates the Vickypedia

generate_building_tables.py

generates tables of buildings and production methods

aow4/generate_tables.py

currently the only script for Age of Wonders 4. Generates several tables

millennia/generate_tables.py

generates most of the tables on the wiki

millennia/generate_templates.py

experimental code to generate tooltip templates

millennia/dump_xml.py

exports the XML files from the unity assets. Expects the output folder as the only parameter. The files will be written in subfolders according to the addressables of the unity assets

Sample code

from vic3.game import vic3game

for tag, country in vic3game.parser.countries.items():
    if country.capital_state:
        capital_name = country.capital_state.display_name
    else:
        capital_name = 'No capital'
    print(tag, country.display_name, capital_name)