PdxModsIntlCrawler

Reference maintainer(s): @toverux

A simple CLI tool to find mods from Paradox Mods proposing community-supported translation projects. This is helpful for translators to find mods that need their help.

It uses the Paradox HTTP API to iterate over mod descriptions and external links and find the ones that have a translation project.

This repository was made for Cities: Skylines II, but fork it and just delete state/ to start fresh on another Paradox game.

Supported platforms:

• Crowdin
• ParaTranz
• Other platforms can be supported easily on request!

Usage

• Install Bun,
• Run bun install,
• Run ./cli.ts help.
• Edit config.ts to set the constants to use each time you use the CLI once and for all (ex. the game ID).

CLI Commands

discover

Scans the API for mods with translation projects and lists them as they are found.

Takes the game to generate the list of mods for, the game slug ID can be found on Paradox's website, ex. https://mods.paradoxplaza.com/games/cities_skylines_2.

Generates a state/state.json file that serves to the other commands for further processing.

When there is already a state/state.json file, it will be moved to state/previous-state.json and a new state file will be generated, allowing diffing and changelog generation.

Example:

./cli.ts discover

list

Generates a list of all mods with a translation project from the state/state.json.

Example:

./cli.ts list

Example output:

This list is generated automatically. See second post in thread for more info.

1. ExtraLib by Triton Supreme — 198,080 installs
2. 529 Tiles by algernon — 183,618 installs
3. Line Tool by algernon — 178,726 installs
4. ExtraLandscapingTools by Triton Supreme — 161,494 installs
5. Plop the Growables by algernon — 72,466 installs
6. ExtraDetailingTools by Triton Supreme — 41,082 installs
7. ExtraAssetsImporter by Triton Supreme — 39,646 installs
8. Skyve [BETA] by TDW — 29,505 installs
9. First Person Camera Continued by Cgameworld — 22,086 installs
10. AdvancedSimulationSpeed by zakuro9715 — 6,353 installs
11. Lumina by Nyyoko — 5,699 installs
12. SettingsManager by zakuro9715 — 647 installs

changelog

Generates a changelog of all mods with a translation project by comparing state.json and previous-state.json.

Example:

./cli.ts changelog

Example output:

List update!

New translation projects discovered:

1. ExtraDetailingTools by Triton Supreme — 41,082 installs
2. Plop the Growables by algernon — 72,466 installs

Mods that updated their translation project link:

1. First Person Camera Continued by Cgameworld — 22,086 installs

Deleted mods or translation projects:

1. ExtendedRadio by Triton Supreme — 35,671 installs