global VFS

The Virtual File System is an unified layer to access (read-only) the different archives used at runtime. So you can access map, game & config files via the same interface.

Overview

Although Spring can access the filesystem directly (via os module) it is more common that you would want to access files included with your game or Spring. Trouble is, most of these files are compressed into archives (.sdz/.sd7) so random access would generally be a difficult procedure. Fortunately, the Spring Lua system automatically provides access to mod and base files via the VFS module.

As an additional caveat, synced Lua cannot use the os and io modules, so using VFS is mandatory there to have any file access at all.

The VFS module doesn’t simply open archives though. What it does is map your game files, game dependencies and Spring content onto a virtual file tree. All archives start from the ‘roots’ of the tree and share the same virtual space, meaning that if two or more archives contain the same resource file name the resources overlap and only one of the files will be retrieved. Overlapping directories on the other hand are merged so the resulting virtual directory contains the contents of both. Here is an example of how this works:

Archive 1 (games/mygame.sd7)

textures
└── texture1.png
models
└── model1.mdl

Archive 2 (base/springcontent.sdz)

textures
├── texture1.png
├── texture2.png
└── texture3.png

VFS

textures
├── texture1.png
├── texture2.png
└── texture3.png
models
└── model1.mdl

This raises the question: If both archives have a texture1.png then which texture1.png is retreived via the VFS? The answer depends on the order the archives are loaded and the VFS mode (more on modes below). Generally however, each archive loaded overrides any archives loaded before it. The standard order of loading (from first to last) is:

  1. The automatic dependencies springcontent.sdz and maphelper.sdz.
  2. Dependencies listed in your modinfo.lua (or modinfo.tdf), in the order listed. Note that they are loaded fully and recursively, i.e. all the deeper dependencies of the 1st base-level dependency are loaded before the 2nd base-level dependency. This breaks the usual “loaded later overrides loaded earlier” priority if a dependency comes from multiple places, since only the first time an archive is loaded counts.
  3. Your mod archive.

Loose files (not within any archive) in the engine dir are also visible as if under the VFS root if loading under the VFS.RAW mode, though you can also use full FS path (i.e. C:/.../Spring/foo/bar.txt is visible both as that and as just foo/bar.txt). Note that VFS.RAW is only accessible to unsynced Lua, all synced states are limited to loaded archives.

Paths

Spring’s VFS is lowercase only. Also it is strongly recommended to use linux style path separators, e.g. "foo/bar.txt" and not "foo\bar.txt".

Engine read files

The engine access a few files directly, most of them are lua files which access other files themselves. Here the list of files that must exist in the VFS (some of them don’t have to be in the game/map archive cause there are fallback solutions in springcontent.sdz & maphelper.sdz):

  • ./
  • anims/
  • cursornormal.bmp/png
  • gamedata/
  • defs.lua
  • explosions.lua
  • explosion_alias.lua
  • icontypes.lua
  • messages.lua
  • modrules.lua
  • resources.lua
  • resources_map.lua
  • sidedata.lua
  • sounds.lua
  • luagaia/
  • main.lua
  • draw.lua
  • luarules/
  • main.lua
  • draw.lua
  • luaui/
  • main.lua
  • shaders/
  • ?
  • luaai.lua
  • mapinfo.lua
  • mapoptions.lua
  • modinfo.lua
  • modoptions.lua
  • validmaps.lua

[source]

methods

VFS.GetMaps

function VFS.GetMaps() -> mapNames string[]

[source]

VFS.GetGames

function VFS.GetGames() -> gameNames string[]

[source]

VFS.GetAllArchives

function VFS.GetAllArchives() -> archiveNames string[]

[source]

VFS.HasArchive

function VFS.HasArchive() -> hasArchive boolean

[source]

VFS.GetLoadedArchives

function VFS.GetLoadedArchives() -> archiveNames string[]

[source]

VFS.GetArchivePath

