Skip to content

nyxintrus/SimpleConfig

Repository files navigation

SimpleConfig 📦

A lightweight and easy-to-use configuration library for Java supporting JSON & YAML with dot-path access.


🚀 JitPack


📥 Installation

Gradle (JitPack)

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

dependencies {
    implementation 'com.github.nyxintrus:SimpleConfig:TAG'
}

Maven (JitPack)

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

<dependency>
    <groupId>com.github.nyxintrus</groupId>
    <artifactId>SimpleConfig</artifactId>
    <version>TAG</version>
</dependency>

⚡ Features

  • 🧠 Simple dot-path system (user.1.name)
  • 📄 JSON & YAML support
  • 💾 Auto-save support
  • 🔧 Easy API (no boilerplate)
  • 🚀 Lightweight & fast
  • 🧩 Extensible architecture

📦 Usage

Load config

Config config = Config.load("config.json");

or

Config config = Config.load("config.yml");

Set values

config.set("user.1.name", "Niko");
config.set("user.1.age", "90");

Get values

String name = config.getString("user.1.name", "default");
int age = config.getInt("user.1.age", 0);

Save config

config.save();

📄 Example JSON output

{
  "user": {
    "1": {
      "name": "Niko",
      "age": "90"
    }
  }
}

📄 Example YAML output

user:
  "1":
    name: Niko
    age: "90"

🧠 Why SimpleConfig?

Most config libraries are:

  • too heavy
  • too complex
  • or require too much boilerplate

SimpleConfig focuses on:

Do one thing, but do it simple.


🛠 Roadmap

  • Auto reload system
  • Annotation-based config
  • List support improvements
  • Better type system
  • YAML comments support

🤝 Contributing

Pull requests are welcome.


📜 License

MIT License

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages