# Simple-YAML

**Repository Path**: shanhanyu/Simple-YAML

## Basic Information

- **Project Name**: Simple-YAML
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-10-17
- **Last Updated**: 2024-10-17

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Simple YAML

[![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)

_This Java API provides an easy-to-use way to store data and provide configurations using the YAML format._

[![ko-fi](https://www.ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/carleslc)

## What is YAML?

YAML is a human-readable data-oriented serialization language.

Serialization 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.

You 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
[Chapter 2 of the YAML specification](https://yaml.org/spec/1.2.2/#chapter-2-language-overview).

Filename extensions: `.yaml`, `.yml`

## What is Simple-YAML?

Simple-YAML is a library designed to create configuration files for your programs, tools and plugins.

The 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.

Simplicity 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).

Furthermore, you can optionally save your files with **comments** in mind. You can write your comments with a text editor as usual.
In 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?

## How to install

To 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.

### Maven

If you are using Maven you do not need to download the jar. Instead, add this repository and dependency to your `pom.xml`:

```xml
<repositories>
    <repository>
      <id>jitpack.io</id>
      <url>https://jitpack.io</url>
    </repository>
</repositories>
```

<details>
  <summary>Yaml + Configuration</summary>

```xml
<dependency>
    <groupId>com.github.Carleslc.Simple-YAML</groupId>
    <artifactId>Simple-Yaml</artifactId>
    <version>1.8.4</version>
</dependency>
```

You can also use `me.carleslc.Simple-YAML` as the _groupId_.

</details>

<details>
  <summary>Configuration only</summary>

```xml
<dependency>
    <groupId>com.github.Carleslc.Simple-YAML</groupId>
    <artifactId>Simple-Configuration</artifactId>
    <version>1.8.4</version>
</dependency>
```

You can also use `me.carleslc.Simple-YAML` as the _groupId_.

</details>

### Gradle

If you are using Gradle you do not need to download the jar. Instead, add this repository and dependency to your build file:

```gradle
allprojects {
  repositories {
    maven { url 'https://jitpack.io' }
  }
}
```

<details>
  <summary>Yaml + Configuration</summary>

```gradle
dependencies {
  implementation 'com.github.Carleslc.Simple-YAML:Simple-Yaml:1.8.4'
}
```

</details>

<details>
  <summary>Configuration only</summary>

```gradle
dependencies {
  implementation 'com.github.Carleslc.Simple-YAML:Simple-Configuration:1.8.4'
}
```

</details>

## How to use

The best way to learn how to use this API is through some examples.

You can find some examples to test [here](https://github.com/Carleslc/Simple-YAML/tree/master/Simple-Yaml/src/test/java/org/simpleyaml/examples).

* [`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.
* [`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.
* [`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.
* [`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.
* [`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.
* [`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.

Find the example `.yml` files [here](https://github.com/Carleslc/Simple-YAML/tree/master/Simple-Yaml/src/test/resources).

For more information and methods see the **Javadoc**:

- [Simple-YAML](https://carleslc.me/Simple-YAML/doc)
  - [Simple-Yaml](https://carleslc.me/Simple-YAML/doc/Simple-Yaml)
  - [Simple-Configuration](https://carleslc.me/Simple-YAML/doc/Simple-Configuration)

## Dependencies

This 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.

* [SnakeYAML](https://bitbucket.org/snakeyaml/snakeyaml)
    + [Javadoc](https://javadoc.io/doc/org.yaml/snakeyaml/latest/index.html)
    + [Documentation](https://bitbucket.org/snakeyaml/snakeyaml/wiki/Documentation)

### Looking for other file type configurations?

Have a look to these repositories:

- [XML](https://github.com/portlek/xmlgration)
- [JSON](https://github.com/portlek/jsongration)
- [HOCON](https://github.com/portlek/hocongration)
- [TOML](https://github.com/portlek/tomlgration)

These projects are using the Simple-Configuration module, but they are not related directly with Simple-YAML.