love.filesystem.mount

Available since LÖVE 0.9.0
This function is not supported in earlier versions.

Mounts a zip file or folder in the game's save directory for reading. It is also possible to mount love.filesystem.getSourceBaseDirectory if the game is in fused mode.

Function

Synopsis

success = love.filesystem.mount( archive, mountpoint, appendToPath )

Arguments

string archive

The folder or zip file in the game's save directory to mount.

string mountpoint

The new path the archive will be mounted to.

boolean appendToPath (false)

Whether the archive will be searched when reading a filepath before or after already-mounted archives. This includes the game's source and save directories.

Returns

boolean success

True if the archive was successfully mounted, false otherwise.

Function

Available since LÖVE 11.0
This variant is not supported in earlier versions.

Mounts the contents of the given FileData in memory. The FileData's data must contain a zipped directory structure.

Synopsis

success = love.filesystem.mount( filedata, mountpoint, appendToPath )

Arguments

FileData filedata

The FileData object in memory to mount.

string mountpoint

The new path the archive will be mounted to.

boolean appendToPath (false)

Whether the archive will be searched when reading a filepath before or after already-mounted archives. This includes the game's source and save directories.

Returns

boolean success

True if the archive was successfully mounted, false otherwise.

Function

Available since LÖVE 11.0
This variant is not supported in earlier versions.

Mounts the contents of the given Data object in memory. The data must contain a zipped directory structure.

Synopsis

success = love.filesystem.mount( data, archivename, mountpoint, appendToPath )

Arguments

Data data

The Data object in memory to mount.

string archivename

The name to associate the mounted data with, for use with love.filesystem.unmount. Must be unique compared to other mounted data.

string mountpoint

The new path the archive will be mounted to.

boolean appendToPath (false)

Whether the archive will be searched when reading a filepath before or after already-mounted archives. This includes the game's source and save directories.

Returns

boolean success

True if the archive was successfully mounted, false otherwise.

Examples

Mount a zip file.

-- Assuming content.zip exists in the game's save directory and contains a file called 'myimage.png'.
love.filesystem.mount("content.zip", "content")
 
assert(love.filesystem.getInfo("content/myimage.png") ~= nil)

See Also

• love.filesystem
• love.filesystem.unmount
• love.filesystem.getSourceBaseDirectory
• love.directorydropped