Scripting Quick Start¶
Adding functionalities and gamemode features into nanos world is simpler than it looks! In this Quick Start Guide, you will learn how to setup a Package in nanos world and program your first Lua scripting functionality.
Packages (or Modules) are pieces/components of your gamemode which are isolated from other packages you created. All Packages must go under
Packages/ folder, each Package is a folder under that. Each Package must contain the following folders:
Shared. Client and Shared will be sent to the Clients when they connect. Server will run only on the Server and won’t be sent to Clients.
Each Package must have an
Index.lua, this is the only file which will be triggered when the Package is loaded, this way this file is responsible for including other files and starting up your functionalities.
Shared packages are always loaded before Client and Server package.
Maps can also have a Custom Script (server-only) attached to it. These are files named
[MAP_NAME].lua in the same folder as the map in the
Assets/ folder. If no one of your Packages disallow it, this script file will be loaded as well. Usually these scripts should have map specific spawn props/weapons points and pertinent stuff. Please refer to Maps & Levels for more information.
NanosWorldServer.exe Packages/ | My_Package_01/ | | Server/ | | | Index.lua | | | *.lua | | Client/ | | | *.lua | | Shared/ | | | *.lua | | Package.toml | My_Package_02/ | | Package.toml | | ... Assets/
Creating your first Script¶
Please check out Server Manual before proceeding to setup your server.
First of all, create a new folder inside
MyAwesomePackage (or whatever name you want ;)), and inside that create a
Server folder with a
Index.lua file. All scripting files inside of Server folder will remain and run only on server side. You will be like that:
NanosWorldServer.exe Packages/ | MyAwesomePackage/ | | Server/ | | | Index.lua | | Package.toml Assets/
Index.lua file in any editor you want (if you don’t have one, we’d recommend you try Visual Studio Code).
Let’s start spawning some Props in your server, for that, use this code:
This will spawn 3 Props (a Table, a chair and a Tire) close to each other. After that, you can start the server and you will see the output:
You can also join your server to see the results =D
Very nice! But you may have noticed you are just a wandering soul flying around, let’s give you some flesh! For that, we will need to interact with some Events.
In nanos world we have a Class called Player. Player’s are just a representation of a physical person behind the mouse and keyboard. Inside the game Player’s don’t have physical presence, because of that we must assign a Character to them, so with that they can incarnate and personify something =D.
When a Player connects to your server, a new Player class is automatically spawned and you can get them with the following event:
For spawning and assigning this new player to a new Character, we can just make that:
And that it! Ah, just remember to destroy the Characters when players disconnect, otherwise there will be a lot of souless Characters remaining on the map:
Congratulations! You have finished your fist basic Script and Learned: