{"id":23704232,"url":"https://github.com/Carleslc/Simple-YAML","last_synced_at":"2025-09-03T09:32:04.672Z","repository":{"id":39352195,"uuid":"55332367","full_name":"Carleslc/Simple-YAML","owner":"Carleslc","description":"This Java API provides an easy-to-use way to store data and provide configurations using the YAML format.","archived":false,"fork":false,"pushed_at":"2023-07-03T18:11:24.000Z","size":10758,"stargazers_count":135,"open_issues_count":4,"forks_count":39,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-08-20T03:54:02.238Z","etag":null,"topics":["comments","config-management","configuration","configuration-file","format","java-api","maven","object","save","serialization","snakeyaml","yaml","yaml-files","yaml-format","yml","yml-files"],"latest_commit_sha":null,"homepage":"https://carleslc.me/Simple-YAML","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Carleslc.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"ko_fi":"carleslc"}},"created_at":"2016-04-03T06:05:03.000Z","updated_at":"2025-08-13T11:14:56.000Z","dependencies_parsed_at":"2025-08-20T03:31:57.751Z","dependency_job_id":"38e4296f-036c-4b3d-97c7-84bd958f007f","html_url":"https://github.com/Carleslc/Simple-YAML","commit_stats":null,"previous_names":[],"tags_count":19,"template":false,"template_full_name":null,"purl":"pkg:github/Carleslc/Simple-YAML","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Carleslc%2FSimple-YAML","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Carleslc%2FSimple-YAML/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Carleslc%2FSimple-YAML/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Carleslc%2FSimple-YAML/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Carleslc","download_url":"https://codeload.github.com/Carleslc/Simple-YAML/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Carleslc%2FSimple-YAML/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273423125,"owners_count":25103139,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-03T02:00:09.631Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["comments","config-management","configuration","configuration-file","format","java-api","maven","object","save","serialization","snakeyaml","yaml","yaml-files","yaml-format","yml","yml-files"],"created_at":"2024-12-30T13:48:12.793Z","updated_at":"2025-09-03T09:32:04.181Z","avatar_url":"https://github.com/Carleslc.png","language":"Java","readme":"# Simple YAML\n\n[![Latest version](https://jitpack.io/v/Carleslc/Simple-YAML.svg)](https://jitpack.io/#Carleslc/Simple-YAML) [![Build Status](https://app.travis-ci.com/Carleslc/Simple-YAML.svg?branch=master)](https://app.travis-ci.com/Carleslc/Simple-YAML)\n\n_This Java API provides an easy-to-use way to store data and provide configurations using the YAML format._\n\n[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/carleslc)\n\n## What is YAML?\n\nYAML is a human-readable data-oriented serialization language.\n\nSerialization is the process of translating data structures or object state into a format that can be stored and reconstructed later in the same or another computer environment.\n\nYou can learn more about YAML language [here](https://yaml.org/spec/1.2.2/). Specifically, if you're interested to learn about the YAML syntax you can go to the\n[Chapter 2 of the YAML specification](https://yaml.org/spec/1.2.2/#chapter-2-language-overview).\n\nFilename extensions: `.yaml`, `.yml`\n\n## What is Simple-YAML?\n\nSimple-YAML is a library designed to create configuration files for your programs, tools and plugins.\n\nThe API is a port from [Bukkit](https://github.com/Bukkit/Bukkit) configuration wrapper with some features added, so you can use this library wherever you want without Bukkit dependency.\n\nSimplicity is added with the [`YamlFile`](https://carleslc.me/Simple-YAML/doc/Simple-Yaml/org/simpleyaml/configuration/file/YamlFile.html) class, which has everything you need with easy use for creation, management and serialization of yaml files. It is an extension of [`YamlConfiguration`](https://carleslc.me/Simple-YAML/doc/Simple-Yaml/org/simpleyaml/configuration/file/YamlConfiguration.html).\n\nFurthermore, you can optionally save your files with **comments** in mind. You can write your comments with a text editor as usual.\nIn addition, not only you can preserve your comments but also with this API you can read and add comments programmatically to your configuration. Sounds good, right?\n\n## How to install\n\nTo use this API all you need is to download the [latest Simple-Yaml.jar](https://github.com/Carleslc/Simple-YAML/releases) and put it as a dependency on your project.\n\n### Maven\n\nIf you are using Maven you do not need to download the jar. Instead, add this repository and dependency to your `pom.xml`:\n\n```xml\n\u003crepositories\u003e\n    \u003crepository\u003e\n      \u003cid\u003ejitpack.io\u003c/id\u003e\n      \u003curl\u003ehttps://jitpack.io\u003c/url\u003e\n    \u003c/repository\u003e\n\u003c/repositories\u003e\n```\n\n\u003cdetails\u003e\n  \u003csummary\u003eYaml + Configuration\u003c/summary\u003e\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.Carleslc.Simple-YAML\u003c/groupId\u003e\n    \u003cartifactId\u003eSimple-Yaml\u003c/artifactId\u003e\n    \u003cversion\u003e1.8.4\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\nYou can also use `me.carleslc.Simple-YAML` as the _groupId_.\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eConfiguration only\u003c/summary\u003e\n\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.github.Carleslc.Simple-YAML\u003c/groupId\u003e\n    \u003cartifactId\u003eSimple-Configuration\u003c/artifactId\u003e\n    \u003cversion\u003e1.8.4\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\nYou can also use `me.carleslc.Simple-YAML` as the _groupId_.\n\n\u003c/details\u003e\n\n### Gradle\n\nIf you are using Gradle you do not need to download the jar. Instead, add this repository and dependency to your build file:\n\n```gradle\nallprojects {\n  repositories {\n    maven { url 'https://jitpack.io' }\n  }\n}\n```\n\n\u003cdetails\u003e\n  \u003csummary\u003eYaml + Configuration\u003c/summary\u003e\n\n```gradle\ndependencies {\n  implementation 'com.github.Carleslc.Simple-YAML:Simple-Yaml:1.8.4'\n}\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n  \u003csummary\u003eConfiguration only\u003c/summary\u003e\n\n```gradle\ndependencies {\n  implementation 'com.github.Carleslc.Simple-YAML:Simple-Configuration:1.8.4'\n}\n```\n\n\u003c/details\u003e\n\n## How to use\n\nThe best way to learn how to use this API is through some examples.\n\nYou can find some examples to test [here](https://github.com/Carleslc/Simple-YAML/tree/master/Simple-Yaml/src/test/java/org/simpleyaml/examples).\n\n* [`YamlExample`](https://github.com/Carleslc/Simple-YAML/blob/master/Simple-Yaml/src/test/java/org/simpleyaml/examples/YamlExample.java): An example to create YAML files, save or delete values and move through the file configuration.\n* [`YamlCommentsExample`](https://github.com/Carleslc/Simple-YAML/blob/master/Simple-Yaml/src/test/java/org/simpleyaml/examples/YamlCommentsExample.java): An example to load and save YAML files keeping comments and also how to read and add comments programmatically.\n* [`YamlCommentsFormatExample`](https://github.com/Carleslc/Simple-YAML/blob/master/Simple-Yaml/src/test/java/org/simpleyaml/examples/YamlCommentsFormatExample.java): An example to format header and comments with custom prefixes, suffixes and blank lines.\n* [`YamlEncodingExample`](https://github.com/Carleslc/Simple-YAML/blob/master/Simple-Yaml/src/test/java/org/simpleyaml/examples/YamlEncodingExample.java): A minimal example to check your encoding with Unicode characters.\n* [`YamlSerializationExample`](https://github.com/Carleslc/Simple-YAML/blob/master/Simple-Yaml/src/test/java/org/simpleyaml/examples/YamlSerializationExample.java): An example for saving complex objects using serialization.\n* [`Person`](https://github.com/Carleslc/Simple-YAML/blob/master/Simple-Yaml/src/test/java/org/simpleyaml/examples/Person.java): An example of class for complex objects used in the previous file. Here you can see how to serialize and deserialize objects.\n\nFind the example `.yml` files [here](https://github.com/Carleslc/Simple-YAML/tree/master/Simple-Yaml/src/test/resources).\n\nFor more information and methods see the **Javadoc**:\n\n- [Simple-YAML](https://carleslc.me/Simple-YAML/doc)\n  - [Simple-Yaml](https://carleslc.me/Simple-YAML/doc/Simple-Yaml)\n  - [Simple-Configuration](https://carleslc.me/Simple-YAML/doc/Simple-Configuration)\n\n## Dependencies\n\nThis API uses _SnakeYAML_ underneath. It is already included in the [latest Simple-Yaml.jar](https://github.com/Carleslc/Simple-YAML/releases) and with the maven or gradle dependencies.\n\n* [SnakeYAML](https://bitbucket.org/snakeyaml/snakeyaml)\n    + [Javadoc](https://javadoc.io/doc/org.yaml/snakeyaml/latest/index.html)\n    + [Documentation](https://bitbucket.org/snakeyaml/snakeyaml/wiki/Documentation)\n\n### Looking for other file type configurations?\n\nHave a look to these repositories:\n\n- [XML](https://github.com/portlek/xmlgration)\n- [JSON](https://github.com/portlek/jsongration)\n- [HOCON](https://github.com/portlek/hocongration)\n- [TOML](https://github.com/portlek/tomlgration)\n\nThese projects are using the Simple-Configuration module, but they are not related directly with Simple-YAML.\n","funding_links":["https://ko-fi.com/carleslc"],"categories":["Essential Plugins"],"sub_categories":["No resourcepack"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCarleslc%2FSimple-YAML","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FCarleslc%2FSimple-YAML","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FCarleslc%2FSimple-YAML/lists"}