{"id":31040027,"url":"https://github.com/destuur/kcdutils","last_synced_at":"2025-09-14T08:04:49.613Z","repository":{"id":311409749,"uuid":"1043459235","full_name":"Destuur/KCDUtils","owner":"Destuur","description":"Lua Wrapper for Kingdom Come: Deliverance 2","archived":false,"fork":false,"pushed_at":"2025-09-09T22:30:02.000Z","size":463,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-10T02:12:49.485Z","etag":null,"topics":["kcd2","lua","modding"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Destuur.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-08-23T22:41:17.000Z","updated_at":"2025-09-03T18:12:35.000Z","dependencies_parsed_at":"2025-08-24T14:57:47.667Z","dependency_job_id":"3342d909-8d2b-417f-9c43-eb19818c4c65","html_url":"https://github.com/Destuur/KCDUtils","commit_stats":null,"previous_names":["destuur/kcdutils"],"tags_count":33,"template":false,"template_full_name":null,"purl":"pkg:github/Destuur/KCDUtils","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Destuur%2FKCDUtils","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Destuur%2FKCDUtils/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Destuur%2FKCDUtils/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Destuur%2FKCDUtils/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Destuur","download_url":"https://codeload.github.com/Destuur/KCDUtils/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Destuur%2FKCDUtils/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275076599,"owners_count":25401319,"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-14T02:00:10.474Z","response_time":75,"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":["kcd2","lua","modding"],"created_at":"2025-09-14T08:04:48.842Z","updated_at":"2025-09-14T08:04:49.608Z","avatar_url":"https://github.com/Destuur.png","language":"Lua","funding_links":[],"categories":[],"sub_categories":[],"readme":"![KCDUtils – 9 out of 10 blacksmiths praise it… the 10th burned his forge.](https://i.imgur.com/OJsBmGU.png)\n\n# KCDUtils\n\n**Version:** \u003c!--VERSION--\u003e0.2.0\u003c!--/VERSION--\u003e  \n**Author:** Destuur  \n**Game:** Kingdom Come: Deliverance 2  \n\n\n\n## Overview\n\n**KCDUtils** is a collection of Lua utilities designed to simplify modding in **Kingdom Come: Deliverance 2**.  \nIt provides ready-to-use functions, helpers, and a consistent framework for creating Lua-based mods.\n\n\n\n## Features\n\n- Modular utility scripts organized under `Scripts/Mods/KCDUtils`.  \n- Core loader file: `kcdutils.lua`.  \n- Helper functions for common gameplay modifications, event handling, and data management.  \n- Fully structured mod folder with `mod.manifest` for seamless integration.  \n- Namespaced under `KCDUtils` to prevent conflicts with other mods.\n\n\n\n## Installation\n\n1. Download the latest release ZIP.  \n2. Extract the contents into your `Mods` folder:\n    ```\n    ../KingdomComeDeliverance2/Mods/\n    ```\n3. Folder structure:\n\n    kcdutils/\n      Data/\n        kcdutils/\n          Scripts/\n            Mods/\n              kcdutils.lua\n              KCDUtils/\n                (all utility Lua files)\n      mod.manifest\n\n\n\n## Dependencies\n\n- **LuaDB** is required only if you want to use database-related utilities.\n  Players using mods depending on KCDUtils with DB functionality must also have LuaDB installed: [LuaDB on Nexus Mods](https://www.nexusmods.com/kingdomcomedeliverance2/mods/1523).\n\n### Be aware, that also KCDUtils.Config uses LuaDB, to persist config values.\n\n\n\n## Usage\n\n\u003e [!IMPORTANT]\n\u003e Before using instantiated KCDUtils functions in your mod, you **must register your mod** with `KCDUtils.RegisterMod()`.  \n\u003e This ensures that the DB, Logger, Config, and other utility tables are correctly instantiated and namespaced.\n\n1. Set table at the top of your entry .lua file:  \n\n    ```lua\n    {{MODNAME_CLASS}} = {{MODNAME_CLASS}} or { Name = \"{{MODNAME_CLASS}}\" }\n    ```\n\n2. Register mod right after, and before calling your first function to get instantiated utils:  \n\n    ```lua\n    {{MODNAME_CLASS}}.DB, {{MODNAME_CLASS}}.Logger = KCDUtils.RegisterMod({{MODNAME_CLASS}})\n    ```\n\n3. Explore the scripts in `KCDUtils/` to see available helper functions.\n\n\n\n## Notes\n\n- KCDUtils is **standalone**, no other dependencies required for general utilities.  \n- Future updates will include new utility functions and improvements.  \n\n\n\n## License\n\nThis project is released under the MIT License. See the [`LICENSE`](https://github.com/Destuur/KCDUtils/blob/main/LICENSE) file for details.\nPlease credit the author **Destuur** and **KCDUtils framework** when using it in your mods, for example on Nexus Mods.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdestuur%2Fkcdutils","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdestuur%2Fkcdutils","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdestuur%2Fkcdutils/lists"}