Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mrrobinofficial/unreal-iniparser

Read/Write an .Ini file the unreal way!
https://github.com/mrrobinofficial/unreal-iniparser

cplusplus cpp ini ini-parser unreal-engine unreal-engine-plugin

Last synced: 4 days ago
JSON representation

Read/Write an .Ini file the unreal way!

Host: GitHub
URL: https://github.com/mrrobinofficial/unreal-iniparser
Owner: MrRobinOfficial
License: mit
Created: 2023-01-20T21:25:50.000Z (almost 2 years ago)
Default Branch: main
Last Pushed: 2023-11-05T22:00:48.000Z (about 1 year ago)
Last Synced: 2024-11-14T10:53:37.063Z (about 2 months ago)
Topics: cplusplus, cpp, ini, ini-parser, unreal-engine, unreal-engine-plugin
Language: C++
Homepage:
Size: 81.1 KB
Stars: 8
Watchers: 2
Forks: 5
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

IniParser [Unreal Engine]

*Read/Write an .Ini file the unreal way!*

[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/mrrobinofficial/unreal-iniparser/blob/HEAD/LICENSE.txt)
![plugin-status](https://img.shields.io/badge/plugin_status-ready_to_use-green)
![maintenance-status](https://img.shields.io/badge/maintenance-passively--maintained-yellowgreen.svg)

## ⚙️ Supported Platforms
This plug-in was last built against Unreal Engine 5.1. It should work on all platforms, since it made with raw c++ code and basic Unreal Engine features.

## ⚒️ Installation

You can install from the release section.

Alternatively, you can install this plugin via terminal with [*git*](https://git-scm.com/). **Here is the command for installing it**.

```console
git clone [email protected]:MrRobinOfficial/Unreal-IniParser.git IniParser
```

🖼️ Screenshots

Overview of Blueprint nodes from .Ini Library

Output text from .ini data that was written

Parse .ini data structure from a file path

## 📝 Quick guide

This plugin is parsing system for file type `.ini`. You can read more about `.ini` file system.

From the `IniLibrary` (Blueprint Function Library class), you have a couple functions to use:

* Mainly: `ParseIniFromString(FString String)`, `ParseIniFromFile(FString FilePath)` and `ParseIniToString(const FIniData& Data)` for C++ users.
* And for Blueprint users, it's: "*Parse .Ini From String*", "*Parse .Ini From File*" and "*Parse .Ini To String*".
* Use `ReadIniFromFile` and `WriteIniToFile` for reading and writing to a specific file.

This `.ini` parsing system support:

* Sections and properties, names are case-insensitive.
* Data container (`FIniData`) support for global comments and properties. Meaning, comments/properties is defined under a section.
* Property support values with double quote and apostrophe.

## 🆘 Support
If you have any questions or issue, just write either to my [YouTube channel](https://www.youtube.com/@mrrobinofficial), [Email](mailto:[email protected]) or [Twitter DM](https://twitter.com/MrRobinOfficial).

## 🔗 References
- [Introduction to Unreal Engine Plugins](https://docs.unrealengine.com/5.0/en-US/plugins-in-unreal-engine/)
- [Introduction to .ini file format](https://en.wikipedia.org/wiki/INI_file)