steamworks.fileExists

Type [Function][ap i.type.Function]
Return value [Bool ean]api.type.Boolean
Revision [Release 2025.3721](https://solar2d.com/download/)
Keywords steam, st eamworks, fileExists, cloud storage
See also [steamwor ks.*]plugin.steamworks, steamworks.writeFile, steamworks.deleteFile

Overview

This function checks if a file exists in Steam Cloud storage. It returns true if the file exists, false otherwise.

Important

This API is only available on 2025.3722+

This function is commonly used to verify the presence of save files before attempting to load, delete, or overwrite them. It provides a safe way to check for file existence without attempting to read the file contents.

The function queries Steam’s Remote Storage API to determine if the specified file is present in the user’s cloud storage.

Syntax

steamworks.fileExists( filename )

Parameters

  • filename (required): String. The name of the file to check for in Steam Cloud storage.

Return Value

Boolean. Returns true if the file exists in Steam Cloud storage, false if the file doesn’t exist or if the operation failed.

Example

local steamworks = require( "plugin.steamworks" )

-- Load player data
local function loadPlayerData()
    if not steamworks.fileExists("playerData.json") then
        print("No saved data found.")
        return
    end
    
    -- File exists, proceed with loading
    local fileData = steamworks.readFile("playerData.json")
    if fileData then
        local saveData = json.decode(fileData)
        print("Player data loaded: Level " .. saveData.level)
    else
        print("Failed to read player data.")
    end
end

-- Check for save file before showing load option
if steamworks.fileExists("playerData.json") then
    print("Save file found - Load Game option available")
else
    print("No save file - Starting new game")
end