[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8,"_9":10,"_11":12,"_13":14},"actionData","errors","root",{"_224":225,"_226":-7,"_227":228,"_25":229},"c/Community",{"_66":207,"_25":208},"p/packageListing",{"_66":67,"_68":69,"_70":-7,"_71":72,"_57":-7,"_73":20,"_74":22,"_75":24,"_25":76},"wikiLayout",{"_15":56,"_19":20,"_21":22,"_23":24,"_40":-7,"_57":-7,"_25":58},"p/tabs/Wiki/WikiFirstPage",{"_15":16,"_17":18,"_19":20,"_21":22,"_23":24,"_25":26},"wiki",{"_37":48,"_35":49,"_40":50,"_42":51,"_44":52,"_53":54},"firstPage",{"_37":38,"_35":39,"_40":41,"_42":43,"_44":45,"_46":47},"communityId","valheim","namespaceId","shudnal","packageId","ExtraSlots","seo",{"_27":28},"descriptors",[29,30],{"_35":36},{"_31":32,"_33":34},"name","description","content","Wiki page for shudnal-ExtraSlots","title","Extra Slots API - shudnal-ExtraSlots | Thunderstore","id","2764","Extra Slots API","slug","2764-extra-slots-api","datetime_created","2024-11-11T03:54:06.971432Z","datetime_updated","2024-11-13T05:00:07.129634Z","markdown_content","# Extra Slots API\n\nI can add more methods to API if you miss something reasonable. Open a [github issue](https://github.com/shudnal/ExtraSlotsAPI/issues).\n\nYou can either use this API with ExtraSlots set as BepInEx hard dependency or soft dependency.\n\n[API methods with summary](https://github.com/shudnal/ExtraSlots/blob/master/API.cs)\n\n## Hard dependency\n\nHard dependency means your mod will not work without ExtraSlots installed.\n\nAdd attribute\n```[BepInDependency(\"shudnal.ExtraSlots\", BepInDependency.DependencyFlags.HardDependency)]```\nbefore your `BaseUnityPlugin` declaration\n\nAdd reference to ExtraSlots.dll and use its API methods from main mod like `ExtraSlots.API.GetExtraSlots()`.\n\n## Soft dependency\n\nSoft dependency means you will be able to use `ExtraSlotsAPI.API` methods wherever main ExtraSlots mod is installed or not.\n\nTo be sure your mod is always loaded after ExtraSlots add attribute\n```[BepInDependency(\"shudnal.ExtraSlots\", BepInDependency.DependencyFlags.SoftDependency)]```\nbefore your `BaseUnityPlugin` declaration\n\nIn this case you need to merge ExtraSlotsAPI.dll into your mod's dll.\n\n* [Download ExtraSlotsAPI.dll (github)](https://github.com/shudnal/ExtraSlots/releases/download/ExtraSlotsAPI/ExtraSlotsAPI.dll)\n* Add it into your project\n* Set the file property \"Copy to output directory\" to \"Copy if newer\" or \"Copy always\".\n\nYou need NuGet Package `ILRepack.Lib.MSBuild.Task` to merge your dll with ExtraSlotsAPI.dll.\n\nIf you use VisualStudio:\n* right click on the project\n* Manage NuGet packages\n* set tab to Browse\n* find `ILRepack.Lib.MSBuild.Task` and install most downloaded version\n\nILRepacks read the contents of file `ILRepack.targets` located in the root folder of your project.\n\n* Add new file to your project and name it `ILRepack.targets`\n* Insert following block in the file and save it\n```xml\n\n\n\t\n\t\t\n\t\t\t\n\t\t\t\n\t\t\n\t\t\n\t\n\n```\n\nTry to build a project and see if you are getting similar lines in build output\n```\n1> Added assembly 'bin\\Debug\\ExtraSlotsAPI.dll'\n1> Merging 2 assembies to '...\\bin\\Debug\\YourModName.dll'\n```\n\nNow you can be sure your `ExtraSlotsAPI.API` is always available.\n\nFor more info about what API method result see [API methods with summary](https://github.com/shudnal/ExtraSlots/blob/master/API.cs).\n\nIn short you can add/remove slots and get various slots related info.\n\nNow to API calls:\n* Add a reference to ExtraSlotsAPI.dll to your project\n* Paste line `ExtraSlotsAPI.API.IsReady()` into your mod Awake function and see if it works as correct method call\n\n## Example\n\nI use ExtraSlotsAPI to add custom slot in my [CircletExtended](https://github.com/shudnal/CircletExtended) and [HipLantern](https://thunderstore.io/c/valheim/p/shudnal/HipLantern/) mods.\n\nNext will be an example from CircletExtended mod.\n\nI need my Circlet slot to appear before Lantern slot for more intuitive layout.\n\nI define related config entries that state should mod create an extra slot, how it should be named and should it wait for item discovery for slot to be active.\n```c#\npublic static ConfigEntry itemSlotExtraSlots; // Enable or disable slot entirely\npublic static ConfigEntry itemSlotNameExtraSlots; // Slot name (any string)\npublic static ConfigEntry itemSlotIndexExtraSlots; // Slot position in layout\npublic static ConfigEntry itemSlotExtraSlotsDiscovery; // Should slot be active only after circlet discovery\n```\nthen I initialize config variables\n```c#\nitemSlotExtraSlots = Config.Bind(\"Circlet - Custom slot\", \"ExtraSlots - Create slot\", true, \"Create custom equipment slot with ExtraSlots.\");\nitemSlotNameExtraSlots = Config.Bind(\"Circlet - Custom slot\", \"ExtraSlots - Slot name\", \"Circlet\", \"Custom equipment slot name.\");\nitemSlotIndexExtraSlots = Config.Bind(\"Circlet - Custom slot\", \"ExtraSlots - Slot index\", -1, \"Slot index (position). Game restart is required to apply changes.\");\nitemSlotExtraSlotsDiscovery = Config.Bind(\"Circlet - Custom slot\", \"ExtraSlots - Available after discovery\", true, \"If enabled - slot will be active only if you know circlet item.\");\n\nitemSlotExtraSlots.SettingChanged += (s, e) => ExtraSlotsAPI.API.UpdateSlots(); // After enabling/disabling slot call a method to update slots layout\n```\nAnd then all I need is to call this in Awake function\n```c#\nif (ExtraSlotsAPI.API.IsReady())\n if (itemSlotIndexExtraSlots.Value < 0)\n ExtraSlotsAPI.API.AddSlotBefore(\"CircletExtended\", () => itemSlotNameExtraSlots.Value, item => IsCircletItem(item), () => IsCircletSlotAvailable(), \"HipLantern\");\n else\n ExtraSlotsAPI.API.AddSlotWithIndex(\"CircletExtended\", itemSlotIndexExtraSlots.Value, () => itemSlotNameExtraSlots.Value, item => IsCircletItem(item), () => IsCircletSlotAvailable());\n```\nFirst argument `\"CircletExtended\"` is slot ID which should be unique and can be used later to get if slot in grid is that slot.\n\nThis defines slot name as a function and if you change `itemSlotNameExtraSlots` config value it will be automatically updated.\n\n`IsCircletItem` is the function to check if item type is correct. It should return if item fits the slot.\n\n`IsCircletSlotAvailable` is the function that return should slot be active. If the result is changed for best result you should call `ExtraSlots.API.UpdateSlots()` to update layout. In this example it is handled by action on `itemSlotExtraSlots.SettingChanged`.\n\nUsed functions (example):\n```c#\ninternal static bool IsCircletItem(ItemDrop.ItemData item) => item != null && item.m_shared.m_itemType == ItemDrop.ItemData.ItemType.Helmet; // There could be more intricate logic\n\ninternal static bool IsCircletSlotAvailable() => itemSlotExtraSlots.Value && (!itemSlotExtraSlotsDiscovery.Value || IsCircletKnown());\n\ninternal static bool IsCircletKnown()\n{\n if (!Player.m_localPlayer || Player.m_localPlayer.m_isLoading) // m_isLoading check is recommended to properly load inventory layout without item to be moved to other slot, even if only temporarily.\n return true;\n\n return Player.m_localPlayer.IsKnownMaterial(\"$item_helmet_dverger\"); // There could be more intricate logic\n}\n```\n\nThis is the basic example. Real logic for CircletExtended is [there](https://github.com/shudnal/CircletExtended/blob/b5c8af365631191ddb9543b2641870ef28c9950a/CircletExtended.cs#L148).\n\nIf you have questions feel free to reach me at [discord](https://discord.com/users/shudnal), Nexus or just open github issue.","1489","shudnal/ExtraSlots Wiki","1489-shudnalextraslots-wiki","2024-11-11T03:54:06.964424Z","2024-11-13T05:00:07.132606Z","pages",[55],{"_37":38,"_35":39,"_40":41,"_42":43,"_44":45},{"_37":48,"_35":49,"_40":50,"_42":51,"_44":52,"_53":64},"permissions",{"_27":59},[60,61],{"_35":63},{"_31":32,"_33":62},"Wiki for shudnal-ExtraSlots","shudnal-ExtraSlots Wiki | Thunderstore",[65],{"_37":38,"_35":39,"_40":41,"_42":43,"_44":45},"community",{"_31":124,"_105":20,"_188":189,"_32":190,"_191":192,"_193":194,"_42":195,"_196":197,"_198":199,"_113":200,"_201":202,"_203":204,"_205":206},"listing",{"_109":110,"_73":20,"_32":97,"_111":112,"_113":95,"_114":115,"_116":115,"_117":115,"_31":24,"_118":22,"_119":120,"_121":122,"_123":124,"_125":126,"_127":128,"_129":130,"_131":132,"_133":134,"_135":136,"_137":138,"_139":140,"_71":141,"_142":143,"_144":145,"_146":147},"listingStatus","team",{"_105":106,"_31":22,"_107":108},"community_identifier","namespace_id","package_id",{"_27":77},[78,79,80,81,82,83,84,85,86,87],{"_35":104},{"_31":32,"_33":97},{"_88":102,"_33":103},{"_88":100,"_33":101},{"_88":98,"_33":99},{"_88":96,"_33":97},{"_88":94,"_33":95},{"_88":93,"_33":92},{"_88":91,"_33":92},{"_88":89,"_33":90},"property","og:site_name","Thunderstore","og:image:height","256","og:image:width","og:image","https://gcdn.thunderstore.io/live/repository/icons/shudnal-ExtraSlots-1.1.18.png","og:description","More inventory slots dedicated for equipment, food, ammo and misc items. Extra utility slots. Quick slots. Custom slots API. Player inventory resize. Gamepad friendly. Slot obtaining progression.","og:title","ExtraSlots by shudnal","og:url","https://thunderstore.io/c/valheim/p/shudnal/ExtraSlots/wiki/","og:type","website","ExtraSlots | Thunderstore - The Valheim Mod Database","identifier",11237,"donation_link","https://buymeacoffee.com/shudnal","categories",[164,165,166,167,168,169],"download_count",719541,"icon_url","is_deprecated",false,"is_nsfw","is_pinned","namespace","rating_count",86,"size",224187,"community_name","Valheim","dependant_count",389,"dependencies",[150,151],"dependency_count",2,"download_url","https://thunderstore.io/package/download/shudnal/ExtraSlots/1.1.18/","full_version_name","shudnal-ExtraSlots-1.1.18","has_changelog",true,"install_url","ror2mm://v1/install/thunderstore.io/shudnal/ExtraSlots/1.1.18/","latest_version_number","1.1.18",{"_31":22,"_148":149},"website_url","https://github.com/shudnal/ExtraSlots","package_created","2024-11-11T03:42:05.646501Z","version_created","2026-06-07T02:26:13.703509Z","members",[],{"_73":20,"_32":159,"_113":160,"_154":136,"_31":161,"_118":162,"_157":163},{"_73":20,"_32":152,"_113":153,"_154":136,"_31":155,"_118":156,"_157":158},"Shared version 16.3.0 of YamlDotNet from Antoine Aubry and contributors, net47 package for use in Valheim mods. Maintained by the ValheimModding team.","https://gcdn.thunderstore.io/live/repository/icons/ValheimModding-YamlDotNet-16.3.1.png","is_active","YamlDotNet","ValheimModding","version_number","16.3.1","BepInEx pack for Valheim. Preconfigured with the correct entry point for mods and preferred defaults for the community.","https://gcdn.thunderstore.io/live/repository/icons/denikson-BepInExPack_Valheim-5.4.2333.png","BepInExPack_Valheim","denikson","5.4.2333",{"_31":185,"_40":186,"_37":187},{"_31":182,"_40":183,"_37":184},{"_31":179,"_40":180,"_37":181},{"_31":176,"_40":177,"_37":178},{"_31":173,"_40":174,"_37":175},{"_31":170,"_40":171,"_37":172},"Bog Witch Update","bog-witch-update","1068","Utility","utility","42","Client-side","client-side","30","Server-side","server-side","29","Misc","misc","22","Gear","gear","21","short_description","A brutal exploration and survival game for 1-10 players, set in a procedurally-generated purgatory inspired by viking culture. Battle, build, and conquer your way to a saga worthy of Odin’s patronage!","Mod database and API for downloading Valheim mods","wiki_url","https://github.com/Valheim-Modding/Wiki/wiki","discord_url","https://discord.gg/RBq2mzeu4z","2021-02-14T00:27:10.692944Z","hero_image_url","https://gcdn.thunderstore.io/live/community/valheim/valheim-bg-1920x620.webp","cover_image_url","https://gcdn.thunderstore.io/live/community/valheim/valheim-cover-360x480.png","https://gcdn.thunderstore.io/live/community/valheim/PNG_color_logo_only_1_transparent.png","community_icon_url","https://gcdn.thunderstore.io/live/community/valheim/valheim-icon-192x192.png","total_download_count",154344263,"total_package_count",10592,{"_31":124,"_105":20,"_188":189,"_32":190,"_191":192,"_193":194,"_42":195,"_196":197,"_198":199,"_113":200,"_201":202,"_203":204,"_205":206},{"_27":209},[210,211,212,213,214,215,216,217,218,219],{"_35":222},{"_31":32,"_33":223},{"_88":102,"_33":103},{"_88":100,"_33":101},{"_88":98,"_33":222},{"_88":96,"_33":221},{"_88":94,"_33":202},{"_88":93,"_33":220},{"_88":91,"_33":220},{"_88":89,"_33":90},"88","Thunderstore is a mod database and API for downloading Valheim mods","The Valheim Mod Database","Mods for Valheim","publicEnvVariables",{"_248":246,"_249":246,"_250":246,"_251":252,"_253":254,"_255":246,"_256":257,"_258":259,"_260":261},"currentUser","config",{"_245":246,"_247":-7},{"_27":230},[231,232,233,234,235,236],{"_35":90},{"_31":32,"_33":244},{"_31":243,"_33":242},{"_31":241,"_33":242},{"_239":240},{"_31":237,"_33":238},"viewport","width=device-width, initial-scale=1","charSet","utf-8","theme-color","#29295b","msapplication-TileColor","An ecosystem for sharing mods for games!","apiHost","https://thunderstore.io","sessionId","VITE_SITE_URL","VITE_BETA_SITE_URL","VITE_API_URL","VITE_COOKIE_DOMAIN",".thunderstore.io","VITE_AUTH_BASE_URL","https://auth.thunderstore.io","VITE_AUTH_RETURN_URL","VITE_CLIENT_SENTRY_DSN","https://0dde07a3b02487bf768e90666ab8a83f@o578525.ingest.us.sentry.io/4509966833352704","VITE_RYBBIT_SITE_ID","00e7a81e15fc","VITE_RYBBIT_ANALYTICS_HOST","https://rybbit.thunderstore.io/api"]

Details

Categories

Extra Slots API

Categories

Extra Slots API

Categories