Modding:Modding Efficiently

This page was last verified for Vintage Story version 1.19.

Modding and game development usually requires lots of trial and error. The more time you can save on those iterations the better, as it accumulates quickly. Besides being quick to start up, VS offers a bundle of tricks to help you mod fast and efficiently. Here are some of the tricks every serious modder should use.

Shortcuts

• Use macros! Switching from/to creative/survival mode and /time set day bound to a keyboard shortcut is a must have. Hit CTRL+M to open the macro manager which will let you set those up!
• When you edit textures and shape files - these can be reloaded without restart using the commands .reload textures and .reload shapes. The latter may require you to place and remove a block so that the chunk gets redrawn
• Translation entries can be reloaded with .reload lang, the handbook can be reloaded with .debug reloadhandbook
• Set up a quickstart.bat script, that contains e.g. VintageStory.exe -oTestWorld -pcreativebuilding - this will launch you into a super flat creative world named "TestWorld"
• Do not fully restart the game to test out changes! In 95% of cases its enough to just leave the game world and rejoin or use the in game reload commands. You can quickly reload a world using the shortcut CTRL+F1
• Leave your mod unpacked in the mods folder! No need to zip it up, it'll load up just fine unpacked
• Use .tfedit to modify the looks of your item/block inside the GUI, hands or on the ground - with a live preview
• Use .bsedit to edit block selection and collisionboxes in game - with a live preview.
• Use the /debug expclang command to generate a neatly pre-formatted list of language entries destined for your en.json, it's placed in a file named collectiblelang.json in the same folder where VintageStory.exe is. It creates language entries for any block or item that currently has no translation. This can save you a ton of time by not needing to handwrite your translation file.
• If you modify a json file and want to include only the changes in your mod, you can create a JSON patch. Usually you can even save the time writing it yourself by using the ModMaker 3000™, a command line tool that ships with the game, to build the patches for you

Finding Issues

• If you are stuck with an asset problem, look through the server-main.txt and client-main.txt! The engine is very verbose when it comes to asset errors.
• Permanently enable the error reporter via /errorreporter 1 to save yourself the work of finding and scouring through the log files for problems. This feature will make it so that a dialog pop ups during after up of the game if any errors were encountered.

When writing C# mods

• Use break points for debugging
• Browse through the many utility classes provided by the VS API, you might be able to save a lot of coding efforts! (e.g. ColorUtil, GameMath, ArrayExtensions, DictExtensions, HashsetExtensions, JsonUtil, ReaderWriterExtensions, SerializerUtil, WildcardUtil)
• The LINQ extension, part of the .net framework, is an extremely powerful tool to make code more expressive.
• Use the Hot reload feature of Visual Studio to modify code while the game is running, to see your changes immediately without restarting the world.
  • Note that this feature works if you use the official mod template and set up your mod as a "compiled" mod. It does not work if you set up your mod as a "source" mod, and it may not work with all other development environment setups.
• If you have not already, make sure the game's log output ends up in the Visual Studio output window
• If you are working with shaders, you can reload them with .reload shaders
• Do not hold static references unless its primitive data. Static references are not garbage collected when the player leaves a server / game world. Example: Holding a static reference of a Block will keep that block in memory, which in turn keeps the API Instance in memory, which in turn keeps the entire game world in memory.
• The game client and server have a number of startup arguments to make your live easier

Efficient Search Methods

More often than not, you'd want your code to find something in the game world. As you might already know, computers are not exactly the best at parallel processing like human eyes are, so they have to sequentially look through the entire search space. When doing so, keep in mind that, first and foremost, the most efficient search method is one that never runs, within a search space that is of size zero.
In other words, sometimes you can avoid searches altogether through other clever means! If you still need to do a search, here's some more optimal ways than the brute force way:

• Entity Search
  Use EntityPartitioning - api.ModLoader.GetModSystem<EntityPartitioning>().WalkEntityPartitions(). This system partitions entities into 8x8x8 block buckets through the entire loaded game world, then only searches inside those buckets, within your supplied search radius, greatly reducing the search space.
• Block Search
  a) If you want an entity to find a certain, not extremely common block, use the POI Registry. This registry lets block entities register a point of interest that entities can search through very efficiently. They are also partitioned into chunk column buckets to additionally reduce the search space. For a code sample, check out the berry bush block entity
  b) For regular full chunk scans, I recommend a separate background thread that loads the chunk and accesses the raw block data via chunk.Blocks. It is an array indexed with (y * chunksize + z) * chunksize + x, where the x, y, and z are local coordinates from 0 to chunkize-1. You should only write to a chunk in the main thread however! If you want to avoid threading for now, you can still iterate through chunk.Blocks in the main thread and even slice up the task across multiple ticks, like vanilla beehives do.
  c) For rare area scans, there is api.World.GetBlockAccessorPrefetch(). This block accessor lets you pre-load an area and then rather efficiently iterate through each block in given area

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.