Skip to content

Latest commit

 

History

History
57 lines (41 loc) · 1.96 KB

README.md

File metadata and controls

57 lines (41 loc) · 1.96 KB
Raw

Creating your SM Development Enviorment

This tutorial is written for Visual Studio Code

Requirements

  1. Scrap Mechanic
  2. Visual Studio Code
  3. Lua Language Server extension (github)

Step 1

Download and extract sm.lua

Step 2

Move the sm.lua to a memorable locaiton.

Step 3

Open visual studio code and navigate to the settings of the Lua language server.

Step 4

Scroll in the settings until you see library.

Step 5

Click add item and type in the full directory path of your memorible location followed by sm.lua An example would be E:\SM-Docs\sm.lua

Step 6

Press ok or enter when you are finished entering the library location.

Step 7

Open your mod folder or what scripts you want to edit.

Step 8

Congratulations! You now have the SM docs when you write code.

FAQ

What Lua version does SM run on?

Lua 5.1 and uses LuaJIT 2.1.0-beta3

You can set the lua version in the extensions settings to 5.1

Limitations

  1. Content or custom paths will not resolve.
  2. Does not error/warn when using server/client function in the wrong scope.
  3. Will still require some understanding of how Scrap Mechanic works.

Missing some Functions?

You will need to add other libraries (see step 3 - 6).

  1. Util - <REPLACE WITH SM INSTALL PATH>\Survival\Scripts\util.lua
  2. AnimationUtil (tools) - <REPLACE WITH SM INSTALL PATH>\Data\Scripts\game\AnimationUtil.lua

I need help!

  1. Try joining and asking the Scrap Mechanic Modding Discord
  2. Try asking on r/ScrapMechanic
  3. Ask a friend.