Bundle Manifest

Bundles can include a bundle.lua file which will act as a manifest for the bundle, providing metadata and other configurations for it.

id = "my-bundle"
name = "My Bundle"
entrypoints = {"my-bundle.hello"}
client_entrypoints = {"map-test.hello-client"}
server_entrypoints = {"map-test.server.hello-server"}

Entrypoints

Entrypoints are the main scripts that will be executed when the bundle is loaded. They are defined as a list of strings, where each string is a module path to a lua script. The module path must always start with the bundle id, and otherwise matches the file path with slashes replaced by dots and the .lua extension removed.

Server entrypoints should always be placed inside a server subfolder to prevent them from being included in client bundles. As the name says, server entrypoints will only be loaded on the server and client entrypoints will only be loaded on the client.

Content-only Bundles

Bundles do not need a bundle manifest to be loaded. If your bundle only contains assets and resources, but no scripts, and does not need any advanced features, you can simply omit the bundle.lua file.

Server Scripts

While bundles are capable of including server scripts through the server subfolder, Selene also offers the ability to place lua scripts directly inside the server_scripts folder. This is a good place for scripts that are very specific to your server and not necessarily meant to be reusable. This folder also takes precedence over bundles, meaning you can use it to override scripts in bundles. However, as the name implies, this folder can only be used for server-side scripts.

Experimental

In the future, we may also offer support for client_scripts that are sent to the client and work in the same manner. For now, any client-side scripts must be part of a bundle.