EasyYamlParser is a plugin for reading and writing YAML data in Unreal Engine. You can handle YAML entirely with Blueprints (visual scripting); no C++ code is required.
The biggest feature of EasyYamlParser is dot-notation access strings. A value deep inside a YAML document is specified with a single string such as player.stats.level. You do not have to walk through nested maps one level at a time.
The plugin supports both loading (parsing) and emitting (creating) YAML. You can load a document, edit it, and save it back — or build a new document from scratch. When parsing fails, the error message carries the line and column numbers, so you can locate the problem in the source text right away.
| What you want to check first | Where to look |
|---|---|
| Complete one YAML read/write run first | Quick Start: read values, build YAML, and print it |
| Install steps | Setup: the installation flow |
| Learn how to write access strings | Use Cases: the selection table by goal and the notation |
| Look up node inputs/outputs | Blueprint API Reference: the public API |
Basic terms
| Term | Description |
|---|---|
| YAML | A data format that represents hierarchy with indentation. Widely used for configuration files |
| Access string | The string that specifies a location inside YAML. Keys joined with dots, as in player.name |
| Dot notation | Writing a hierarchy by joining keys with .. Entered in the Access String pin |
| YamlObject | An object that represents one YAML document. Handled as a Yaml Object variable |
| Map | A collection of keys and values, written as key: value lines |
| Sequence | A YAML array written with - markers. Addressed with [ ] in access strings, as in items[0] |
The following diagram shows how EasyYamlParser is organized. Blueprint node calls operate on YAML data through a Yaml Object value.
flowchart LR
BP["Blueprint / C++"] --> F["EasyYamlParser nodes"]
F --> Y["Yaml Object"]
Y --> TXT["YAML string / file"]
What you can do with EasyYamlParser
- Reading values with dot-notation access strings (
Read Int,Read Float,Read String,Read Bool) - Retrieving intermediate maps and arrays of maps (
Read Object,Read Objects) - Loading from YAML strings and files (
Load Yaml From String,Load Yaml From File) - Creating and writing YAML (
Create Empty Yaml Objectplus the Write nodes) - Writing explicit null values (
Write Null) - Appending values to sequences (
Add Int To Arrayand the other Add nodes) - Saving to files and converting to a YAML string (
Save Yaml To File,Yaml To String) - Access to multi-dimensional sequences (access strings such as
matrix[1][2]) - Path existence checks and node type inspection (
Has Path,Get Root Type,Get Node Type) - Validity checks and comparison of YAML objects (
Is Yaml Object Valid,Are Yaml Objects Equal) - Error reporting with an error code plus line and column numbers (
Error Code,Error Messagepins) - USTRUCT conversion from C++ (
TryReadStruct/TryWriteStruct)
Relationship with the other Easy series plugins
EasyYamlParser adopts the same access-string concept and node layout as EasyJsonParser V2. If you have used EasyJsonParser, you can work with YAML the same way.
| Item | EasyJsonParser V2 | EasyYamlParser |
|---|---|---|
| Data format | JSON | YAML |
| Reading and writing | Supported | Supported |
| Integer type | int32 | int64 (large integers are handled as-is) |
| Error information | Success flag and message | Success flag, message, error code, line and column numbers |
| Writing null | No dedicated node | Explicitly writable with Write Null |
| USTRUCT conversion | Blueprint nodes available | C++-only API (TryReadStruct / TryWriteStruct) |
Recommended for these projects
- Projects that manage configuration files or master data as YAML
- Projects that read configuration files written by hand
- Projects that want to handle YAML entirely with Blueprints, without writing C++
- Projects that want parse errors reported with line numbers
Basic usage flow
- Install the plugin and enable EasyYamlParser.
- Create a
Yaml ObjectwithLoad Yaml From StringorLoad Yaml From File, and store it in a variable. - Read values with the Read nodes (
Read Stringand others) by specifying access strings. - To write, create YAML with
Create Empty Yaml Objectand set values with the Write nodes (Write Stringand others). - Save it to a file with
Save Yaml To File.
The concrete steps are explained in the Quick Start.
Supported environments
Unreal Engine versions
EasyYamlParser supports Unreal Engine 5.6 - 5.8.
AyuMaxSoft plugins are updated for the latest three versions of Unreal Engine, as a general policy.
The supported Unreal Engine versions for each plugin release are listed below.
| Plugin version | Supported UE versions |
|---|---|
| v0.1.0 | UE5.6 - 5.8 |
Supported platforms
| Category | Platforms |
|---|---|
| Target platforms | Windows, Mac, Linux, Android, iOS |
Current limitations
- YAML comments are not preserved across a load/save round trip. This does not affect read-only use of commented configuration files.
- Loading is synchronous. Loading a large file blocks the game thread; keep this in mind.
- Relative paths for file reading and writing are resolved against the project’s Content directory. See Data Types and Production for details.
- USTRUCT conversion is a C++-only API. It is not available from Blueprint.
Sales and licensing
The plugin is licensed under the Epic Games license terms that apply when you purchase or obtain it on Fab.
Frequently asked questions are collected in the FAQ. The EasyYamlParser category covers questions such as Blueprint-only usage, comment preservation, and how null values are handled.
