RWR Data

Useful data related to the RUNNING WITH RIFLES game, gathered from several sources.

The code was partially extracted from the defunct RWRS project.

Download

Data aren't made available into this repo itself. They are provided in the rwr-data-*.tar.gz file of each release.

Link to latest release:

Automation

You'd want to automate download of the latest release file. You could do so by using this tool or by rolling your own bash script.

Updates

There's no update schedule, data are updated as needed. Get notified about updates by subscribing either to:

• The release events of this repo ("Watch" button); or
• The releases Atom feed

Available data

Important

Only data from official packages (vanilla game and official DLCs) are available. Third-party packages (typically mods) aren't planned (yet?).

Emojis meaning: ✅ data is available; 🚧 data is not yet available but work is in progress; 📅 data is not yet available but is planned to.

Maps

Metadata ✅

Format: JSON

Content:

• Map name. Extracted from the game's files
• Link to the official wiki page (if available)

Location: maps/data.json

Annotated extract:

{
  "vanilla": { // Package ID
    "map2": { // Map ID
      "name": "Keepsake Bay", // Map name (mandatory)
      "wikiUrl": "https://runningwithrifles.fandom.com/wiki/Keepsake_Bay" // Official wiki page (optional)
    },
    // ...
  },
  // ...
}

Images 📅

Format: PNG

Content: The map displayed when pressing TAB in-game. Extracted from the game's files

Location: maps/images/{package}/{name}.png

Previews ✅

Format: PNG (if available)

Content: In-game representative screenshot. Mostly sourced from the official wiki

Location: maps/images/previews/{package}/{name}.png

Ranks

Metadata 🚧

Format: JSON

Content:

Extracted from the game's files:

• Rank name
• Required XP

Location: ranks/data.json

Annotated extract:

{
  "vanilla": [ // Faction ID (NOT the package's ID). Caution: this faction ID is NOT necessarily the one used in the game's file
    { // Position in the array defines the rank's level. Here it's rank 0
      "name": "Private", // Rank name
      "xp": 0 // Required amount of XP
    },
    { // Rank 1
      "name": "Private 1st Class",
      "xp": 500
    },
    // ...
  ],
  // ...
}

Insignias 📅

Format: PNG

Content: What is displayed in-game when hovering soldiers with your cursor. Extracted from the game's files

Location: ranks/images/{faction}/{level}.png

Moderators ✅

Format: JSON

Content:

Moderators on official servers. Sourced from config actually used by official servers.

Location: moderators.json

Annotated extract:

[
  "ahnold", // In-game username (lowercase)
  "jackmayol",
  // ...
]

Development

Note

You only need to read the followings if you want to update the data. You don't need to install anything to get access to the data (read above).

Prerequisites

• Python >= 3.10 (developed using 3.14)
• Pipenv
• RUNNING WITH RIFLES game with all its DLCs

Installation

Clone this repo, and then pipenv install --dev.

Usage

Everything happens through a CLI. You can read about all the available commands using:

pipenv run build --help

You can use the --help option for each of the subcommands as well.

Adding a map preview

Map previews are the only images versioned into this repo since those are user-generated content. They are simply copied into the archive upon release.

They are located in the static/maps/images/previews directory. The naming follows the same convention as the map's images, e.g {package}/{name}.png.

Adding a map wiki URL

This happens in the builders/maps/__init__.py file, in the WIKI_PAGES constant. The URL is automatically set in the JSON file when building the archive if one is found.

Creating a release

1. Make sure your game installation is up to date (including DLCs)
2. Run the pipenv run build all {steamdir} --rev {n} command where {steamdir} is the absolute path to the Steam root directory and {n}) is the desired revision. The revision must be the last value of the current year plus one, or 1 if it's the first release of the year
3. Create a GitHub release following the Keep a Changelog format
4. The name of the release must match this format: {year}.{n}. It must be identical to the one found in the archive's name
5. Upload the resulting dist/rwr-data-*.tar.gz file into the release
6. Publish the release

Credits

• All RUNNING WITH RIFLES assets (images, game data) © Osumia Games
• Map previews comes from the official RWR wiki
• Original code by @EpocDotFr