├── LICENSE ├── README.md └── ini.lua /LICENSE: -------------------------------------------------------------------------------- 1 | CC0 1.0 Universal 2 | 3 | Statement of Purpose 4 | 5 | The laws of most jurisdictions throughout the world automatically confer 6 | exclusive Copyright and Related Rights (defined below) upon the creator and 7 | subsequent owner(s) (each and all, an "owner") of an original work of 8 | authorship and/or a database (each, a "Work"). 9 | 10 | Certain owners wish to permanently relinquish those rights to a Work for the 11 | purpose of contributing to a commons of creative, cultural and scientific 12 | works ("Commons") that the public can reliably and without fear of later 13 | claims of infringement build upon, modify, incorporate in other works, reuse 14 | and redistribute as freely as possible in any form whatsoever and for any 15 | purposes, including without limitation commercial purposes. These owners may 16 | contribute to the Commons to promote the ideal of a free culture and the 17 | further production of creative, cultural and scientific works, or to gain 18 | reputation or greater distribution for their Work in part through the use and 19 | efforts of others. 20 | 21 | For these and/or other purposes and motivations, and without any expectation 22 | of additional consideration or compensation, the person associating CC0 with a 23 | Work (the "Affirmer"), to the extent that he or she is an owner of Copyright 24 | and Related Rights in the Work, voluntarily elects to apply CC0 to the Work 25 | and publicly distribute the Work under its terms, with knowledge of his or her 26 | Copyright and Related Rights in the Work and the meaning and intended legal 27 | effect of CC0 on those rights. 28 | 29 | 1. Copyright and Related Rights. A Work made available under CC0 may be 30 | protected by copyright and related or neighboring rights ("Copyright and 31 | Related Rights"). Copyright and Related Rights include, but are not limited 32 | to, the following: 33 | 34 | i. the right to reproduce, adapt, distribute, perform, display, communicate, 35 | and translate a Work; 36 | 37 | ii. moral rights retained by the original author(s) and/or performer(s); 38 | 39 | iii. publicity and privacy rights pertaining to a person's image or likeness 40 | depicted in a Work; 41 | 42 | iv. rights protecting against unfair competition in regards to a Work, 43 | subject to the limitations in paragraph 4(a), below; 44 | 45 | v. rights protecting the extraction, dissemination, use and reuse of data in 46 | a Work; 47 | 48 | vi. database rights (such as those arising under Directive 96/9/EC of the 49 | European Parliament and of the Council of 11 March 1996 on the legal 50 | protection of databases, and under any national implementation thereof, 51 | including any amended or successor version of such directive); and 52 | 53 | vii. other similar, equivalent or corresponding rights throughout the world 54 | based on applicable law or treaty, and any national implementations thereof. 55 | 56 | 2. Waiver. To the greatest extent permitted by, but not in contravention of, 57 | applicable law, Affirmer hereby overtly, fully, permanently, irrevocably and 58 | unconditionally waives, abandons, and surrenders all of Affirmer's Copyright 59 | and Related Rights and associated claims and causes of action, whether now 60 | known or unknown (including existing as well as future claims and causes of 61 | action), in the Work (i) in all territories worldwide, (ii) for the maximum 62 | duration provided by applicable law or treaty (including future time 63 | extensions), (iii) in any current or future medium and for any number of 64 | copies, and (iv) for any purpose whatsoever, including without limitation 65 | commercial, advertising or promotional purposes (the "Waiver"). Affirmer makes 66 | the Waiver for the benefit of each member of the public at large and to the 67 | detriment of Affirmer's heirs and successors, fully intending that such Waiver 68 | shall not be subject to revocation, rescission, cancellation, termination, or 69 | any other legal or equitable action to disrupt the quiet enjoyment of the Work 70 | by the public as contemplated by Affirmer's express Statement of Purpose. 71 | 72 | 3. Public License Fallback. Should any part of the Waiver for any reason be 73 | judged legally invalid or ineffective under applicable law, then the Waiver 74 | shall be preserved to the maximum extent permitted taking into account 75 | Affirmer's express Statement of Purpose. In addition, to the extent the Waiver 76 | is so judged Affirmer hereby grants to each affected person a royalty-free, 77 | non transferable, non sublicensable, non exclusive, irrevocable and 78 | unconditional license to exercise Affirmer's Copyright and Related Rights in 79 | the Work (i) in all territories worldwide, (ii) for the maximum duration 80 | provided by applicable law or treaty (including future time extensions), (iii) 81 | in any current or future medium and for any number of copies, and (iv) for any 82 | purpose whatsoever, including without limitation commercial, advertising or 83 | promotional purposes (the "License"). The License shall be deemed effective as 84 | of the date CC0 was applied by Affirmer to the Work. Should any part of the 85 | License for any reason be judged legally invalid or ineffective under 86 | applicable law, such partial invalidity or ineffectiveness shall not 87 | invalidate the remainder of the License, and in such case Affirmer hereby 88 | affirms that he or she will not (i) exercise any of his or her remaining 89 | Copyright and Related Rights in the Work or (ii) assert any associated claims 90 | and causes of action with respect to the Work, in either case contrary to 91 | Affirmer's express Statement of Purpose. 92 | 93 | 4. Limitations and Disclaimers. 94 | 95 | a. No trademark or patent rights held by Affirmer are waived, abandoned, 96 | surrendered, licensed or otherwise affected by this document. 97 | 98 | b. Affirmer offers the Work as-is and makes no representations or warranties 99 | of any kind concerning the Work, express, implied, statutory or otherwise, 100 | including without limitation warranties of title, merchantability, fitness 101 | for a particular purpose, non infringement, or the absence of latent or 102 | other defects, accuracy, or the present or absence of errors, whether or not 103 | discoverable, all to the greatest extent permissible under applicable law. 104 | 105 | c. Affirmer disclaims responsibility for clearing rights of other persons 106 | that may apply to the Work or any use thereof, including without limitation 107 | any person's Copyright and Related Rights in the Work. Further, Affirmer 108 | disclaims responsibility for obtaining any necessary consents, permissions 109 | or other rights required for any use of the Work. 110 | 111 | d. Affirmer understands and acknowledges that Creative Commons is not a 112 | party to this document and has no duty or obligation with respect to this 113 | CC0 or use of the Work. 114 | 115 | For more information, please see 116 | 117 | 118 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # LÖVE Lua .INI Parser 2 | [![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) 3 | ###### [INI file format specification](https://en.wikipedia.org/wiki/INI_file) 4 | ###### Please note that the library only works with [LÖVE](https://love2d.org/) 5 | 6 | ## • API 7 | `ini = require "ini"` Requires the library. 8 | 9 | ### Necessary API for using .ini files 10 | 11 | `ini.load( filePath )` Loads a .ini file and returns it as a table. 12 | 13 | `ini.save( Table, targetFile )` Saves a table using the .ini file format. 14 | 15 | #### Extra API 16 | 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. 17 | 18 | `ini.readKey( iniTable, sectionName, keyName )` Returns a key value. 19 | 20 | `ini.addSection( iniTable, newSectionName )` Adds a new section, always returns 1. 21 | 22 | `ini.addKey( iniTable, sectionName, keyName, keyValue )` Adds a value to a key, always returns 1. 23 | 24 | `ini.sectionExists( iniTable, sectionName )` Checks if section exists, returns 1 if it exists or 0 if it does not. 25 | 26 | `ini.keyExists( iniTable, keyName )` Checks if key exists, returns 1 if it exists or 0 if it does not. 27 | 28 | `ini.deleteSection( iniTable, sectionName )` Removes a section, always returns 1. 29 | 30 | `ini.deleteKey( iniTable, sectionName, keyName )` Removes a key, always returns 1. 31 | 32 | ## • Example of API usage 33 | ##### Load ini file to table and print one of its keys: 34 | ```lua 35 | ini = require "ini" 36 | ini_file = ini.load("file.ini") 37 | if ini_file then 38 | print(ini.readKey( ini_file, "owner", "name" )) 39 | end 40 | ``` 41 | ##### Save table as an ini file: 42 | ```lua 43 | ini = require "ini" 44 | ini_table = { 45 | scores = { 46 | player1 = 3982, 47 | player2 = 1312, 48 | player3 = 13, 49 | player4 = 1543, 50 | }, 51 | playerNames = { 52 | player1 = "Pete", 53 | player2 = "Billy", 54 | player3 = "Sam", 55 | player4 = "Eric" 56 | } 57 | } 58 | 59 | if ini.save(ini_table, "inifile.ini") then 60 | print("success!") 61 | end 62 | 63 | ``` 64 | [![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) 65 | -------------------------------------------------------------------------------- /ini.lua: -------------------------------------------------------------------------------- 1 | --[[ 2 | LICENSE: CC0 1.0 Universal (https://creativecommons.org/publicdomain/zero/1.0/legalcode). 3 | Attribution is not required but always appreciated. 4 | ]]-- 5 | 6 | local ini = {} 7 | 8 | function ini.load( filePath ) 9 | local fileInfo = love.filesystem.getInfo( filePath ) 10 | if fileInfo and fileInfo.type == "file" then 11 | local iniTable = {} 12 | local currentSection = "default" 13 | for line in love.filesystem.lines( filePath ) do 14 | -- Returns a string if the line is a comment 15 | local isComment = string.match( line, "^%s*;.*$") 16 | if line ~= "" and isComment == nil then 17 | -- Get section name (if section) 18 | local section = string.match( line, "%[%s*(.*)%s*%]" ) 19 | if section ~= nil then 20 | currentSection = section 21 | iniTable[section] = {} 22 | else 23 | -- Get variable name and value 24 | local variableName, variableValue = string.match( line, "^%s*(.*[^%s])%s*=%s*(.*[^%s])%s*$" ) 25 | if variableName and variableValue then 26 | iniTable[currentSection][variableName] = variableValue 27 | end 28 | end 29 | end 30 | end 31 | return iniTable 32 | end 33 | return nil 34 | end 35 | 36 | function ini.save( iniTable, file ) 37 | if iniTable then 38 | local writeString = "" 39 | for sectionName, sectionValue in pairs( iniTable ) do 40 | writeString = writeString .. "[" .. sectionName .. "]" .. "\r\n" 41 | for variableName, variableValue in pairs( sectionValue ) do 42 | writeString = writeString .. variableName .. " = " .. variableValue .. "\r\n" 43 | end 44 | end 45 | local success, message = love.filesystem.write( file, writeString ) 46 | if not success then 47 | return message 48 | end 49 | return 1 50 | end 51 | return nil 52 | end 53 | 54 | function ini.readKey( iniTable, sectionName, keyName ) 55 | return iniTable[sectionName][keyName] 56 | end 57 | 58 | function ini.addSection( iniTable, newSectionName ) 59 | iniTable[newSectionName] = {} 60 | return 1 61 | end 62 | 63 | function ini.addKey( iniTable, sectionName, keyName, keyValue ) 64 | iniTable[sectionName][keyName] = keyValue 65 | return 1 66 | end 67 | 68 | function ini.sectionExists( iniTable, sectionName ) 69 | if iniTable[sectionName] then 70 | return 1 71 | end 72 | return 0 73 | end 74 | 75 | function ini.keyExists( iniTable, sectionName, keyName ) 76 | if iniTable[sectionName][keyName] then 77 | return 1 78 | end 79 | return 0 80 | end 81 | 82 | function ini.deleteSection( iniTable, sectionName ) 83 | iniTable[sectionName] = nil 84 | return 1 85 | end 86 | 87 | function ini.deleteKey( iniTable, sectionName, keyName ) 88 | iniTable[sectionName][keyName] = nil 89 | return 1 90 | end 91 | 92 | return ini 93 | 94 | --------------------------------------------------------------------------------