Packages Guide
Packages are pieces/components of your server with ability to contain Lua scripts to interact with the game, define loading screens or maps.
Folder Structureβ
All Packages must go under server's Packages/
directory. Each Package is a folder under that.
They can contain the following folders: Server
, Client
and Shared
. Only Client and Shared folders will be sent and loaded by the clients when they connect.
Each Package which contains Lua scripts must have a file called Index.lua
inside Server, Client or Shared folders, this is the only file which will be triggered when the Package is loaded, this file is responsible for including other files and starting up your functionalities.
NanosWorldServer.exe
Packages/
βββ my-package-01/
β βββ Server/
β β βββ Index.lua
β β βββ *.lua
β βββ Client/
β β βββ *.lua
β βββ Shared/
β β βββ *.lua
β βββ Package.toml
βββ my-package-02/
β βββ Package.toml
β βββ ...
βββ my-package-loading-screen-01/
β βββ Index.html
β βββ Package.toml
β βββ ...
Assets/
Config.toml
Package Configurationβ
Packages have a configuration file in the root of the package folder, called Package.toml
, in this file we can setup all pertinent settings related to the Package. Each Package Type has it's own configuration file format.
They all share the same header [meta]
, which contains the following settings:
https://github.com/nanos-world/nanos-world-server/blob/main/_meta.toml
Setting | Description |
---|---|
title | Friendly name |
author | Contributor(s) |
version | Version - in the SemVer format X.Y.Z |
Package Typesβ
We have 5 types of packages: script, game-mode, map, loading-screen and c-module, each one with with a specific functionality and an unique purpose:
script
β
Script is a normal Package type, which can load Lua script files, you can load as many script
Packages as you want. They are defined in the packages
entry of the Server Config.toml.
https://github.com/nanos-world/nanos-world-server/blob/main/_script.toml
game-mode
β
GameModes are like script
packages but you can only load one game-mode
package at once. They are defined in the game_mode
entry of Config.toml.
They are used when you are creating full games which cannot be loaded with other full games packages.
https://github.com/nanos-world/nanos-world-server/blob/main/_game_mode.toml
loading-screen
β
Loading Screen is a special Package type which is loaded during player's loading to display a custom Loading Screen as HTML. They are defined in the loading_screen
entry of Config.toml.
It must have an index.html
in the root. Please refer to Loading Screen for more information.
https://github.com/nanos-world/nanos-world-server/blob/main/_loading_screen.toml
map
β
Map is a special Package type which defines the configuration of a Map entry. They are defined in the map
entry of Config.toml.
It contains all functionalities from a script
, being able to execute scripts as well. With the addition it is used to load a map, having the options to have custom data and spawn points defined on its Package.toml natively.
https://github.com/nanos-world/nanos-world-server/blob/main/_map.toml
As nanos world server is not aware of Unreal or it's Assets, we need to somehow say to the server where are the scriptable part of the map, such as Spawn Points, Props locations, Weapon locations and so on.
It is a recommended approach to implement all Props, Weapons and Vehicles spawn locations in your Map Package Server/Index.lua
and define all Player's Spawn points in the Package.toml
file.
c-module
β
C Module is another special Package that is capable of loading binary C modules in the Lua VM.
Please refer to C Module for more information.
https://github.com/nanos-world/nanos-world-server/blob/main/_c_module.toml
Settings Detailedβ
Setting | PackageΒ Types | Description |
---|---|---|
force_no_map_package | script game-mode | Enabling this will force the map package (if any) to do NOT load |
auto_cleanup | script game-mode map | Enabling this will destroy all entities spawned by this Package when it unloads |
compatibility_version | script game-mode map | The game version (major.minor ) at the time this package was created, for granting backwards compatibility between breaking changes. See more here |
packages_requirements | script game-mode map | List of Packages dependencies used by this Package which need to be loaded first |
assets_requirements | script game-mode map | List of Asset Packs to be loaded when this package loads |
compatible_game_modes | script map | List of Game Modes compatible/recommended to work with this Package |
compatible_maps | game-mode | List of Maps compatible/recommended to work with this Game Mode |
custom_settings | game-mode | List of Custom Settings which can be set when starting a new game or passed through command line to the server. See more here |
map_asset | map | Asset Path to the Map Asset in the format [ASSET_PACK]::[ASSET_KEY] |
spawn_points | map | List of Spawn Points in the format { location = "Vector()", rotation = "Rotator()" }, ... which can be accessed through Server.GetMapSpawnPoints() |
custom_data | map | List of Custom Data which can be accessed when this Map is loaded. See more here |
Custom Settingsβ
GameModes can define Custom Settings in the [custom_settings]
section to be set when creating a new game through main menu, or set when starting the server with the command --custom_settings "var1 = value1, var2 = value2, ..."
The values defined can be accessed through the method Server.GetCustomSettings().
List of Typesβ
Type | Description |
---|---|
boolean | A toggleable checkbox |
integer | Integer numeric values |
floating | Floating numeric values |
select | List of string values displayed as a Dropdown |
text | Text Box |
Custom Dataβ
Maps can define Custom Data in the [custom_data]
section.
The values defined are loaded when this Map Package is loaded and can be accessed through the method Server.GetMapConfig().
Usage Exampleβ
[custom_data]
my_key = 123
my_another_key = "hello world!"
my_array = [ "whoa", "yeah", 123 ]
Ignoring Client Foldersβ
Sometimes you want to ignore some folders from being sent to the clients (e.g. auto generated folders from Node.js HTML ones).
To make the server ignore it you just need to add an .ignore
file in the root of that folder. Simple as that π.
Logo Imageβ
It is possible to have a custom image to be displayed in the Vault. For that, add a file called Package.jpg
besides the Package.toml with the image you wish. The recommended size is 300x150
.
Package Images are only used if your package is not on the Vault. Also it is not recommended to upload Packages with the Package.jpg file as this is not used and only bloats the Package size.