Rig'n'Roll Gold Edition - Workshop Guide

This guide explains how mods work in Rig'n'Roll Gold Edition: how to put one together, and how to publish a mod to the Steam Workshop with the Workshop Uploader that ships with the game.

  1. How mods work
  2. What you need
  3. Quick start
  4. Mod folder layout
  5. The mod.cfg file
  6. Load order and conflicts
  7. Truck paint jobs
  8. What you can change
  9. Using the Workshop Uploader
  10. Testing your mod
  11. For players: installing mods
  12. Common problems

How mods work

A mod is a folder of game files, laid out the same way as the game's installation folder, plus a small text file called mod.cfg that describes it. A mod can also carry truck paint jobs in a folder of their own, see Truck paint jobs.

When you start the game from Steam, the mod synchronizer, WorkshopModSync.exe, runs first. It takes out everything it put in on the previous start, copies the files of your subscribed mods into the game folder, and only then starts the game. A file in a mod replaces the game's file at the same path, and a file the game does not have is added. The game's own files that a mod replaces are kept in the Workshop Backups folder and put back on the first start after the mod stops being active. Unsubscribe, start the game from Steam again, and everything is back to the original. Paint jobs are handled the same way, in the folder where the game looks for them.

Three rules follow from this, and they are worth keeping in mind from the start:

  • Files are matched by their path inside the game folder. Data\Wav\HORN.WAV in your mod replaces Data\Wav\HORN.WAV in the game. The same file placed at the top of your mod folder would be copied to the top of the game folder, where the game never looks for it. Upper and lower case do not matter.
  • Whole files replace whole files. The game keeps many objects in one file: a truck is a few .wdb files in its folder under Trucks\Trucks, all cargo types are one table in Data\config. To change one thing you ship the whole file, and two mods that change the same file cannot be combined: only one version of it ends up in the game.
  • Ship only what you changed. The fewer files a mod contains, the fewer other mods it collides with.

What you need

  • The game installed through Steam, and the Steam client running and signed in with the account you want to publish from. The account must own the game.
  • The Workshop Uploader: Workshop Uploader GUI - Rig'n'Roll Gold Edition.exe in the game's installation folder, next to rungame.exe. Leave it where it is: it must stay in the game folder to work.
  • The Mod Template folder from the same place. It contains a ready-to-edit mod.cfg and a placeholder preview image.
  • Most game files are binary formats (models, textures, packed tables) and need suitable tools to edit. A paint job needs only an image editor that can save DDS files.

Quick start

  1. Copy the Mod Template folder somewhere outside the game folder and rename the copy after your mod.
  2. Open mod.cfg and set at least ~title.
  3. Replace preview.png with your own image.
  4. Put the game files you changed into your mod folder, at the same paths they have in the game folder. Put paint jobs into Skins\<truck folder>.
  5. Try the mod in the game first, see Testing your mod.
  6. Start the Workshop Uploader from the game folder, select your mod folder, and publish.

The uploader saves a file called .workshop_id in your mod folder. That is how it knows which Workshop item to update next time.

Mod folder layout

