README.md

Native filesystem for LÖVE

nativefs replicates a subset of the love.filesystem API, but without LÖVE's path restrictions.

Available functions

nativefs

Links in this list point to their love.filesystem counterparts. All functions are designed to behave the same way as love.filesystem, but without the path restrictions that LÖVE imposes; i.e., they allow full access to the filesystem.

• nativefs.newFile
• nativefs.newFileData
• nativefs.mount
• nativefs.unmount
• nativefs.read
• nativefs.write
• nativefs.append
• nativefs.lines
• nativefs.load
• nativefs.getWorkingDirectory
• nativefs.getDirectoryItems
• nativefs.getInfo
• nativefs.createDirectory
• nativefs.remove
• nativefs.getDirectoryItemsInfo
• nativefs.getDriveList
• nativefs.setWorkingDirectory

Additional nativefs functions

Functions that are not available in love.filesystem:

• nativefs.getDirectoryItemsInfo(path)
  Returns a list of items in a directory that contains not only the names, but also the information returned by getInfo for each item. The return value is a list of files and directories, in which each entry is a table as returned by getInfo, with an additional name field for each entry. Using this function is faster than calling getInfo separately for each item.

• nativefs.getDriveList()
  Returns a table with all populated drive letters on Windows ({ 'C:/', 'D:/', ...}). On systems that don't use drive letters, a table with the single entry / is returned.

• nativefs.setWorkingDirectory(directory)
  Changes the working directory.

File

nativefs.newFile returns a File object that provides these functions:

• File:open
• File:close
• File:read
• File:write
• File:lines
• File:isOpen
• File:isEOF
• File:getFilename
• File:getMode
• File:getBuffer
• File:setBuffer
• File:getSize
• File:seek
• File:tell
• File:flush
• File:type
• File:typeOf
• File:release

Function names in this list are links to their LÖVE File counterparts. File is designed to work the same way as LÖVE's File objects.

Example

local nativefs = require("nativefs")

-- deletes all files in C:\Windows
local files = nativefs.getDirectoryItemsInfo("C:/Windows")
for i = 1, #files do
  if files[i].type == "file" then
    nativefs.remove("C:/Windows/" .. files[i].name)
  end
end

License

Copyright 2020 [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.