function VFS.GetArchivePath(archiveName: string) -> archivePath string?

[source]

VFS.GetArchiveInfo

function VFS.GetArchiveInfo(archiveName: string) -> archiveInfo ArchiveInfo?

[source]

VFS.GetArchiveDependencies

function VFS.GetArchiveDependencies(archiveName: string) -> archiveNames string[]

[source]

VFS.GetArchiveReplaces

function VFS.GetArchiveReplaces(archiveName: string) -> archiveNames string[]

[source]

VFS.GetArchiveChecksum

function VFS.GetArchiveChecksum(archiveName: string)
 -> singleArchiveChecksum string
 -> completeArchiveChecksum string

[source]

VFS.GetNameFromRapidTag

function VFS.GetNameFromRapidTag(rapidTag: string) -> archiveName string

[source]

VFS.GetAvailableAIs

function VFS.GetAvailableAIs(
  gameArchiveName: string?,
  mapArichiveName: string?
) -> ais AIInfo[]

Gets a list of all Spring AIs. The optional gameName and mapName parameters can be used to include game/map specific LuaAIs in the list.

[source]

VFS.Include

function VFS.Include(
  filename: string,
  environment: table?,
  mode: string?
) -> module any

@param filename - Path to file, lowercase only. Use linux style path separators, e.g. "foo/bar.txt".

@param environment - (Default: the current function environment)

The environment arg sets the global environment (see generic lua refs). In almost all cases, this should be left nil to preserve the current env.

If the provided, any non-local variables and functions defined in filename.lua are then accessable via env. Vise-versa, any variables defined in env prior to passing to VFS.Include are available to code in the included file. Code running in filename.lua will see the contents of env in place of the normal global environment.

@param mode - VFS modes are single char strings and can be concatenated; doing specifies an order of preference for the mode (i.e. location) from which to include files.

@return module - The return value of the included file.

Loads and runs lua code from a file in the VFS.

[source]

The path is relative to the main Spring directory, e.g.

VFS.Include('LuaUI/includes/filename.lua', nil, vfsmode)

VFS.LoadFile

function VFS.LoadFile(
  filename: string,
  mode: string?
) -> data string?

@param filename - Path to file, lowercase only. Use linux style path separators, e.g. "foo/bar.txt".

@param mode - VFS modes are single char strings and can be concatenated; doing specifies an order of preference for the mode (i.e. location) from which to include files.

@return data - The contents of the file.

Load raw text data from the VFS.

[source]

Returns file contents as a string. Unlike VFS.Include the file will not be executed. This lets you pre-process the code. Use loadstring afterwards.

VFS.FileExists

function VFS.FileExists(
  filename: string,
  mode: string?
) -> exists boolean

@param filename - Path to file, lowercase only. Use linux style path separators, e.g. "foo/bar.txt".

@param mode - VFS modes are single char strings and can be concatenated; doing specifies an order of preference for the mode (i.e. location) from which to include files.

@return exists - true if the file exists, otherwise false.

Check if file exists in VFS.

[source]

Example usage:

if VFS.FileExists("mapconfig/custom_lava_config.lua", VFS.MAP) then
  # ...
end

VFS.DirList

function VFS.DirList(
  directory: string,
  pattern: string?,
  mode: string?,
  recursive: boolean?
) -> filenames string[]

@param directory - Path to directory, lowercase only. Use linux style path separators, e.g. "foo/bar/".

@param pattern - (Default: "*")

@param mode - VFS modes are single char strings and can be concatenated; doing specifies an order of preference for the mode (i.e. location) from which to include files.

@param recursive - (Default: false)

List files in a directory.

[source]

Example usage:

local luaFiles = VFS.DirList('units/', '*.lua', nil, true)

VFS.SubDirs

function VFS.SubDirs(
  directory: string,
  pattern: string?,
  mode: string?,
  recursive: boolean?
) -> dirnames string[]

@param directory - Path to directory, lowercase only. Use linux style path separators, e.g. "foo/bar/".

