Skip to content

Latest commit

 

History

History
41 lines (33 loc) · 1.23 KB

README.md

File metadata and controls

41 lines (33 loc) · 1.23 KB

gmsv_file

A simple file i/o library for Garry's Mod written in ANSI C.

Installing

  1. Go to the "Releases" of this GitHub repository.
  2. Download the latest .dll file for your platform.
  3. Copy that file to garrysmod/lua/bin of your server.

Building

  1. Install premake5
  2. Use premake5 followed by your platform (vs2015 for windows, gmake for linux).
  3. Navigate to the project folder.
  4. If on Windows, open the .sln file, in on Linux, run make.
  5. The compiled binary should be in the gmsv_file/bin folder.

Using

The module provides barebones functionality for file manipulation. It's being worked on, more features are coming soon! (All functions are relative to garrysmod/ folder!!)

--- Appends contents at the end of file.
-- @return[Boolean success]
File.append(filename, contents)

--- Deletes file.
-- @return[Boolean success]
File.delete(filename)

--- Creates a folder with specified name.
-- Returns false if the folder exists, or was unable to be created.
-- @return[Boolean success]
File.mkdir(directory)

--- Reads specified file.
-- @return[String contents]
File.read(filename)

--- Writes contents to file. Overwrites existing contents.
-- @return[Boolean success]
File.write(filename, contents)