overwolf.io API · Overwolf

Use the overwolf.io API to check whether a certain file exists and/or to write content into files. For more I/O functionalities, please use our simple I/O plugin.

Methods Reference

overwolf.io.fileExists()
overwolf.io.writeFileContents()
overwolf.io.readFileContents()
overwolf.io.copyFile()
overwolf.io.dir()
overwolf.io.readBinaryFile()
overwolf.io.readTextFile()
overwolf.io.exist()
overwolf.io.listenOnFile()
overwolf.io.stopFilelistener()

Types Reference

overwolf.io.eEncoding enum
overwolf.io.enums.fileListenerState enum
overwolf.io.enums.ReadFileOptions Object
overwolf.io.enums.ListenFileOptions Object

fileExists(filePath, callback)

Version added: 0.93

Checks for the existance of a file in a given path.

Parameter	Type	Description
filePath	string	Path to check for
callback	function	Returns the result

Callback argument: Success

{ "status": "success", "found": true }

Callback argument: Failure

If the file does NOT exist, an error status will be returned:

{"status":"error","reason":"File doesn't exists"}

writeFileContents(filePath, content, encoding, triggerUacIfRequired, callback)

Version added: 0.93

Permissions required: FileSystem

Writes content into a target text file.

If the file doesn’t exist, it will be created, along with any required directories along the path. Otherwise, the file’s content will be overwritten.

Parameter	Type	Description
filePath	string	Path to check for
content	string	Content to write
encoding	eEncoding enum	Encoding to use
triggerUacIfRequired	bool	If additional permissions are required, triggers the Windows UAC dialog
callback	function	Returns the result

Callback argument: Success

{ "status": "success" }

Callback argument: Failure

{"status":"error"}

readFileContents(filePath,encoding, callback)

Version added: 0.93

Permissions required: FileSystem

Returns a string with the targeted text file’s content.

Parameter	Type	Description
filePath	string	Full path of the targeted file
encoding	eEncoding enum	Encoding to use
callback	function	Returns the result

Callback argument: Success

Returns a string with the target file’s content.

{"status":"success","content":"Hello World!"}

Callback argument: Failure

If the file doesn’t exist, an error status will be returned:

{"status":"error","reason":"File doesn't exists"}

copyFile(src, dst, overrideFile, reserved, callback)

Version added: 0.93

Permissions required: FileSystem

Copy a file from the local extension directory to a destination in the local machine.

Parameter	Type	Description
src	string	A relative file path from your extension's root folder, or a full overwolf-extension:// URI to the source file
dst	string	Destination path to copy to including file name
overrideFile	bool	"true" if you want an existing file to be overwritten, "false" otherwise
reserved	bool	For future use
callback	function	Returns with the result

Callback argument: Success

Returns a string with the targeted file’s content.

{"status":"success""}

Callback argument: Failure

{"status":"error"}

dir(path, callback)

Version added: 0.141

Permissions required: FileSystem

Lists all files and folder in the target path.

Parameter	Type	Description
path	string	The target path
callback	function	Returns with the result

readBinaryFile(path, options, callback)

Version added: 0.141

Permissions required: FileSystem

Read binary file.

Reads a file's contents and returns an array of byte values.
This function is extremly slow! Use it only for small files or to get file header info using the options parameter (maxBytesToRead) to limit the amount of data to fetch.

Parameter	Type	Description
path	string	The target path
options	ReadFileOptions object
callback	function	Returns the result

Callback argument: Success

 {
    "success" : true,
    "error": "", 
    "content": byte[], // the file content in bytes
    "info" : {
        "eof" : true, // is EOF
        "totalRead" : 3000, // total read bytes
        "position" : 3000, // last file position
        "totalLines" :100, // total read lines
    }
}

readTextFile(path, options, callback)

Version added: 0.141

Permissions required: FileSystem

Read text file.

Reads a file's contents and returns it as text.

Parameter	Type	Description
path	string	The target path
options	ReadFileOptions object
callback	function	Returns the result

Callback argument: Success

 {
    "success" : true,
    "error": "", 
    "content": "", // the file content
    "info" : {
        "eof" : true, // is EOF
        "totalRead" : 3000, // total read bytes
        "position" : 3000, // last file position
        "totalLines" :100, // total read lines
    }
}

exist(path, callback)

Version added: 0.141

Permissions required: FileSystem

Is path exist.

Parameter	Type	Description
path	string	The target path
callback	function	Returns the result

Callback argument: Success

 {
    "success" : true,
    "error": "", 
    "exist": true
}

listenOnFile(id, path, option, callback)

Version added: 0.141

Permissions required: FileSystem

Start listening on file.

Stream a file (text files only), line-by-line, from the local filesystem.

Parameter	Type	Description
id	string	listen Id
path	string	file path
options	ListenFileOptions Object
callback	function	Returns the result

Callback argument: Success

{
    "success" : true, // when false the callback will stop listen
    "error": "", // valid only when success = false
    "state": "running|terminated|truncated" // valid only when success =true (overwolf.io.enums.fileListenerState) 
    "content": "", //the line 
    "info" : 
    {
        "index" : 1, // line index
        "isNew" : false, //false when line exist (e.g skip to end is false), true when new line was add to file
        "position" : 3000, // last file position
        "eof" :false, // is eof reached
    }
}

listenOnFile notes

"state" is from type overwolf.io.enums.fileListenerState.
Please read what happens when you call stopFileListener().

stopFileListener(id)

Version added: 0.141

Permissions required: FileSystem

Stop listening on file.

Stop streaming a file that you previously passed when calling listenOnFile.
There are no callbacks - as this will never fail (even if the stream doesn't exist).

Parameter	Type	Description
id	string	listen Id

stopFileListener notes

On stop, listenOnFile callback will trigger with a "truncated" state:

{
    "success" : true, 
    "error": "", 
    "state": "truncated" 
    ...
}

fileListenerState enum

File listener state.

Options
running
terminated
truncated

eEncoding enum

File encoding.

Options
UTF8
UTF8BOM
Unicode
UnicodeBOM
ASCII

ReadFileOptions Object

Version added: 0.141

Describes the different options to read a file.

Parameter	Type	Description
encoding	eEncoding enum
maxBytesToRead	int	default is 0 => read all file
offset	int	start reading point, default is 0

ListenFileOptions Object

Version added: 0.141

Describes the different options to listen to a file.

Parameter	Type	Description
skipToEnd	bool	should skip directly to end of file. default if false