Guide sur les Packages

Les Packages sont des composants de votre serveur qui vont exécuter des scripts Lua pour intéragir avec le jeu.

Chaque Package est isolé et possède sa propre Machine Virtuelle Lua (Lua VM), cela veut dire que chaque Package a sa propre portée globale et ne peut pas accéder directement aux données des autres Packages.

Structure des dossiers

Tous les Packages doivent aller dans le répertoire Server/Packages/, chaque Package est un dossier dans ce répertoire.

Ils peuvent contenir les dossiers suivants : Server, Client et Shared. Seul les dossiers Client and Shared seront envoyés et chargés par les clients quand ils se connecteront.

Chaque Package doit avoir un fichier nommé Index.lua à l'intérieur des dossiers Server, Client ou Shared, il s'agit du seul fichier qui sera lu lorsque le Package sera chargé, par conséquent ce fichier se doit d'inclure les autres fichiers du Package et ainsi les démarrer.

Server Folder

NanosWorldServer.exe
Packages/
├── My_Package_01/
│   ├── Server/
│   │   ├── Index.lua
│   │   └── *.lua
│   ├── Client/
│   │   └── *.lua
│   ├── Shared/
│   │   └── *.lua
│   └── Package.toml
├── My_Package_02/
│   ├── Package.toml
│   └── ...
Assets/
Config.toml

Configuration des Packages

Les Packages ont un fichier de configuration nommé Package.toml, dans la racine du dossier du Package. Dans ce fichier il est possible de configurer tous les paramètres importants liés au Package :

Package.toml

loading...

See full example on GitHub

Settings Detailed

Setting	Description
name	Nom familier du Package
author	Author(s) of the Package
version	Version du Package - se référer à SemVer
image	Image URL to be displayed in the Vault
type	Type de package - se référer à Package Types
force_no_map_script	Enabling this will force the map-script (if any) to do NOT load
auto_cleanup	Activer cela détruira toutes les entités créees par ce Package lors de sa désactivation
packages_requirements	Liste des Packages qui doivent être chargés avant le chargement de celui-ci
assets_requirements	Liste des packs d'assets à charger avant que ce package se charge
compatible_maps	List of Maps compatible/recommended to work with this Package

Types de Package

Dans nanos world, nous avons 3 types de packages : script, game-mode et loading-screen, chacun a une fonctionnalité et une utilité spécifique.

Type	Description
script	Package classique qui va exécuter ses scripts et démarrer une nouvelle machine virtuelle Lua (Lua VM) quand il sera lancé.
game-mode	Like script but you can only load one game-mode package at once. Useful when you are creating full games which cannot be loaded with other full games packages.
library	It will not load a Lua VM. Should be loaded through Package.RequirePackage from other Packages. Useful when you are creating a library or framework and want it being loaded on clients as well, or when you need to set this as dependency of other packages.
loading-screen	Special Package which will be loaded during player's loading screen. Those packages must have an Index.html in the root. Please refer to Loading Screen for more information.

tip

If you are creating a Tool or some Addon package, make it script!

If you are creating a Library, a Framework or some Utility package, make it library!

Si vous créez un mode de jeu unique et complet avec des fonctionnalités que vous ne voulez pas voir gâchées si quelqu'un charge deux modes de jeu, faites un package game-mode, un seul pourra être chargé à la fois !

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).

So, to make the server ignore it you just need to add an .ignore file in the root of that folder. Simple as that 😉.