README.EN.md

SnowRunner XML Editor Desktop (EN)

This program allows you to edit the XML files of the SnowRunner game by editing the visual parameter table.
The editor unpacks the necessary files from initial.pak to a temporary folder, after which it goes to work with them. When saving, changes are made to the archive.
To work with initial.pak, the program uses a portable version of WinRar for 32-bit systems.
Everything works using Electron, Vite, Vue, Typescript.

The editor has the following functionality:

• update
• reset the program and parameters
• import / export settings and parameters
• editing XML

Installation

There are two versions in the releases:

• installer. Installs the program into the system (.exe).
• archive. The portable version of the program (.rar).

The difference between the versions is only in the installation method.

How to use

You can read about how to use the program in the guide at the link.

Development

It is understood that you have everything you need to work with NodeJS.

Install dependencies:

npm i

To start the dev server:

npm start

For a test build of the project:

npm run package

The assembled test assembly for a 32-bit system will appear in the out folder.
In this build, you can reset the program, update the window, developer tools (Ctrl+Shift+I), and the backup initial.pak is not saved.

Project directories:

/docs               page GitHub Pages.
/inno-setup         InnoSetup configuration.
/src:               the main resources of the program.
   /build-configs       the Vite and Electron Forge configurations.
   /images:             graphic resources.
      /icons                other images.
      /trailers             pictures of trailers.
      /trucks               pictures of trucks.
      favicon.ico           program icon.
   /main:               main process.
      index.ts              the start file.
      tsconfig.json         TS configuration for the main process.
   /modules:            different kinds of modules.
      /archive              working with the archiver.
      /backup               working with backup.
      /checks               basic checks.
      /data                 stored data.
      /dialogs              system dialogs.
      /dlcs                 processing of game DLCs.
      /epf                  exporting parameters.
      /errors               throwing errors.
      /files                working with the file system.
      /game-texts           processing of game texts.
      /helpers              utilities.
      /images               working with images.
      /messages             displays messages in the renderer process.
      /paths                different paths.
      /quit-params          program closing parameters.
      /updates              program update.
      /xml                  working with XML.
   /renderer:           renderer process.
      /components           common components.
      /pages                program windows.
         /loading               loading window.
         /main                  main window.
            /editor                 page of the editor (tables).
            /lists                  page of lists of trucks / trailers.
            /main                   main page.
         /settings              settings window.
         /setup                 first setup window.
         /update                update window.
         /whats-new             "what's new" window.
      /utils                helper scripts.
      style.scss            global styles.
      preload.ts            preload script.
      template-script.ts    template script.
      tsconfig.json         TS configuration for the renderer process.
      types.ts              common types for the renderer process.
   /utils               common utilities.
   consts.ts            useful flags.
   tsconfig.json        main TS configuration.

Pictures