{"id":16636366,"url":"https://github.com/isxander/settxi","last_synced_at":"2025-10-30T06:31:41.992Z","repository":{"id":37485585,"uuid":"403385518","full_name":"isXander/Settxi","owner":"isXander","description":"Delegate orientated settings library.","archived":false,"fork":false,"pushed_at":"2023-06-07T20:22:10.000Z","size":193,"stargazers_count":4,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-02T06:51:11.159Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/isXander.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-09-05T18:36:00.000Z","updated_at":"2024-01-10T20:29:25.000Z","dependencies_parsed_at":"2023-01-29T04:01:19.158Z","dependency_job_id":null,"html_url":"https://github.com/isXander/Settxi","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/isXander%2FSettxi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/isXander%2FSettxi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/isXander%2FSettxi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/isXander%2FSettxi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/isXander","download_url":"https://codeload.github.com/isXander/Settxi/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238941559,"owners_count":19556006,"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","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":[],"created_at":"2024-10-12T06:06:39.044Z","updated_at":"2025-10-30T06:31:36.653Z","avatar_url":"https://github.com/isXander.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# `Settxi`\n*Delegates-based settings library.*\n\n```kt\nvar settxiIsAwesome by boolean(true) {\n    name = \"Awesome\"\n    description = \"Is Settxi awesome or not.\"\n    category = \"Settxi\"\n}\n```\n\n## Usage\nAdd https://maven.isxander.dev to your repositories list:\n```kts\nrepositories {\n    maven(\"https://maven.isxander.dev/releases\")\n}\n```\n\nYou can then depend on any Settxi module you want:\n```kts\ndependencies {\n    implementation(\"dev.isxander.settxi:settxi-core:2.4.0\")\n}\n```\n\n## Not just a settings library\nSettxi provides serialization and GUI implementations for various libraries.\n\n### Serialization\n#### kotlinx.serialization\nDepend on the `settxi-kotlinx-serialization` module in your gradle buildscript.\n\n```kts\nimplementation(\"dev.isxander.settxi:settxi-kotlinx-serialization:2.4.0\")\n```\n\nNow you can save and load from a file using JSON!\n\n```kt\n import java.nio.file.Path\n\n object SettxiSettings : SettxiConfigKotlinx(Path.of(\"~/.config/settxi.json\")) {\n     // the power of settxi is at your fingertips!\n     \n     // make sure to import from the file at the end of your class!\n     init {\n         import()\n     }\n }\n```\n\n#### Gson\nDepend on the `settxi-gson` module in your gradle buildscript.\n\n```kts\nimplementation(\"dev.isxander.settxi:settxi-gson:2.4.0\")\n```\n\nNow you can save and load from a file using JSON!\n\n```kt\n import java.nio.file.Path\n\n object SettxiSettings : SettxiConfigGson(Path.of(\"~/.config/settxi.json\")) {\n     // the power of settxi is at your fingertips!\n     \n     // make sure to import from the file at the end of your class!\n     init {\n         import()\n     }\n }\n```\n\n### GUI\n#### [Cloth Config](https://github.com/shedaniel/cloth-config) (Minecraft)\nDepend on the `settxi-gui-cloth-config` module in your gradle buildscript.\n\n```kts\nimplementation(\"dev.isxander.settxi:settxi-gui-cloth-config:2.4.0\")\n```\n\nNow you can easily create a cloth config screen to be displayed in Minecraft!\nRequires you use `SettxiConfig` or implementations\n\n```kt\n// you could use SettxiConfigKotlinx etc\nobject SettxiSettings : SettxiConfig() {\n    // ... the power of settxi is at your fingertips!\n}\n\nSettxiSettings.clothGui(title = Text.empty(), parent = null) // now you have a Screen\n```\n\nYou can register factories for custom `Setting` classes as well.\nLearn how [on the wiki](https://github.com/isXander/Settxi/wiki/Usage#cloth-config-minecraft)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fisxander%2Fsettxi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fisxander%2Fsettxi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fisxander%2Fsettxi/lists"}