[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8,"_9":10,"_11":12,"_13":14},"actionData","errors","root",{"_189":190,"_191":-7,"_192":193,"_25":194},"c/Community",{"_66":170,"_171":172,"_25":173},"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":41,"_57":-7,"_25":58},"p/tabs/Wiki/WikiPage",{"_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},"page",{"_37":38,"_35":39,"_40":41,"_42":43,"_44":45,"_46":47},"communityId","inscryption","namespaceId","CORE_API_TEAM","packageId","Example_Mod","seo",{"_27":28},"descriptors",[29,30],{"_35":36},{"_31":32,"_33":34},"name","description","content","Wiki page for CORE_API_TEAM-Example_Mod","title","How to Utilize this Package - CORE_API_TEAM-Example_Mod | Thunderstore","id","2771","How to Utilize this Package","slug","2771-how-to-utilize-this-package","datetime_created","2024-11-17T20:43:19.918039Z","datetime_updated","2025-01-09T02:02:20.668246Z","markdown_content","# Guideline\nWe see you wish to upload a mod to thunderstore or are just curious about this file. This file will go over the following; What to change in the setup for your own mod, how to put your mods contents into this mod, how to override other mods contents, how to upload your mod to thunderstore, and finally how to update a mod.\n\n## What to change in your Mod's setup if it is based on this one:\nThis will be somewhat stepped in areas and in others written in a paragraph or table.\n\n### The `icon.png` file;\nThis is a file that is used for your plugins logo on thunderstore it should be a `256x256` image showing a preview of your plugin or just a fancy version of the title. Make sure that it relates 100% to what your mod is and is not just randomly taken off the internet. If you dont want to make one you can ask for one in your modding community's discord if it has an adjacent to an `Mod-Art-Request` channel. Heres an example of a `icon.png` on a thunderstore mod shown below this paragraph.\n\n![image](https://gcdn.thunderstore.io/live/repository/icons/CORE_API_TEAM-Example_Mod-1.0.0.png.256x256_q95_crop.png)\n\nHere you can see the basic format of some of `@thincreator3483`'s icons; A border element to keep the art within the specified area being `256x256`. It has the title featured to Highlight the name of the mod in this case `Example Mod`. It also features the Cog and Wrench to signify that it should be modified and not used as is, although thats only noticable if you look extra hard. Essentially your icon should convey the point of the mod as a simple preview of its contents, and not just a quick doodle or a image off the internet as it obscures what your mod is doing.\n\n### The `README.md` file;\n\nFor this file we reccomend using [Markdown Live Preview](https://markdownlivepreview.com) to help you format your file. This file should explain what the mod does, while also being discriptive and basic. You can use Tables, Bullet Lists, Numbered Lists, or even Images to help convey what your trying to describe. If you need an example on how to format these just look at the way this files information is setup. \n

To Continue on based on the provided setup we would include the following:

\n\n```md\n## How to Install Mods(Example):\n\n### Installing with a Mod Manager\nThis is the recommended way to install BepInEx to the game.\n\n1. Download and install [Thunderstore Mod Manager]() or [r2modman]().\n2. Click the **Install with Mod Manager** button on the top of [BepInEx's]() page.\n3. Run the game via the mod manager.\n\n### Installing Manually\n1. Install [BepInEx]() or [BepInEx]() by pressing 'Manual Download' and extract the contents into a folder. **Do not extract into the game folder!**\n2. Move the contents of the extracted folder into the game folder (where the game executable is).\n3. Run the game. If everything was done correctly, you will see the BepInEx console appear on your desktop. Close the game after it finishes loading.\n4. Place all Plugins into `BepInEx/plugins` in their own unique folder some zips contain a folder labeled Plugins at root, you need to go a folder in than put that into the plugins folder.\n\n### Mac & Linux:\n1. Follow the steps here first: [Here]()\n2. Next do step 4 of the Manual Installation\n3. Your game should be setup for inscryption modding now\n\n### Installing on the Steam Deck (Note You may need to modify this setup if its found to be wrong, If it is, this file should be updated to cover such.)\n1. Download [BepInEx](https://www.nexusmods.com/tcgcardshopsimulator/mods/2)\n2. Go to `Installed Files` click `Browse` to open the folder containing The Game's local files; Put the contents Of the zip in this folder.\n3. Download the mods you plan on using and their dependencies, You will need to unzip them.\n4. Make a folder for each plugin than place them in BepInEx/plugins.\n5. Enter Gaming Mode and check 'Force the use of a specific Steam Play compatibility tool' in the Properties menu under `Compatibility`.\n6. Go to the launch parameters and enter `WINEDLLOVERRIDES=“winhttp.dll=n,b” %command%`.\n7. Open the Game. If everything was done correctly, you should see a console appear on your screen.\n```\nModify the above to match the installation information of your game, and modify the below to match your contact details.\n```md\n## How to Contact Me(Example):\n\n* The Modding Discord Server for Thunderstore: https://discord.gg/kCp4mRAVUE\n* The Modding Discord Server for Nexus: https://discord.gg/ka7s2PxsG5\n* My X Profile: https://twitter.com/thincreator3483\n* My Bluesky Profile: https://bsky.app/profile/thincreator3483.bsky.social\n* My Reddit Profile: https://www.reddit.com/user/Thincreator3483\n* My Discord Tag: thincreator3483\n```\n

\\n

Click me

\\n Your Contents \\n

``` |\n\nIf anything else should be covered here let `@Thincreator3483` know on discord. Once you finish setting up the `README.md` how you would like it to be presented either copy paste it into the provided `README.md` or make a new file called `README.md` this can be created either via renaming a `.txt` file in file explorer if `Hide File Extensions` is disabled or via creating a file in a Text Editor and saving the file when asked replace the `.txt` part or whatever it shows with `.md`. We personally would reccomend utilizing [Visual Studio Code](https://code.visualstudio.com) or [Atom](https://atom-editor.cc) but any will work including regular old Notepad.\n\n### The `CHANGELOG.md` File;\n\nThis file is very similar to the `README.md` so Utilize that guide but the thing this file should be about is different. This file should be an extremely basic but detailed version of your mods changelog being updated with every update of your mod.\n\nExample of a Changelog that you can utilize as a base\n```\n# Changelog [Replace this with your mods Changelog]\n\n## Initial Release - 1.0.0\n\n* Upload the Example.\n\n## Guideline.MD - 1.1.0\n\n* Added a Detailed Guideline for uploading a thunderstore mod.\n\n## Crosslink Update - 1.1.1\n\n* Updated the Guideline.md\n* Updated the README.md\n* Crossed it to Inscryption as well.\n```\n\nChange this to match either your mods pre existing changelog plus the current version or just change it to state only the Initial Release. We also should stress that this can be written in whatever format you would like, just make sure it works as a proper Changelog for your mod.\n\n### The `manifest.json` File;\n\nThis is probably the trickiest file of all of these. First off open [Easy To Use Manifest Maker TS](https://www.tinyurl.com/EasyuseManifestMakerTS) in a new tab. Upon opening this file you should see something like this:\n\n![image](https://github.com/user-attachments/assets/ff5fb2db-46dd-4b22-98d4-8095338b5ce4)\n\nBasically look at this website in the following sense:\n* The field inputs are the boxes below the Names for example here `name`.\n* The `*` next to an item means that it is required to be present but doesnt mean it must be filled.\n* The Description below the box gives you a breif description on how you should fill out the property.\n* The `+ Item` means that it will add an item into the array in the format of a new blank box.\n* Whenever you see a Box it means you can input in it, in this case there all strings except for the `version_number` which is formatted as an integer with a `.` seperator\n\nThe `name` should be formatted as follows: `Word_Word` the `_` is always replaced with a space in the name which means you must use `_`'s instead of the usual space.\n\nThe `version_number`should be formatted as follows: `1.0.0` it is read as Major, Minor, Patch\n* A Major means its a major breaking update\n* A Minor means it adds or removes some slight stuff\n* A Patch means its basically a bugfix version or corrections to `README.md`, `CHANGELOG.md` or other files in the zip basically nothing added bhut fixed.\n\nThe `website_url` can be left empty if not needed but essentially it acts as a link to your mods page or somewhere important to the mod like a discord. Most of the time if its an open source you would put the link to the mod's discord here.\n\nThe `description` this should be a rough two sentance description be breif about what the mod is about and make sure to point out what your mod does but not in detail.\n\nThe `dependencies` this is essentially an array of mods required for your mod, to set this up press the `+ Item` button for as many dependencies as you need. A dependency is written as follows `(Team Name)-(Mod Name)-(Version)` again spaces are replaced with underscores here. Example of a formatted dependency for reference `CORE_API_TEAM-Configuration_Manager-18.3.2`. You can also find these on the mods webpage under `Dependency string` or you can get a list of them via Thunderstore or R2Modman by doing the following press `Settings` than hit `Modpacks` and finally hit `Show dependency strings` this will output a list of every dependency string found in your current profile.\n\n## How to put your own content into this template:\n\nSo you may be wondering why you have done the above and your content is not there yet, that is because it should be a thing you do prior or during your mods development. But to put your content into this template do the following:\n\n1. Navigate to the folder containg your plugins content\n2. Copy everything that is related to your plugin. [CTRL+A] or [COMMAND+A] Followed by [CTRL+C] or [COMMAND+C].\n3. Navigate to the plugin template that we have setup.\n4. Enter the folder named `plugins` and put that content here. [CTRL+V] or [COMMAND+V]\n5. Once this is done if you have anything else related to the following;\n* Configs\n* Patchers\n* Monomod's\n6. Repeat steps 1-3, afterward navigate into `BepInEx`.\n7. If it is a patcher place them in the folder labled as `patchers`.\n8. If it is a config place them in the folder labled as `config`.\n9. If it is a MonoMod place them in the folder labled as `monomod`.\n\nNote if you have multiple plugins under the same zip place a new folder into `BepInEx/plugins` labled as what it does than copy that plugins content into that, repeat that for every plugin that your plugin contains. Although the preferred method of this would be subfolders within your main plugins folder which would essentially be steps 1-4 of the above guide just instead you put the subfolders needed here along with your plugin itself.\n\n## How to override other mods content using this template:\n\nThe only thing you can hard override via a package is the below, if you want something else you'll have to chat with the mod author.\n\n### Other Configs:\nTo modify a config in your plugin do the following: \n\n1. Navigate to `BepInEx/config` in the template.\n2. Copy the config you are trying to modify from `BepInEx/config` in your profile or setup.\n3. Paste the config you are trying to modify into `BepInEx/config` of the template.\n4. Modify the config to your liking.\n5. Once this is done you should be all set.\n\n## How to upload your mod to Thunderstore:\nTo upload a mod to Thunderstore just do the following:\n\n1. Zip the plugin [CTRL+A], or [COMMAND+A] in the folder with your `README.md`, `maifest.json` and everything else, right click on a file that was selected, Than press `Compress to a Zip File`, if this does not show up try installing [WinRar](https://www.win-rar.com/start.html?&L=0).\n2. Once you have made the zip file navigate to your communities thunderstore page, for example this is TCG Card Shop Simulators; [Thunderstore](https://thunderstore.io/c/tcg-card-shop-simulator/).\n3. Now Login/Signup via Discord/Github/Overwolf whichever works for you NOTE: there is no signup with Email option.\n4. If you have not made a team yet make one this can be done via `Settings` -> `Teams` -> `Create Team`.\n5. Now press `Upload` you should see something like this:\n![image](https://github.com/user-attachments/assets/776df8ce-98b7-4a18-9a94-5516da0bb771)\n6. Under `Choose or drag file here` select the button than select the zip we have made, than hit done this should start the upload process for your mod.\n7. Where it states `Team` this is where you would select the team you created in Step 4.\n8. Set `Communities` to the Game(s) your uploading the mod for, in this case it would be `TCG Card Shop Simulator`, yours most likely isnt so make sure it is correct.\n9. Select the `Categories` that apply to your mod, there is a section of these for each community the package is apart of.\n10. If your mod contains NSFW content you must toggle it on, its required by thunderstore's TOS.\n11. Finally hit submit, once its done you should see a card of your mod popup, if this fails than send a message in the `Thunderstore` channel of your local modding community if there is one otherwise head to thunderstores official discord.\n\n## How to update your mod:\n\nHere is basically all that you need to do in order to update your mod:\n* Open the `manifest.json` and change the `version_number` by whatever value based on what we have discussed earlier about the `version_number`. In Short `1.0.0` -> `1.1.0` if its a minor change, `1.0.0` -> `1.0.1` if its a bug fix patch, `1.0.0` -> `2.0.0` if its a major breaking change.\n* Update your `CHANGELOG.md` to include the new version and its changes in detail.\n* If anything new was added or anything Major was changed it is reccomended to update your `README.md`.\n* Upload the new zip to Thunderstore its categories will stay the same if you leave it blank, Make sure to select the same team as the prior version of the mod as well as the same game.","1496","CORE_API_TEAM/Example_Mod Wiki","1496-core_api_teamexample_mod-wiki","2024-11-17T20:43:19.911913Z","2025-01-09T02:02:20.671577Z","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 CORE_API_TEAM-Example_Mod","CORE_API_TEAM-Example_Mod Wiki | Thunderstore",[65],{"_37":38,"_35":39,"_40":41,"_42":43,"_44":45},"community",{"_31":130,"_105":20,"_152":153,"_32":154,"_155":156,"_157":158,"_42":159,"_160":161,"_162":163,"_113":-5,"_164":165,"_166":167,"_168":169},"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":132,"_136":137,"_138":139,"_71":140,"_141":-5,"_142":143,"_144":145},"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://ccdn.thunderstore.io/live/repository/icons/CORE_API_TEAM-Example_Mod-1.1.1.png","og:description","This is an example mod replace the definitions of this json with the ones your mod needs or requires.","og:title","Example Mod by CORE_API_TEAM","og:url","https://thunderstore.io/c/inscryption/p/CORE_API_TEAM/Example_Mod/wiki/2771-how-to-utilize-this-package","og:type","website","Example Mod by CORE_API_TEAM | Inscryption | Thunderstore","identifier",48466,"donation_link","https://ko-fi.com/thincreator3483","categories",[148],"download_count",3511,"icon_url","is_deprecated",false,"is_nsfw","is_pinned","namespace","rating_count",2,"size",131340,"latest_version_number","1.1.1","install_url","ror2mm://v1/install/thunderstore.io/CORE_API_TEAM/Example_Mod/1.1.1/","download_url","https://thunderstore.io/package/download/CORE_API_TEAM/Example_Mod/1.1.1/","community_name","Inscryption","dependant_count",0,"dependencies",[],"dependency_count","full_version_name","CORE_API_TEAM-Example_Mod-1.1.1","has_changelog",true,{"_31":22,"_146":147},"website_url","package_created","2024-10-20T15:56:47.944264Z","version_created","2024-11-17T20:00:47.657590Z","members",[],{"_31":149,"_40":150,"_37":151},"Misc","misc","127","short_description","Inscryption is an inky black card-based odyssey that blends the deckbuilding roguelike, escape-room style puzzles, and psychological horror into a blood-laced smoothie. Darker still are the secrets inscrybed upon the cards...","Thunderstore is a mod database and API for downloading mods","wiki_url","https://inscryptionmodding.github.io/InscryptionAPI/wiki/","discord_url","https://discord.gg/8EZFmm5xB6","2021-11-02T08:38:38.321438Z","hero_image_url","https://ccdn.thunderstore.io/assets/inscryption/inscryption-bg-1920x620.webp","cover_image_url","https://ccdn.thunderstore.io/assets/inscryption/inscryption-cover-360x480.webp","community_icon_url","https://ccdn.thunderstore.io/assets/inscryption/inscryption-icon-192x192.webp","total_download_count",5401159,"total_package_count",725,{"_31":130,"_105":20,"_152":153,"_32":154,"_155":156,"_157":158,"_42":159,"_160":161,"_162":163,"_113":-5,"_164":165,"_166":167,"_168":169},"alerts",[],{"_27":174},[175,176,177,178,179,180,181,182,183,184],{"_35":187},{"_31":32,"_33":188},{"_88":102,"_33":103},{"_88":100,"_33":101},{"_88":98,"_33":187},{"_88":96,"_33":186},{"_88":94,"_33":165},{"_88":93,"_33":185},{"_88":91,"_33":185},{"_88":89,"_33":90},"88","Thunderstore is a mod database and API for downloading Inscryption mods","The Inscryption Mod Database","Mods for Inscryption","publicEnvVariables",{"_213":211,"_214":211,"_215":211,"_216":217,"_218":219,"_220":211,"_221":222,"_223":224,"_225":226},"currentUser","config",{"_210":211,"_212":-7},{"_27":195},[196,197,198,199,200,201],{"_35":90},{"_31":32,"_33":209},{"_31":208,"_33":207},{"_31":206,"_33":207},{"_204":205},{"_31":202,"_33":203},"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

How to Utilize this Package