Garry's Mod Wiki

Coding - Getting Started

Introduction

A lua file is called a script, it's plain text. To create and edit these scripts you need a plain text editor such as notepad.

You can use any text editor, but to make your life easier, we recommend that you use Notepad++. A plugin you may want to use with Notepad++ would definitely be the Gmod Lua highlighter: https://github.com/kylefleming/npp-gmod-lua

For the sake of simplicity we'll refer to both as "notepad".

Warning: Do not use Wordpad. It is a formatted text editor, not a plain text editor. It will put useless tags in around your code that will cause it to fail when loading. As a rule of thumb, if you can have text that uses two different fonts in one file, then it is not a plain text editor.

Creating the script

For our first script, we're not going to do anything too complex. We'll learn how to send a message to the console.

Type the following code into your chosen editor :

print( "Hello world" )

You're done! Wasn't that easy? It should have been.

Explanation

print is a function. A function is a command that does something when you call it. Many functions can take arguments, which is data you give the function to change exactly what it does. In this case, print() takes only one argument, which is a string (a series of letters, numbers, spaces, and so on), and when print() is called, it puts that string into the console in Garry's Mod.

Saving the script

You're now ready to create the actual Lua script file. To find your lua folder follow the following path - this may be slightly different on your computer, but will look something like this:

C:\Program Files\Steam\steamapps\common\garrysmod\garrysmod\lua\

In the filename box, type helloworld.lua (Note that you must specify .lua), and in the Save As type box, select All Files. Now, just press enter (or press the save button) to save your script.

Running the script

To run any of your scripts you need to be playing a map. Now, open the console and type the following :

lua_openscript helloworld.lua

Press enter. If you did everything correctly up to this point you should see a message in the console :

Hello World!

Auto running the script

To make the script run automatically when the server starts, you simply put it into one of those folders:

  • For shared scripts ( Loaded on both client and server )
C:\Program Files\Steam\steamapps\common\garrysmod\garrysmod\lua\autorun
  • For client-only scripts ( Loaded only on client )
C:\Program Files\Steam\steamapps\common\garrysmod\garrysmod\lua\autorun\client
  • For server-only scripts ( Loaded only on server )
C:\Program Files\Steam\steamapps\common\garrysmod\garrysmod\lua\autorun\server

For this specific tutorial any of those paths will work just fine.

Note, that all client and shared files must be put for download using AddCSLuaFile for them to work in multiplayer.

Loading portions of a script on the client or server

If you want to use a single file for clientside and serverside code then do the following as specified

  • To load on the client
if CLIENT then --Your clientside script here end
  • To load on the server
if SERVER then --Your serverside script here end
  • To load onto shared do neither

What's next?

Next we will learn about variables.

Clientside and Serverside Explained Here: States

Page Links


Special Pages


Wikis

?

Render Time: 36ms

Session 0
DB GetPage 2
Generate Html 6
SaveChanges 14
Render Body 0
Render Sidebar 11