@param pattern - (Default: "*")

@param mode - VFS modes are single char strings and can be concatenated; doing specifies an order of preference for the mode (i.e. location) from which to include files.

@param recursive - (Default: false)

List sub-directories in a directory.

[source]

Example usage:

local files = VFS.SubDirs('sounds/voice/' .. language, '*')
for _, file in ipairs(files) do
    # ...
end

VFS.GetFileAbsolutePath

function VFS.GetFileAbsolutePath(
  filename: string,
  mode: string?
) -> absolutePath string?

@param filename - Path to file, lowercase only. Use linux style path separators, e.g. "foo/bar.txt".

@param mode - VFS modes are single char strings and can be concatenated; doing specifies an order of preference for the mode (i.e. location) from which to include files.

[source]

VFS.GetArchiveContainingFile

function VFS.GetArchiveContainingFile(
  filename: string,
  mode: string?
) -> archiveName string?

@param filename - Path to file, lowercase only. Use linux style path separators, e.g. "foo/bar.txt".

@param mode - VFS modes are single char strings and can be concatenated; doing specifies an order of preference for the mode (i.e. location) from which to include files.

[source]

VFS.UseArchive

function VFS.UseArchive(
  archiveName: string,
  fun: unknown
) -> Results any ...

@return Results - of of the given function

Temporarily load an archive from the VFS and run the given function, which can make usage of the files in the archive.

[source]

VFS.CompressFolder

function VFS.CompressFolder(
  folderPath: string,
  archiveType: string?,
  compressedFilePath: string?,
  includeFolder: boolean?,
  mode: string?
)

@param archiveType - (Default: "zip")The compression type (can currently be only "zip").

@param compressedFilePath - (Default: folderPath .. ".sdz")

@param includeFolder - (Default: false) Whether the archive should have the specified folder as root.

Compresses the specified folder.

[source]

VFS.ZlibCompress

function VFS.ZlibCompress(uncompressed: string) -> compressed string?

@param uncompressed - Data to compress.

@return compressed - Compressed data, or nil on error.

[source]

VFS.ZlibDecompress

function VFS.ZlibDecompress(compressed: string) -> uncompressed string?

@param compressed - Data to decompress.

@return uncompressed - Uncompressed data, or nil on error.

[source]

VFS.CalculateHash

function VFS.CalculateHash(
  input: string,
  hashType: HashType
) -> hash string?

@param hashType - Hash type.

Calculates hash of a given string.

  • MD5 gets base64 encoded.
  • SHA512 gets hex encoded.

[source]

VFS.PackU8

function VFS.PackU8(...: integer) ->  string

@param ... - Numbers to pack.

Convert unsigned 8-bit integer(s) to binary string.

[source]

VFS.PackU8

function VFS.PackU8(numbers: integer[]) ->  string

@param numbers - Numbers to pack.

Convert unsigned 8-bit integer(s) to binary string.

[source]

VFS.PackU16

function VFS.PackU16(...: integer) ->  string

@param ... - Numbers to pack.

Convert unsigned 16-bit integer(s) to binary string.

[source]

VFS.PackU16

function VFS.PackU16(numbers: integer[]) ->  string

@param numbers - Numbers to pack.

Convert unsigned 16-bit integer(s) to binary string.

[source]

VFS.PackU32

function VFS.PackU32(...: integer) ->  string

@param ... - Numbers to pack.

Convert unsigned 32-bit integer(s) to binary string.

[source]

VFS.PackU32

function VFS.PackU32(numbers: integer[]) ->  string

@param numbers - Numbers to pack.

Convert unsigned 32-bit integer(s) to binary string.

[source]

VFS.PackS8

function VFS.PackS8(...: integer) ->  string

@param ... - Numbers to pack.

Convert signed 8-bit integer(s) to binary string.

[source]

VFS.PackS8

function VFS.PackS8(numbers: integer[]) ->  string

