sm.interop

What is sm.interop?

At first glance, sm.interop does not seem to add much to the game. But appearances are deceptive. sm.interop is a dependency for other mods, and it allows those mods to make complex scripted parts and custom tools, that work together well with other mods that use sm.interop.

The mod consists of two parts: a workshop part and a game file part. The game file part needs to be installed manually.

Game file mods that change tools or scripts may not be compatible with sm.interop. However, most of those mods can be re-written to work together with sm.interop. If you are a developer of a game file mod and need help with rewriting your mod to work with sm.interop, do not hesitate to contact Xesau#1681 on Discord.

Features list

Workshop part

• Custom connection types

• Event system

• Mod startup scripts

• Permission API

• Scheduling API

Game file part

• Custom chat commands

• Custom tools

• Access to game events, such as scrapmechanic:playerCollision

Installing sm.interop as user

To install the workshop part, you only have to click the 'Subscribe' button and restart your game.

Installing the game file part is a bit more complicated. Go to your game library and right click on Scrap Mechanic. Select Manage -> Browse local files. This opens the steamapps\common\Scrap Mechanic folder. Navigate back to the steamapps folder, then open workshop\content\387990\2123222134 . Make sure your game is closed, and then double-click on Install.bat. Now open Scrap Mechanic again. Or watch the video tutorial: https://youtu.be/LxCweEwQSlE

If the installer asks for the path to the Scrap Mechanic folder, you can find that by going to your game library and right-clicking on Scrap Mechanic. Then select Manage -> Browse local files, and copy the path fo the window that opens and paste it in the installer window.

If Install does not work, please run the Install debug file and send the install.log file to Xesau#1681 on Discord.

Updating sm.interop

To update the mod, you follow the same steps as when installing. But now, you click Update.bat. If that does not work, try just clicking Install.bat again.

Using sm.interop as mod developer

1. Read through the example project from GitHub.

2. Read the API documentation (still Work In Progress)

Who is The Guild?

The Guild is a cooperation between a number of modders. Currently, The Guild consists of: Alstrak, BlueFlame, Brent Batch, DasEtwas, DJ, Fusspawn, Mini, MJM, Sheggy, shinevision, ShrooToo, TechnologicNick, Thumbpick, wingcomstriker405 and Xesau.