https://github.com/nobytesgiven/ini_parser

.ini parser in Lua
https://github.com/nobytesgiven/ini_parser

Last synced: 2 months ago
JSON representation

.ini parser in Lua

• Host: GitHub
• URL: https://github.com/nobytesgiven/ini_parser
• Owner: nobytesgiven
• License: cc0-1.0
• Created: 2018-06-08T16:47:05.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2022-11-20T18:06:05.000Z (about 2 years ago)
• Last Synced: 2024-05-21T13:01:58.557Z (8 months ago)
• Language: Lua
• Size: 2.93 KB
• Stars: 15
• Watchers: 0
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-love2d - Ini Parser - General purpose ini configuration parser. (Utilities)

README

        
# LÖVE Lua .INI Parser

[![Github file size](https://img.shields.io/badge/size-2.72%20kB-green.svg)](https://github.com/FivosM/ini_parser/blob/master/ini.lua)   [![license](https://img.shields.io/badge/license-CC0-green.svg)](https://github.com/FivosM/ini_parser/blob/master/LICENSE)

###### [INI file format specification](https://en.wikipedia.org/wiki/INI_file)

###### Please note that the library only works with [LÖVE](https://love2d.org/)

## • API

`ini = require "ini"` Requires the library.

### Necessary API for using .ini files

`ini.load( filePath )` Loads a .ini file and returns it as a table.

`ini.save( Table, targetFile )` Saves a table using the .ini file format.

#### Extra API

The below functions are not necessary and can be easily replaced with simple table-editing. They should only be used to make the game logic more readable.

`ini.readKey( iniTable, sectionName, keyName )` Returns a key value.

`ini.addSection( iniTable, newSectionName )` Adds a new section, always returns 1.

`ini.addKey( iniTable, sectionName, keyName, keyValue )` Adds a value to a key, always returns 1.

`ini.sectionExists( iniTable, sectionName )` Checks if section exists, returns 1 if it exists or 0 if it does not.

`ini.keyExists( iniTable, keyName )` Checks if key exists, returns 1 if it exists or 0 if it does not.

`ini.deleteSection( iniTable, sectionName )` Removes a section, always returns 1.

`ini.deleteKey( iniTable, sectionName, keyName )` Removes a key, always returns 1.

## • Example of API usage

##### Load ini file to table and print one of its keys:

```lua

ini = require "ini" 

ini_file = ini.load("file.ini") 

if ini_file then 

	print(ini.readKey( ini_file, "owner", "name" )) 

end

```

##### Save table as an ini file:

```lua

ini = require "ini" 

ini_table = {

	scores = {

		player1 = 3982,

		player2 = 1312,

		player3 = 13,

		player4 = 1543,

	},

	playerNames = {

		player1 = "Pete",

		player2 = "Billy",

		player3 = "Sam",

		player4 = "Eric"

	}

}

if ini.save(ini_table, "inifile.ini") then

	print("success!")

end

```

[![This library is licensed under CC0](https://licensebuttons.net/p/zero/1.0/88x31.png "This code is licensed under CC0")](https://raw.githubusercontent.com/FivosM/ini_parser/master/LICENSE)