Modding:The Remapper

Эта страница проверялась в последний раз для версии Vintage Story 1.15.

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

Допустим, пользователь хочет создать ваш мод в Uberbasket. Вы хотели бы написать рецепт, который сообщает игре, какой предмет должен быть создан. Это делается путем ссылки на уникальный код элемента - последовательность букв, обычно написанное слово, разделенное тире.

Однако эти коды хранятся не очень эффективно, и поэтому, чтобы уменьшить использование памяти, движок внутренне присваивает каждому элементу и блоку уникальный номер для каждого мира, а затем сохраняет сопоставление кода с идентификатором в сохраненной игре. Эти идентификаторы создаются, когда игра загружает блоки и предметы, и после создания никогда не удаляются из сопоставления. Вот так, просто чтобы дать вам представление.

Code	Id
stick	1
coal	2
ingot-iron	3
...	...

Сохранение этого отображения в сейве необходимо, потому что иначе, если добавить новый блок, например, перед палкой, нумерация изменится, и вдруг каждая палка в мире превратится в уголь, каждый железный слиток станет углем. и так далее. Новые блоки могут добавляться и удаляться либо при выходе новой версии, либо при добавлении или удалении модов пользователем.

So how does this affect you, the modder?

Well, the issue arises when you decide to change the code of a block or item. Or when a user wants to remove one of your mods and have the now modded blocks replaced with something else. Let's say your mod added the Uberbasket, but you realize it was not powerful enough and changed it into the Hyperbasket, including its item code, in your latest mod update. As soon as a player updates to your latest version of the mod, all their Uberbaskets will become unknown items, because, remember, the code<->id mapping for the uberbasket is still stored in the savegame.

Thankfully you can help the player fix this! There are commands (/bir and /iir) that let you edit this table. In this case, the player would need to type

/iir remap hyperbasket uberbasket force

What this command effectively does, is to search for "uberbasket" in the mapping table, then replace the id with the hyperbasket id. And so, upon world reload all the uberbaskets will have turned into hyperbaskets.

The remaps.json

For even greater player convenience. You can create a json patch to add an entry to assets/game/config/remaps.json. This file lets you add your remaps and the player will get a user friendly dialog popping up that remappings are required. You might want to use the "remapq" subcommand to reduce chat log spam.

Can I remap 2 blocks/items into 1 block/item

No. By definition, all ids must be unique. If you were to remap 2 to 1, it would mean an item or block would have 2 ids. The game was not designed to handle multiple ids for the same block or item.

Wondering where some links have gone?
The modding navbox is going through some changes! Check out Navigation Box Updates for more info and help finding specific pages.