@param numbers - Numbers to pack.

Convert signed 8-bit integer(s) to binary string.

[source]

VFS.PackS16

function VFS.PackS16(...: integer) ->  string

@param ... - Numbers to pack.

Convert signed 16-bit integer(s) to binary string.

[source]

VFS.PackS16

function VFS.PackS16(numbers: integer[]) ->  string

@param numbers - Numbers to pack.

Convert signed 16-bit integer(s) to binary string.

[source]

VFS.PackS32

function VFS.PackS32(...: integer) ->  string

@param ... - Numbers to pack.

Convert signed 32-bit integer(s) to binary string.

[source]

VFS.PackS32

function VFS.PackS32(numbers: integer[]) ->  string

@param numbers - Numbers to pack.

Convert signed 32-bit integer(s) to binary string.

[source]

VFS.PackS32

function VFS.PackS32(...: integer) ->  string

@param ... - Numbers to pack.

Convert signed 32-bit float(s) to binary string.

[source]

VFS.PackS32

function VFS.PackS32(numbers: integer[]) ->  string

@param numbers - Numbers to pack.

Convert signed 32-bit float(s) to binary string.

[source]

VFS.UnpackU8

function VFS.UnpackU8(
  str: string,
  pos: integer?
) ->  integer

@param str - Binary string.

@param pos - Byte offset.

Convert a binary string to an unsigned 8-bit integer.

[source]

VFS.UnpackU16

function VFS.UnpackU16(
  str: string,
  pos: integer?
) ->  integer

@param str - Binary string.

@param pos - Byte offset.

Convert a binary string to an unsigned 16-bit integer.

[source]

VFS.UnpackU32

function VFS.UnpackU32(
  str: string,
  pos: integer?
) ->  integer

@param str - Binary string.

@param pos - Byte offset.

Convert a binary string to an unsigned 32-bit integer.

[source]

VFS.UnpackS8

function VFS.UnpackS8(
  str: string,
  pos: integer?
) ->  integer

@param str - Binary string.

@param pos - Byte offset.

Convert a binary string to a signed 8-bit integer.

[source]

VFS.UnpackS16

function VFS.UnpackS16(
  str: string,
  pos: integer?
) ->  integer

@param str - Binary string.

@param pos - Byte offset.

Convert a binary string to a signed 16-bit integer.

[source]

VFS.UnpackS32

function VFS.UnpackS32(
  str: string,
  pos: integer?
) ->  integer

@param str - Binary string.

@param pos - Byte offset.

Convert a binary string to a signed 32-bit integer.

[source]

VFS.UnpackF32

function VFS.UnpackF32(
  str: string,
  pos: integer?
) ->  integer

@param str - Binary string.

@param pos - Byte offset.

Convert a binary string to a signed 32-bit float.

[source]

fields

VFS.RAW

VFS.RAW: string = "r"

[source] Only select uncompressed files.

VFS.GAME

VFS.GAME: string = "M"

[source]

VFS.MAP

VFS.MAP: string = "m"

[source]

VFS.BASE

VFS.BASE: string = "b"

[source]

VFS.MENU

VFS.MENU: string = "e"

[source]

VFS.ZIP

VFS.ZIP: string = "Mmeb"

[source] Only select compressed files (.sdz, .sd7).

VFS.RAW_FIRST

VFS.RAW_FIRST: string = "rMmeb"

[source] Try uncompressed files first, then compressed.

VFS.ZIP_FIRST

VFS.ZIP_FIRST: string = "Mmebr"

[source] Try compressed files first, then uncompressed.

VFS.MOD

VFS.MOD: string = "M"

[source]

@deprecated Older spelling for VFS.GAME

VFS.RAW_ONLY

VFS.RAW_ONLY: string = "r"

[source]

@deprecated Deprecated

VFS.ZIP_ONLY

VFS.ZIP_ONLY: string = "Mmeb"

[source]

@deprecated Deprecated