your_mod/
├─ mod.cfg            (required, describes your mod)
├─ preview.png        (required, shown on the Workshop page)
├─ Data/
│  ├─ Wav/
│  │  └─ HORN.WAV     (changed file from the Data\Wav subfolder)
│  └─ config/
│     └─ eco.xml      (the game's eco.pkqt, edited, see the notes below)
└─ Skins/
   └─ Freightliner_Argosy/
      └─ My_Paint.dds (a paint job for the Freightliner Argosy)

After the first upload the uploader adds:

├─ .workshop_id       (do not delete or edit)

If you delete .workshop_id, the uploader can no longer find your Workshop item, and publishing again creates a brand new item instead of updating the existing one.

Only three files in the mod folder are never copied into the game: mod.cfg at the top of the folder, .workshop_id, and the preview image named in ~preview_image (preview.png unless you set another name). The Skins folder goes to the paint jobs. Everything else is copied into the game folder, readme and licence files included. So it's better to put notes for players into the Workshop description instead.

The mod.cfg file

One directive per line:

setf ~key value

Lines that do not start with setf are ignored, so you can use them for comments. Values that span several lines, and lists, go in { } braces. If the file contains anything other than Latin letters, save it as UTF-8.

KeyRequiredMeaning
~titleyesName shown on the Workshop, up to 128 characters. A longer title is cut short.
~descriptionnoWorkshop description. Steam BBCode is supported ([b], [list], [url] ...).
~tagsnoWorkshop categories from the list below, each in quotes: {"Vehicles" "Skins"}.
~preview_imagenoFile name of the preview image. Defaults to preview.png. The image itself is required.
~versionnoAny version number you choose, for example 1.0.
~visibilitynopublic, friends or private. Defaults to public.
~prioritynoWhole number, default 0. Negative numbers are allowed. The mod's place in the load order: a higher number loads earlier. See Load order and conflicts.
~exclusiveno1 means the load order ends with this mod: every mod that would load after it is skipped. For total conversions, and for add-ons that must not be combined with anything else.
~conflictsnoWorkshop IDs of mods this mod cannot be used together with, separated by spaces: {3781112928 3794389861}.

Tags

Pick any that fit. Tags are case-sensitive, so write them exactly as shown. Tags only sort mods on the Workshop: a paint job is recognised by the folder it is in, not by its tag.

TagUse for
SkinsTruck paint jobs
VehiclesNew or changed trucks, trailers and other vehicles
TexturesReplaced textures of the world, the vehicles or the interface
AudioSounds, radio and speech
MapsRoads, towns, terrain and objects in the world
MissionsSide missions, dialogues and the story
BalancePrices, pay, cargo, fines, vehicle performance, difficulty
LocalizationTranslations and text changes
UIMenus, fonts, interface graphics
OtherAnything that fits no other tag, for example fixes

Example mod.cfg

setf ~title Night Rider Paint Jobs

setf ~description {
Three dark paint jobs for the Freightliner Argosy and the Sterling 9500.

[b]How to use:[/b]
At a service station open [i]Restyle Vehicle[/i], [i]Exterior Restyle[/i] and pick a paint job in the body colour list.
}

setf ~tags {"Skins"}

setf ~preview_image preview.png

setf ~version 1.0

setf ~visibility public

setf ~priority 0

Preview image

  • PNG or JPG, 512 x 512 pixels works best in the Workshop grid. For a paint job, a screenshot of the truck in the game is the best preview.
  • At most 1 MB.

Other requirements

  • At least one file besides mod.cfg and the preview. For the game to use it, it has to be at the same path as in the game folder, or in the Skins folder for a paint job.
  • Program files (.exe, .dll, .bat, .cmd, and similar) are allowed in Rig'n'Roll mods, see Program files. The uploader lists each one as a warning, so that you can confirm it belongs in the mod.

Load order and conflicts

~priority is the mod's place in the load order, not a measure of how important it is.

  • Mods are loaded from the highest ~priority to the lowest. Mods with the same priority load in the alphabetical order of their Workshop titles.
  • Each mod is copied over the mods loaded before it. When two mods contain the same file, the game gets the version from the mod loaded later. The same holds for two paint jobs with the same name for the same truck.
  • Leave ~priority at 0 for an ordinary mod.
  • An add-on that changes files of another mod needs a lower number than that mod, so that it is copied on top of it. Negative numbers are allowed, so an add-on for an ordinary mod can use -1.
  • A mod made to be extended by add-ons can use a higher number, for example 10, so that add-ons left at 0 land on top of it.
  • When two mods with the same priority change the same file, the order of their titles decides, which is not something you should rely on. Set a priority if the order matters.

~conflicts is for mods that cannot work together at all. When a player is subscribed to both, the one that comes first in the load order (the higher priority) is applied and the other is skipped completely. It is enough for one of the two mods to list the other. The Workshop ID is the number at the end of the item's Workshop page address.

~exclusive 1 ends the load order at this mod: every mod that would load after it (a lower priority) is skipped. Mods that load before it (a higher priority) are still applied. Paint jobs are not affected: they do not change the game's files, so the paint jobs of every mod are installed even when an exclusive mod is active.

  • A total conversion that must run alone sets ~exclusive 1 together with a high priority, for example 1000, so that nothing loads before it either.
  • For a mod and its add-on that together should not be combined with anything else, mark the add-on, the last mod in the chain. If the base mod is exclusive, its own add-ons load after it and are skipped.
  • If a player has several exclusive mods, the one that comes first in the load order ends it.

For example, a player is subscribed to four mods:

Mod~priority~exclusive
Old Roads20
Big Truck Pack10
Winter Edition51add-on for Big Truck Pack
Night Radio0
  • The load order is Old Roads, Big Truck Pack, Winter Edition.
  • Winter Edition is copied over Big Truck Pack, so its version wins every file the two share.
  • Winter Edition is exclusive, so Night Radio, which would load after it, is skipped.
  • Old Roads loads before the exclusive mod and is still applied.

The mod synchronizer can write the load order to a log file: which mods were applied and with how many files, and which were skipped and why. See The log file.

Truck paint jobs

Rig'n'Roll lets you paint every tractor in the game. The game lists the paint jobs it finds in Documents\My Games\RigNRollMySkins\<truck folder> at the service station: Restyle Vehicle tab, Exterior Restyle, in the body colour list. In a single mission the same list is under Select Vehicle, Restyling. In a mod, paint jobs go into the Skins folder, and the mod synchronizer installs them there for every player who subscribes.

  1. Open Documents\My Games\RigNRollMySkins and the folder of the truck you want to paint. It holds the template SampleSkin.dds, the truck's paint in white.
  2. Copy the template, paint over the copy, and save it in the same DDS format and size as the template, with mipmaps. The red, green and blue channels are the colour of the body, the alpha channel is how much the paint reflects. Leave the alpha channel as it is unless you want a matt or a glossier finish.
  3. Give the file the name players will see in the menu: up to 22 characters, Latin letters, digits and _, for example Night_Rider.dds. .tga files are read as well.
  4. Put it into Skins\<truck folder>\ in your mod, for example Skins\Freightliner_Argosy\Night_Rider.dds.

The truck folders are named exactly as in RigNRollMySkins:

Freightliner_Argosy             Hercules_Freedom        Titan_El Dorado
Freightliner_Century            Hercules_Freedom Sport  Titan_Inyo
Freightliner_Century Sport      Hercules_Liberty        Titan_Ventura
Freightliner_Coronado           Sterling_9500           Titan_Ventura Sport
Freightliner_FLD120 classic XL  Sterling_9500 Sport     Western Star_4900 EX
Hercules_Atlas                  Titan_Alpine            Western Star_4900 Sport
  • One mod can carry paint jobs for several trucks, and paint jobs together with game files, for example a truck mod with its own paint jobs. Only Skins\<truck folder>\<name>.dds (or .tga) is installed as a paint job. Anything else in Skins is left out and noted in the log: a file directly in Skins, an unknown folder name, a folder inside a truck folder, another file type, and the name SampleSkin, which belongs to the game.
  • A truck folder at the top of the mod, outside Skins, is not installed anywhere.
  • Paint jobs the player made are not touched. If a mod brings one with the same name, the player's file is kept in the backups and put back when the mod is no longer active.
  • The Chinese and Japanese versions of the game name some truck folders differently. The mod synchronizer takes care of that, so always use the names above.
  • The game reads the list of paint jobs when it starts.

What you can change

A mod can replace any file in the game folder or add new ones, with a few exceptions listed below. The game only reads files it knows by name, so a new file has an effect only when the game or another file refers to it. In practice, new content is made by changing the files that already exist. To change a file, start from a copy of the original, edit it, and put it in your mod folder at the same path.

KindFilesWhat it is
TrucksTrucks\Trucks\<truck>\Models and textures of each tractor, .wdb files.
Other vehiclesTrucks\Semitrailer\ Trucks\Cars\ Trucks\Lorries\ Trucks\Special\Trailers, traffic, service vehicles.
Vehicle dataTrucks\vehicle.tech Trucks\tconfig\ Trucks\Deform\ Technical data of all vehicles, truck configurations, damage models.
Paint jobsSkins\<truck folder>\ in the modSee Truck paint jobs.
The worldGameWorld\California: towns and roads, as models (.wdb), road networks (.way) and scheme files (.sch).
Big RacesMonsterCup\The world of the Big Races add-on, built from the same kinds of files.
Shared objectsCommon\Models used throughout the game.
Game settingsData\config\Economy, cargo, dialogues, particles and other tables. Most are stored as encrypted .pkqt files, see the notes below.
MissionsData\Missions\Side missions of each character: missions, dialogues, radio calls and the organizer (<name>_missions.xml and the files next to it), and the recorded speech (.mp3 with lip-sync .ltf).
TextData\loc\All the text of the game in its language, fonts and text images.
Sounds and radioData\Wav\ Data\FM\Sound effects, and the radio stations.
WeatherData\Weather\Weather, sky and rain. The .ini files are plain text.
CharactersData\Actors\People, their animations and the scenes they play in.
InterfaceData\Menu\ Data\loc\Images\Cursors and interface graphics.
VideoData\video\The intro and the main menu video, Bink files.
Game logicData\scripts.jarThe story, missions and menus, written in Java. A mod that replaces it collides with every other mod that does.

Notes

  • Encrypted files. The game reads many of its files either as plain .xml or as encrypted .pkqt, and stops with a black screen when it finds both. To change a .pkqt file, ship your version as plain .xml under the same name at the same path, for example Data\config\eco.xml for Data\config\eco.pkqt. While the mod is active, the mod synchronizer takes the game's .pkqt out of the folder and keeps it in the backups. It works the other way round too: a .pkqt in a mod takes the place of the game's .xml.
  • Text, mission speech and some menus differ between the language versions of the game. If your mod replaces them, say in the description which language it is for.
  • Keep text files in their original encoding when you save them.
  • Saved games and player profiles are kept in Documents\My Games, not in the game folder, so a mod cannot reset them.

Files the mod synchronizer never replaces

The game does not start, or loses its achievements or its saves, without its own copy of these files. If a mod contains one of them, that file is left out, the rest of the mod is applied, and the log says so:

  • rungame.exe, Bin\rnr.exe, Bin\rnrach.dll, Bin\steam_api.dll and steam_api.dll: the game itself and its Steam achievements.
  • GameWorld\wdb.ini, MonsterCup\wdb.ini, GameWorld\APPNAMEW.txt and MonsterCup\APPNAMEW.txt: how the game finds the Big Races and where it keeps the saves.
  • WorkshopModSync.exe, WorkshopCore.dll, workshop.cfg and the Workshop Backups folder: the Workshop itself.

Program files

The big Rig'n'Roll mods have long come with their own libraries, so Workshop mods for it may contain program files such as .dll or .exe files. The uploader does not refuse them, it lists each one as a warning. Such a file runs with the same rights as the game itself, so players should install mods with program files only from authors they trust. A mod cannot replace the game's own Bin\rnr.exe, see the list above.

Using the Workshop Uploader

Start the uploader from the game's installation folder. It detects the game and shows it at the top of the window, under Publishing to. The window is in Russian on a Russian Windows and in English everywhere else.

  1. Select your mod folder with Browse. The uploader reads mod.cfg, shows the title, tags, content and preview, and checks the folder straight away.
  2. Read the checks. Each line reports one thing: mod.cfg itself, title, tags, priority and the other optional keys, visibility, description, version, preview image, content files and program files. Errors must be fixed. Warnings are there for you to read and do not stop publishing. After changing files, press Check to run the checks again.
  3. When there are no errors, the summary line says Ready to publish.
  4. Publish creates a new Workshop item. For a folder that already has a .workshop_id, the same button reads Update: it uploads a new version of the item you published before, and first asks what changed in this update.
  5. When the upload finishes, a new item's Workshop ID is shown in the summary line, and an Open Workshop page link appears.
The first time you publish, Steam may ask you to accept the Steam Workshop legal agreement, and the uploader tells you so. Until you accept it, your item is not visible to anyone else. Accept it while signed in, at steamcommunity.com/sharedfiles/workshoplegalagreement.

Visibility

  • public: everyone can find and subscribe to the mod.
  • friends: only your Steam friends can see it.
  • private: only you can see it. Useful for testing.

You can change the visibility later, either by editing mod.cfg and updating, or on the item's Workshop page.

Removing a mod

The uploader does not delete Workshop items. To remove one, open its Workshop page while signed in and use the owner controls there.

Testing your mod

You can run your mod from a folder on your disk without uploading anything.

  1. Open workshop.cfg in the game's installation folder, next to rungame.exe. The mod synchronizer and the uploader create this file the first time they run. If it is not there yet, create a text file with that name.
  2. Add one line per mod you want to test:
    setf ~local_mod_folder my_mod C:\path\to\your\mod
    The first word is the mod's name for the log, and it sets its place among mods with the same priority. If it needs spaces, wrap it in braces: {My Mod}. The path may contain spaces and runs to the end of the line.
  3. Start the game from Steam. The folder is applied exactly like a subscribed Workshop item, including its paint jobs and its ~priority, ~exclusive and ~conflicts settings.
  4. Change your files, quit the game and start it from Steam again to see the result.

Mods are applied when the game starts. Changes never take effect in a running game, and if the game is already running, the mod synchronizer leaves everything as it is.

A local folder has no Workshop ID, so other mods cannot name it in their ~conflicts. Its own ~conflicts list works as usual.

If you are also subscribed to the published version of the same mod, both copies are applied, one on top of the other. Unsubscribe from your item while you test the local folder. Remove the line from workshop.cfg when you are done, otherwise your local folder keeps being applied on your machine.

Before going public you can also do a final check through Steam itself: publish with setf ~visibility private, subscribe to your own item, and start the game.

The log file

The mod synchronizer can write a log of every start. It is off by default. To turn it on, change this line in workshop.cfg:

setf ~logging 1

From the next start, the mod synchronizer writes WorkshopModSync_log.txt into the game folder, anew on every start. The lines starting with [workshop] list your subscriptions and those still downloading. The lines starting with [mods] show the load order: every applied mod with its priority and number of files, the paint jobs of each mod, and every skipped mod with the reason. The lines starting with [overlay] show the files taken back from the previous start, the files left out of a mod and why, and the game's files taken out for a mod. If a mod does not seem to do anything, this is the first place to look.

The Workshop Backups folder in the game folder, and the one in Documents\My Games\RigNRollMySkins, hold the files that mods have replaced, together with the mod synchronizer's list of what it has put in. They are managed automatically. Do not edit or delete them.

For players: installing mods

  1. Open the game's Workshop page on Steam and press Subscribe on the mods you want.
  2. Let Steam finish downloading them.
  3. Start the game from Steam. No other step is needed.

To remove a mod, unsubscribe and start the game from Steam again. If a mod was still downloading when you started the game, it becomes active on the next start.

A paint job from a mod appears at the service station, under Restyle Vehicle, Exterior Restyle, in the body colour list of the truck it is made for.

Mods are put into the game folder and taken out again only when the game is started from Steam. If you start rungame.exe directly, the game runs with the mods that were active on the last start from Steam.

If you let Steam verify the game files, start the game from Steam once more afterwards, and your mods are applied again.

Common problems

What you seeWhat to do
Game not identifiedStart the uploader from the game's installation folder. It does not work when copied elsewhere.
Steam is not running, or you are not signed inStart Steam, sign in, then start the uploader again.
You do not own this gamePublish from a Steam account that owns it.
Unknown tagsUse only the tags from the list above, spelled exactly the same.
Preview file not found, or too largePut the image next to mod.cfg under the name given in ~preview_image, and keep it at or below 1 MB.
~priority must be a whole numberWrite a number without spaces or other characters, for example 5 or -1.
~conflicts takes Workshop IDsList the other mods by their Workshop ID numbers, not by their titles.
Unknown key in mod.cfgCheck the spelling of the key against the table above.
Executable found (warning)Program files are allowed in Rig'n'Roll mods. Make sure every listed file belongs in your mod, and remove leftovers.
Your item is not visible to othersAccept the Workshop legal agreement, and check that the visibility is public.
The mod is subscribed but nothing changes in the gameStart the game from Steam, not with rungame.exe. Then turn on the log. Most often a file is not at the same path as in the game, a mod loaded later replaces the same file, the mod was skipped because of a conflict or an exclusive mod, or it was still downloading.
A paint job is not in the body colour listCheck that it is in Skins\<truck folder>\ under one of the names listed above, that it is a .dds or .tga file with a name of at most 22 characters, and that you are looking at the truck it is made for. The log names every file it left out of Skins and why.
A file of the mod is not installed, the log says "the game does not start without its own copy of this file"It is one of the files the mod synchronizer never replaces, see What you can change.
Black screen when the game startsThe game found the same file twice, as .xml and as .pkqt. Start the game from Steam: the mod synchronizer takes the game's copy out again. This happens after Steam verifies the game files, if the game is then started with rungame.exe. If the log says that the game's file "could not be taken out", close any program that has it open.

Rig'n'Roll Gold Edition: руководство по Мастерской

Это руководство объясняет, как устроены моды в Rig'n'Roll Gold Edition ("Дальнобойщики 3: Покорение Америки"): как собрать мод, и как опубликовать мод в Мастерской Steam с помощью загрузчика Workshop Uploader, который поставляется вместе с игрой.

  1. Как работают моды
  2. Что понадобится
  3. Быстрый старт
  4. Структура папки мода
  5. Файл mod.cfg
  6. Порядок загрузки и конфликты
  7. Окраски грузовиков
  8. Что можно изменить
  9. Работа с Workshop Uploader
  10. Проверка мода
  11. Для игроков: установка модов
  12. Частые проблемы

Как работают моды

Мод состоит из папки с файлами игры, разложенными так же, как в папке установки игры, и небольшого текстового файла mod.cfg с описанием мода. Ещё мод может нести окраски грузовиков в отдельной папке, см. Окраски грузовиков.

При запуске игры из Steam сначала работает синхронизатор модов WorkshopModSync.exe. Он убирает всё, что положил при прошлом запуске, копирует в папку игры файлы модов, на которые вы подписаны, и только после этого запускает игру. Файл из мода заменяет файл игры, лежащий по тому же пути, а файл, которого в игре нет, добавляется. Заменённые файлы игры сохраняются в папке Workshop Backups и возвращаются на место при первом запуске после того, как мод перестал быть активным. Отпишитесь от мода, снова запустите игру из Steam, и всё вернётся к исходному состоянию. С окрасками всё происходит так же, только в той папке, где их ищет игра.

Отсюда три правила, которые стоит помнить с самого начала:

  • Файлы сопоставляются по пути внутри папки игры. Data\Wav\HORN.WAV в моде заменяет Data\Wav\HORN.WAV в игре. Тот же файл, положенный прямо в корень папки мода, окажется в корне папки игры, где игра его не ищет. Регистр букв значения не имеет.
  • Файл заменяется целиком. Игра хранит много объектов в одном файле: грузовик состоит из нескольких файлов .wdb в своей папке в Trucks\Trucks, все виды грузов описаны одной таблицей в Data\config. Чтобы изменить что-то одно, в мод придётся положить весь файл. Два мода, которые меняют один и тот же файл, совместить нельзя: в игру попадёт только одна его версия.
  • Кладите в мод только то, что изменили. Чем меньше в моде файлов, тем реже он пересекается с другими модами.

Что понадобится

  • Игра, установленная через Steam, и запущенный клиент Steam, в котором выполнен вход в аккаунт, от имени которого вы будете публиковать мод. Игра должна быть на этом аккаунте.
  • Workshop Uploader: файл Workshop Uploader GUI - Rig'n'Roll Gold Edition.exe в папке установки игры, рядом с rungame.exe. Не перемещайте его: он работает только из папки игры.
  • Папка Mod Template оттуда же. В ней лежат готовый к правке mod.cfg и картинка-заглушка для превью.
  • Большинство файлов игры хранится в двоичных форматах (модели, текстуры, упакованные таблицы), и для их правки нужны соответствующие инструменты. Для окраски достаточно графического редактора, который умеет сохранять файлы DDS.

Быстрый старт

  1. Скопируйте папку Mod Template в любое место вне папки игры и дайте копии название своего мода.
  2. Откройте mod.cfg и заполните как минимум ~title.
  3. Замените preview.png своей картинкой.
  4. Положите изменённые файлы игры в папку мода, по тем же путям, по которым они лежат в папке игры. Окраски кладите в Skins\<папка с названием грузовика>.
  5. Сначала проверьте мод в игре, см. Проверка мода.
  6. Запустите Workshop Uploader из папки игры, выберите папку мода и опубликуйте его.

Загрузчик сохраняет в папке мода файл .workshop_id. По нему он в следующий раз узнаёт, какой мод в Мастерской обновлять.

Структура папки мода

your_mod/
├─ mod.cfg            (обязательно, описание мода)
├─ preview.png        (обязательно, картинка на странице в Мастерской)
├─ Data/
│  ├─ Wav/
│  │  └─ HORN.WAV     (изменённый файл из подпапки Data\Wav)
│  └─ config/
│     └─ eco.xml      (изменённый eco.pkqt игры, см. замечания ниже)
└─ Skins/
   └─ Freightliner_Argosy/
      └─ My_Paint.dds (окраска для Freightliner Argosy)

После первой загрузки загрузчик добавляет:

├─ .workshop_id       (не удаляйте и не редактируйте)

Если удалить .workshop_id, загрузчик больше не найдёт ваш мод в Мастерской, и следующая публикация создаст новый мод вместо обновления существующего.

Только три файла из папки мода никогда не копируются в игру: mod.cfg в корне папки, .workshop_id и картинка превью, указанная в ~preview_image (по умолчанию preview.png). Папка Skins идёт в окраски. Всё остальное копируется в папку игры, в том числе файлы readme и лицензии. Пэтому пояснения для игроков лучше пишите в описании мода в Мастерской.

Файл mod.cfg

Одна директива на строку:

setf ~key value

Строки, которые не начинаются с setf, игнорируются, поэтому их можно использовать для комментариев. Многострочные значения и списки заключаются в фигурные скобки { }. Если в файле есть русские буквы, сохраните его в кодировке UTF-8.

КлючОбязателенЗначение
~titleдаНазвание в Мастерской, до 128 символов. Более длинное название будет обрезано.
~descriptionнетОписание в Мастерской. Поддерживается Steam BBCode ([b], [list], [url] ...).
~tagsнетКатегории Мастерской из списка ниже, каждая в кавычках: {"Vehicles" "Skins"}.
~preview_imageнетИмя файла картинки превью. По умолчанию preview.png. Сама картинка обязательна.
~versionнетПроизвольно указанная вами версия, например 1.0.
~visibilityнетpublic, friends или private. По умолчанию public.
~priorityнетЦелое число, по умолчанию 0, отрицательные тоже допустимы. Место мода в порядке загрузки: чем больше число, тем раньше загружается мод. Подробнее в разделе Порядок загрузки и конфликты.
~exclusiveнет1 означает, что порядок загрузки заканчивается на этом моде: все моды, которые загрузились бы после него, пропускаются. Для тотальных конверсий и для дополнений, которые нельзя сочетать ни с чем другим.
~conflictsнетНомера в Мастерской (Workshop ID) модов, с которыми этот мод несовместим, через пробел: {3781112928 3794389861}.

Теги

Выберите подходящие. Теги чувствительны к регистру, пишите их точно так, как в таблице. Теги только помогают искать моды в Мастерской: окраску синхронизатор модов узнаёт по папке, в которой она лежит, а не по тегу.

ТегДля чего
SkinsОкраски грузовиков
VehiclesНовые или изменённые грузовики, прицепы и другие машины
TexturesЗаменённые текстуры мира, машин или интерфейса
AudioЗвуки, радио и речь
MapsДороги, города, рельеф и объекты мира
MissionsПобочные задания, диалоги и сюжет
BalanceЦены, оплата, грузы, штрафы, характеристики машин, сложность
LocalizationПереводы и изменения текста
UIМеню, шрифты, графика интерфейса
OtherВсё, что не подходит под другие теги, например исправления

Пример mod.cfg

setf ~title Ночной гонщик

setf ~description {
Три тёмные окраски для Freightliner Argosy и Sterling 9500.

[b]Как включить:[/b]
На СТО откройте [i]Рестайл машины[/i], [i]Рестайл внешнего вида[/i] и выберите окраску в списке цветов кузова.
}

setf ~tags {"Skins"}

setf ~preview_image preview.png

setf ~version 1.0

setf ~visibility public

setf ~priority 0

Картинка превью

  • PNG или JPG, лучше всего 512 x 512 пикселей: так она хорошо смотрится в сетке Мастерской. Для окраски лучшее превью - снимок грузовика в игре.
  • Не больше 1 МБ.

Другие требования

  • Хотя бы один файл помимо mod.cfg и превью. Чтобы игра его использовала, он должен лежать по тому же пути, что и в папке игры, а окраска - в папке Skins.
  • Программные файлы (.exe, .dll, .bat, .cmd, и подобные) в модах для Rig'n'Roll допускаются, см. Программные файлы. Загрузчик показывает каждый такой файл как предупреждение, чтобы вы убедились, что он действительно нужен моду.

Порядок загрузки и конфликты

~priority задаёт место мода в порядке загрузки, а не его важность.

  • Моды загружаются от наибольшего ~priority к наименьшему. Моды с одинаковым приоритетом загружаются в алфавитном порядке их названий в Мастерской.
  • Каждый мод копируется поверх загруженных до него. Если один и тот же файл есть в двух модах, в игре окажется версия мода, загруженного позже. Так же и с двумя окрасками одного грузовика с одинаковым именем.
  • Для обычного мода оставьте ~priority равным 0.
  • Дополнению, которое меняет файлы другого мода, нужно число меньше, чем у этого мода, чтобы оно копировалось поверх него. Отрицательные числа допустимы, так что дополнению к обычному моду подойдёт -1.
  • Мод, к которому задуманы дополнения, может получить приоритет побольше, например 10. Тогда дополнения с приоритетом 0 окажутся поверх него.
  • Если два мода с одинаковым приоритетом меняют один и тот же файл, всё решит порядок их названий, а на него лучше не полагаться. Если порядок важен, задайте приоритет.

~conflicts нужен для модов, которые вообще не могут работать вместе. Если игрок подписан на оба, применяется тот, что стоит раньше в порядке загрузки (с большим приоритетом), а второй пропускается целиком. Достаточно, чтобы один из двух модов указал другой. Номер в Мастерской стоит в конце адреса страницы мода.

~exclusive 1 заканчивает порядок загрузки на этом моде: все моды, которые загрузились бы после него (с меньшим приоритетом), пропускаются. Моды, которые загружаются раньше (с большим приоритетом), всё равно применяются. На окраски это не влияет: они не меняют файлы игры, поэтому окраски всех модов ставятся, даже когда активен исключительный мод.

  • Тотальной конверсии, которая должна работать одна, нужен ~exclusive 1 вместе с высоким приоритетом, например 1000, чтобы и до неё ничего не загружалось.
  • Если мод и дополнение к нему не должны сочетаться ни с чем другим, помечайте дополнение, последний мод в цепочке. Если исключительным сделать базовый мод, его собственные дополнения загрузятся после него и будут пропущены.
  • Если у игрока несколько исключительных модов, порядок загрузки заканчивает тот, что стоит в нём раньше.

Например, игрок подписан на четыре мода:

Мод~priority~exclusive
Старые дороги20
Большой набор фур10
Зимняя версия51дополнение к "Большому набору фур"
Ночное радио0
  • Порядок загрузки: "Старые дороги", "Большой набор фур", "Зимняя версия".
  • "Зимняя версия" копируется поверх "Большого набора фур", поэтому в каждом общем файле остаётся её версия.
  • "Зимняя версия" исключительная, поэтому "Ночное радио", которое загрузилось бы после неё, пропускается.
  • "Старые дороги" загружаются раньше исключительного мода и всё равно применяются.

Синхронизатор модов может записывать порядок загрузки в лог: какие моды применены и сколько в каждом файлов, какие пропущены и почему. См. Файл лога.

Окраски грузовиков

В Rig'n'Roll можно перекрасить любой тягач. Окраски, которые игра находит в Документы\My Games\RigNRollMySkins\<папка с названием грузовика>, появляются на СТО: вкладка Рестайл машины, Рестайл внешнего вида, список цветов кузова. В режиме "Один заказ" тот же список находится в Выбрать машину, Рестайл. В моде окраски кладутся в папку Skins, и синхронизатор модов ставит их туда у каждого игрока, подписанного на мод.

  1. Откройте Документы\My Games\RigNRollMySkins и папку с названием грузовика, который хотите перекрасить. В ней лежит эталонный файл SampleSkin.dds, окраска этого грузовика в белом цвете.
  2. Скопируйте эталон, перекрасьте копию и сохраните её в том же формате DDS и того же размера, что и эталон, с MIP-уровнями. Красный, зелёный и синий каналы задают цвет кузова, альфа-канал - то, насколько краска отражает свет. Альфа-канал оставьте как есть, если не хотите сделать краску матовой или более глянцевой.
  3. Назовите файл так, как игроки увидят его в меню: не больше 22 символов, латинские и русские буквы, цифры и _, например Night_Rider.dds. Файлы .tga игра тоже читает.
  4. Положите его в папку мода Skins\<папка с названием грузовика>\, например Skins\Freightliner_Argosy\Night_Rider.dds.

Папки грузовиков называются точно так же, как в RigNRollMySkins:

Freightliner_Argosy             Hercules_Freedom        Titan_El Dorado
Freightliner_Century            Hercules_Freedom Sport  Titan_Inyo
Freightliner_Century Sport      Hercules_Liberty        Titan_Ventura
Freightliner_Coronado           Sterling_9500           Titan_Ventura Sport
Freightliner_FLD120 classic XL  Sterling_9500 Sport     Western Star_4900 EX
Hercules_Atlas                  Titan_Alpine            Western Star_4900 Sport
  • Один мод может нести окраски для нескольких грузовиков, а также окраски вместе с файлами игры, например мод грузовика с собственными окрасками. Окраской считается только Skins\<папка с названием грузовика>\<имя>.dds (или .tga). Всё остальное в Skins не ставится, и об этом есть запись в логе: файл прямо в Skins, неизвестное имя папки, папка внутри папки грузовика, файл другого типа и имя SampleSkin, которое занято игрой.
  • Папка с названием грузовика в корне мода, вне Skins, никуда не ставится.
  • Окраски, сделанные самим игроком, не трогаются. Если мод приносит окраску с тем же именем, файл игрока сохраняется в резервной копии и возвращается, когда мод перестаёт быть активным.
  • В китайской и японской версиях игры некоторые папки грузовиков называются иначе. Синхронизатор модов это учитывает, поэтому всегда используйте имена из списка выше.
  • Список окрасок игра читает при запуске.

Что можно изменить

Мод может заменить любой файл в папке игры или добавить новые, за немногими исключениями, перечисленными ниже. Игра читает только файлы, которые знает по имени, поэтому новый файл работает только тогда, когда на него ссылается игра или другой файл. На практике новое содержимое делается правкой уже существующих файлов. Чтобы изменить файл, возьмите копию оригинала, отредактируйте её и положите в папку мода по тому же пути.

ЧтоФайлыОписание
ГрузовикиTrucks\Trucks\<грузовик>\Модели и текстуры каждого тягача, файлы .wdb.
Другие машиныTrucks\Semitrailer\ Trucks\Cars\ Trucks\Lorries\ Trucks\Special\Прицепы, транспорт на дорогах, служебные машины.
Данные машинTrucks\vehicle.tech Trucks\tconfig\ Trucks\Deform\ Технические данные всех машин, комплектации грузовиков, модели повреждений.
ОкраскиSkins\<папка грузовика>\ в модеСм. Окраски грузовиков.
МирGameWorld\Калифорния: города и дороги в виде моделей (.wdb), дорожных сетей (.way) и файлов схем (.sch).
Большие гонкиMonsterCup\Мир дополнения "Большие гонки", собранный из тех же видов файлов.
Общие объектыCommon\Модели, которые используются по всей игре.
Настройки игрыData\config\Экономика, грузы, диалоги, частицы и другие таблицы. Большинство хранится в зашифрованных файлах .pkqt, см. замечания ниже.
ЗаданияData\Missions\Побочные задания каждого персонажа: задания, диалоги, звонки и органайзер (<имя>_missions.xml и файлы рядом с ним), и записанная речь (.mp3 с файлами синхронизации губ .ltf).
ТекстData\loc\Весь текст игры на её языке, шрифты и картинки с текстом.
Звуки и радиоData\Wav\ Data\FM\Звуковые эффекты и радиостанции.
ПогодаData\Weather\Погода, небо и дождь. Файлы .ini - обычный текст.
ПерсонажиData\Actors\Люди, их анимации и сцены с их участием.
ИнтерфейсData\Menu\ Data\loc\Images\Курсоры и графика интерфейса.
ВидеоData\video\Вступительный ролик и видео главного меню, файлы Bink.
Логика игрыData\scripts.jarСюжет, задания и меню, написанные на Java. Мод, который его заменяет, конфликтует с любым другим модом, который делает то же.

Замечания

  • Зашифрованные файлы. Многие свои файлы игра читает либо как обычный .xml, либо как зашифрованный .pkqt, а найдя оба, останавливается с чёрным экраном. Чтобы изменить файл .pkqt, положите свою версию обычным .xml с тем же именем и по тому же пути, например Data\config\eco.xml для Data\config\eco.pkqt. Пока мод активен, синхронизатор модов убирает .pkqt игры из папки и хранит его в резервной копии. Это работает и в обратную сторону: .pkqt из мода занимает место .xml игры.
  • Текст, речь в заданиях и некоторые меню в разных языковых версиях игры различаются. Если ваш мод их заменяет, укажите в описании, для какого языка он сделан.
  • Сохраняйте текстовые файлы в их исходной кодировке.
  • Сохранения и профили игроков хранятся в Документы\My Games, а не в папке игры, поэтому мод не может их сбросить.

Файлы, которые синхронизатор модов никогда не заменяет

Без собственной копии этих файлов игра не запускается, теряет достижения или сохранения. Если такой файл есть в моде, он не ставится, остальной мод применяется, а в логе об этом есть запись:

  • rungame.exe, Bin\rnr.exe, Bin\rnrach.dll, Bin\steam_api.dll и steam_api.dll: сама игра и её достижения Steam.
  • GameWorld\wdb.ini, MonsterCup\wdb.ini, GameWorld\APPNAMEW.txt и MonsterCup\APPNAMEW.txt: как игра находит "Большие гонки" и где хранит сохранения.
  • WorkshopModSync.exe, WorkshopCore.dll, workshop.cfg и папка Workshop Backups: на них работает сама Мастерская.

Программные файлы

Крупные моды для Rig'n'Roll давно поставляются с собственными библиотеками, поэтому моды для неё в Мастерской могут содержать программные файлы, например .dll или .exe. Загрузчик не отказывает в публикации, а показывает каждый такой файл как предупреждение. Такой файл запускается с теми же правами, что и сама игра, поэтому устанавливать моды с программными файлами стоит только от авторов, которым вы доверяете. Заменить собственный Bin\rnr.exe игры мод не может, см. список выше.

Работа с Workshop Uploader

Запустите загрузчик из папки установки игры. Он сам определяет игру и показывает её вверху окна, под надписью Публикация для. Окно загрузчика на русском, если Windows русская, и на английском в остальных случаях.

  1. Выберите папку мода кнопкой Обзор. Загрузчик прочитает mod.cfg, покажет название, теги, содержимое и превью и сразу проверит папку.
  2. Прочитайте результаты проверки. Каждая строка сообщает об одном: сам mod.cfg, название, теги, приоритет и другие необязательные ключи, видимость, описание, версия, картинка превью, файлы мода и программные файлы. Ошибки нужно исправить. Предупреждения нужно прочитать, публиковать они не мешают. После правки файлов нажмите Проверить, чтобы запустить проверку заново.
  3. Когда ошибок нет, в итоговой строке написано Готов к публикации.
  4. Опубликовать создаёт новый мод в Мастерской. Если в папке уже есть .workshop_id, та же кнопка называется Обновить: она загружает новую версию ранее опубликованного мода и сначала спрашивает, что изменилось в этом обновлении.
  5. Когда загрузка закончится, для нового мода в итоговой строке появится его номер в Мастерской, а рядом ссылка Открыть страницу в Мастерской.
При первой публикации Steam может попросить принять соглашение Мастерской Steam, и загрузчик об этом сообщит. Пока вы его не примете, мод не виден никому, кроме вас. Примите соглашение, войдя в аккаунт, по адресу steamcommunity.com/sharedfiles/workshoplegalagreement.

Видимость

  • public: мод могут найти все и подписаться на него.
  • friends: мод видят только ваши друзья в Steam.
  • private: мод видите только вы. Удобно для проверки.

Видимость можно поменять и потом: в mod.cfg с последующим обновлением или на странице мода в Мастерской.

Удаление мода

Загрузчик не удаляет моды из Мастерской. Чтобы удалить мод, откройте его страницу в Мастерской, войдя в аккаунт, и воспользуйтесь кнопками управления для владельца.

Проверка мода

Мод можно запустить прямо из папки на диске, ничего не загружая.

  1. Откройте workshop.cfg в папке установки игры, рядом с rungame.exe. Синхронизатор модов и загрузчик создают этот файл при первом запуске. Если его ещё нет, создайте текстовый файл с таким именем.
  2. Добавьте по строке на каждый мод, который хотите проверить:
    setf ~local_mod_folder my_mod C:\path\to\your\mod
    Первое слово задаёт имя мода для лога, и от него зависит место мода среди модов с тем же приоритетом. Если в имени нужны пробелы, заключите его в фигурные скобки: {My Mod}. Путь может содержать пробелы и занимает всю оставшуюся строку.
  3. Запустите игру из Steam. Папка применяется точно так же, как мод из Мастерской, вместе с окрасками и с учётом её ~priority, ~exclusive и ~conflicts.
  4. Правьте файлы, выходите из игры и снова запускайте её из Steam, чтобы увидеть результат.

Моды применяются при запуске игры. Изменения никогда не подхватываются уже запущенной игрой, а если игра уже запущена, синхронизатор модов оставляет всё как есть.

У локальной папки нет номера в Мастерской, поэтому другие моды не могут указать её в своём ~conflicts. Её собственный список ~conflicts работает как обычно.

Если вы одновременно подписаны на опубликованную версию того же мода, применятся обе копии, одна поверх другой. Пока проверяете локальную папку, отпишитесь от своего мода. Закончив, удалите строку из workshop.cfg, иначе локальная папка так и будет применяться на вашем компьютере.

Перед открытой публикацией можно проверить мод и через сам Steam: опубликуйте его с setf ~visibility private, подпишитесь на него и запустите игру.

Файл лога

Синхронизатор модов умеет записывать лог каждого запуска. По умолчанию запись выключена. Чтобы включить её, измените эту строку в workshop.cfg:

setf ~logging 1

Со следующего запуска синхронизатор модов будет записывать в папку игры файл WorkshopModSync_log.txt, каждый раз заново. Строки, начинающиеся с [workshop], перечисляют ваши подписки и те из них, что ещё скачиваются. Строки с [mods] показывают порядок загрузки: каждый применённый мод с его приоритетом и числом файлов, окраски каждого мода и каждый пропущенный мод с причиной. Строки с [overlay] показывают файлы, убранные после прошлого запуска, файлы мода, которые не поставлены, с причиной, и файлы игры, убранные ради мода. Если мод, кажется, ничего не делает, смотрите сначала сюда.

Папка Workshop Backups в папке игры и такая же папка в Документы\My Games\RigNRollMySkins хранят файлы, заменённые модами, и список того, что положил туда синхронизатор модов. Он управляет этими папками сам. Не редактируйте и не удаляйте их.

Для игроков: установка модов

  1. Откройте страницу игры в Мастерской Steam и нажмите Подписаться на нужных модах.
  2. Дождитесь, пока Steam их скачает.
  3. Запустите игру из Steam. Больше ничего делать не нужно.

Чтобы убрать мод, отпишитесь от него и снова запустите игру из Steam. Если во время запуска игры мод ещё скачивался, он заработает со следующего запуска.

Окраска из мода появляется на СТО: Рестайл машины, Рестайл внешнего вида, в списке цветов кузова того грузовика, для которого она сделана.

Моды кладутся в папку игры и убираются из неё только при запуске игры из Steam. Если запустить rungame.exe напрямую, игра будет работать с модами, которые были активны при последнем запуске из Steam.

Если вы проверили целостность файлов игры в Steam, запустите после этого игру из Steam ещё раз, и моды применятся снова.

Частые проблемы

Что вы видитеЧто делать
Игра не определенаЗапустите загрузчик из папки установки игры. Скопированный в другое место, он не работает.
Steam не запущен или вы не вошли в SteamЗапустите Steam, войдите в аккаунт и снова откройте загрузчик.
Этой игры нет в вашем аккаунтеПубликуйте из аккаунта Steam, на котором есть игра.
Неизвестные тегиИспользуйте только теги из списка выше, написанные точно так же.
Файл превью не найден, или превью слишком большоеПоложите картинку рядом с mod.cfg под именем из ~preview_image и уменьшите её до 1 МБ или меньше.
~priority должен быть целым числомНапишите число без пробелов и других символов, например 5 или -1.
~conflicts принимает номера из МастерскойУказывайте другие моды их номерами в Мастерской, а не названиями.
Неизвестный ключ в mod.cfgСверьте написание ключа с таблицей выше.
Найден исполняемый файл (предупреждение)В модах для Rig'n'Roll программные файлы разрешены. Убедитесь, что каждый файл из списка действительно нужен моду, и уберите лишнее.
Мод не виден другим игрокамПримите соглашение Мастерской и проверьте, что видимость public.
Подписка есть, но в игре ничего не меняетсяЗапускайте игру из Steam, а не через rungame.exe. Затем включите лог. Чаще всего файл лежит не по тому же пути, что в игре, тот же файл заменяет мод, загруженный позже, мод пропущен из-за конфликта или исключительного мода, или он ещё скачивался.
Окраски нет в списке цветов кузоваПроверьте, что она лежит в Skins\<папка с названием грузовика>\ под одним из имён из списка выше, что это файл .dds или .tga с именем не длиннее 22 символов и что вы смотрите на тот грузовик, для которого она сделана. В логе перечислен каждый файл из Skins, который не поставлен, с причиной.
Файл мода не поставлен, в логе написано "the game does not start without its own copy of this file"Это один из файлов, которые синхронизатор модов никогда не заменяет, см. Что можно изменить.
Чёрный экран при запуске игрыИгра нашла один и тот же файл дважды, как .xml и как .pkqt. Запустите игру из Steam: синхронизатор модов снова уберёт копию игры. Так бывает после проверки целостности файлов в Steam, если затем запустить игру через rungame.exe. Если в логе написано, что файл игры "could not be taken out", закройте программу, в которой он открыт.