{"id":16203188,"url":"https://github.com/pardeike/rimworld-modfeatures","last_synced_at":"2025-10-17T09:04:01.188Z","repository":{"id":190084764,"uuid":"681913444","full_name":"pardeike/RimWorld-ModFeatures","owner":"pardeike","description":"Shows features and small tutorials in RimWorld mods","archived":false,"fork":false,"pushed_at":"2025-07-09T19:42:20.000Z","size":531,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-07-09T21:32:18.787Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C#","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/pardeike.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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}},"created_at":"2023-08-23T03:17:30.000Z","updated_at":"2025-07-09T19:40:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"a7c2302d-0e0e-4930-939f-ed833659970a","html_url":"https://github.com/pardeike/RimWorld-ModFeatures","commit_stats":null,"previous_names":["pardeike/rimworld-modfeatures"],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/pardeike/RimWorld-ModFeatures","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pardeike%2FRimWorld-ModFeatures","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pardeike%2FRimWorld-ModFeatures/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pardeike%2FRimWorld-ModFeatures/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pardeike%2FRimWorld-ModFeatures/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pardeike","download_url":"https://codeload.github.com/pardeike/RimWorld-ModFeatures/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pardeike%2FRimWorld-ModFeatures/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264780277,"owners_count":23662609,"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-10T09:52:39.301Z","updated_at":"2025-10-17T09:03:56.155Z","avatar_url":"https://github.com/pardeike.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RimWorld Mod Features Library\n\n## How to Use\n\nTo use ModFeatures, install it at startup with\n\n```cs\nusing Brrainz;\n// install and schedule dialog until a game is started or loaded\nModFeatures.Install\u003cYourModClass\u003e();  // YourModClass is the class extending 'Mod'\n```\n\nand create a folder called `Features` in your mod root (same level as `About`). Put `.png` and `.mp4` files into that folder and name them `nn_title.xxx`. For example:\n\n- 01_Welcome.png\n- 02_Introduction.mp4\n- 03_Stuff.png\n- 04_MoreStuff.mp4\n\nFor each file, you should have translation strings in your mod in the form of\n\n```xml\n\u003cFeature_YourModClass_Welcome\u003eWelcome to my mod!\u003c/Feature_YourModClass_Welcome\u003e\n\u003cFeature_YourModClass_Introduction\u003eIntroduction\u003c/Feature_YourModClass_Introduction\u003e\n```\n\nMake sure YourModClass matches the class name that extends `Mod`.\n\nYou can also trigger the dialog again by calling\n\n```cs\nusing Brrainz;\n\n// don't call this at startup, only on demand by the user\nvar showAllFeatures = true;\nvar unseen = ModFeatures.UnseenFeatures\u003cYourModClass\u003e();\nif (unseen \u003e 0 || showAllFeatures)\n{\n   ModFeatures.ShowAgain\u003cYourModClass\u003e(showAllFeatures);\n}\n```\n\nThat's it. You will automatically get a feature dialog displayed when the player starts or loads a game. The user can remove topics and the preferences for that are stored in\n\n```txt\n......\\LocalLow\\Ludeon Studios\\RimWorld by Ludeon Studios\\Config\\ModFeatures\\\n```\n\nEnjoy\n/Brrainz","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpardeike%2Frimworld-modfeatures","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpardeike%2Frimworld-modfeatures","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpardeike%2Frimworld-modfeatures/lists"}