[{"_1":2,"_3":-5,"_4":-5},"loaderData",{"_5":6,"_7":8,"_9":10,"_11":12,"_13":14},"actionData","errors","root",{"_197":198,"_199":-7,"_200":201,"_25":202},"c/Community",{"_66":178,"_179":180,"_25":181},"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","webfishing","namespaceId","TeamLure","packageId","LureRefreshed","seo",{"_27":28},"descriptors",[29,30],{"_35":36},{"_31":32,"_33":34},"name","description","content","Wiki page for TeamLure-LureRefreshed","title","Documentation - TeamLure-LureRefreshed | Thunderstore","id","2882","Documentation","slug","2882-documentation","datetime_created","2025-01-03T18:53:45.161417Z","datetime_updated","2025-01-03T18:53:45.161435Z","markdown_content","## Loading assets with Lure\nLure allows you to load asset paths with 3 different prefixes:\n- ``mod://`` searches for assets starting from the folder of the mod_id you gave to the function.\n- ``res://`` searches for assets the classic way, in case you wanna search for base game assets.\n- ``mods/://`` searches for assets inside a specific mod's folder\n\n if you use ``mods/://`` make sure you add the mod you're searching in as a dependency inside your mod's ``manifest.json`` to make sure its already loaded when searching inside it's files.\n\n**Examples**\n*(we gave the function we're calling ``example_mod`` as the mod_id argument)*\n- ``mod://asset.file``would search for ``asset.file`` inside ``example_mod``'s folder.\n- ``res://Assets/asset.file`` would search for ``asset.file`` inside the base game's Assets folder.\n- ``mods/other_mod://asset.file``would search for ``asset.file`` inside the folder of a mod called ``other_mod``.\n## Initialization Functions
_{^{Make sure you call these functions on the ``_ready()`` function of your ``mod.gd``!}}\n\n### Custom Species\n\n**Lure.assign_species_voice(``your_mod_id``, ``species_id``, ``bark_sound_path``, ``growl_sound_path``, ``whine_sound_path``)**
Allows you to assign bark, growl and whine sounds to a specific species, growl and whine are optional, if any of the two are missing they'll get assigned the bark sound.\n\n**Lure.assign_face_animation(``your_mod_id``, ``species_id``, ``animation_path``)**
Allows you to assign a face offsets animation to a modded species, so you can adjust the eye, mouth and nose positions. You can make and edit offset animations by selecting the ![](https://cdn.discordapp.com/attachments/1297612591656341504/1298879143223492638/image.png?ex=671b2af7&is=6719d977&hm=699e55dfbba034a17cd1a99603bfa7ede9e09724e0020b5fb839ee36b70f04cd&) node inside the ``player_face.tscn`` scene that you can find in the ``res://Scenes/Entities/Player/Face`` folder when opening the decompiled game with the godot editor, then select either the ``cat_face`` or the ``dog_face`` animation in the animation timeline tab, click the ![](https://cdn.discordapp.com/attachments/1297612591656341504/1298877917744467968/image.png?ex=671b29d3&is=6719d853&hm=36fb587d5024508e25ee7379c4866228d78b3cee91932936c788e3aa6b98cd7b&) button and select 'Duplicate', name your new animation and save with \"OK\". After you're done editing the offsets, click ![](https://cdn.discordapp.com/attachments/1297612591656341504/1298877917744467968/image.png?ex=671b29d3&is=6719d853&hm=36fb587d5024508e25ee7379c4866228d78b3cee91932936c788e3aa6b98cd7b&) again and select \"Save As\", this is the file you'll need to load with the function.\n\n### Cosmetics\n\n**Lure.assign_pattern_texture(``your_mod_id``, ``pattern_id``, ``species_id``, ``texture_path``)**
Allows you to assign a texture to a specific pattern for a specific species, this allows you to add base game pattern support to modded species, add vanilla species support for modded species or add other people's modded species support to your modded patterns.\n\n**Lure.assign_cosmetic_mesh(``your_mod_id``, ``cosmetic_id``, ``species_id``, ``mesh_path``)**
Allows you to assign an alternative mesh to a specific cosmetic for a specific species, for example if you make a mask accessory, you'll need to make an alternative version for the dog, so its not clipping through the head, this is optional to make your cosmetics work but its heavily encouraged, this function works for both vanilla and modded species/cosmetics.\n\n### Props\n\n**Lure.register_prop(``id_of_the_mod_that_added_the_prop``,``scene_id``,``tscn_path``)**
Allows you to assign a specific scene to a modded prop, Lure will automatically turn the ``prop_code`` from your modded prop to ``mod_id.prop_code`` so if the prop you're assigning the scene to is not from your mod, make sure you call this function with the id of the mod that adds the prop.\n\n### Items\n\n**Lure.register_action(``your_mod_id``,``action_id``,``node_that_holds_the_function``,``name_of_the_function_we_are_calling``)**
Allows you to register an action for any modded item to use, you'll have to give it the node that holds the function you're calling (for example, if you call this function on your ``main.gd`` file and the function you want to link is in it as well you can just write ``self`` as the third argument) and the name of the function the node has that we're gonna call through the action.\n\nthe way you would call the custom action is by setting the action or release_action variables of your modded item's resource file as ``mod_id.action_id`` like everything else with Lure.\n\n### Maps\n\n**Lure.add_map(``mod_id``,``map_id``,``scene_path``,``optional_map_name``)**
Adds a new map to the game, if the map is not missing it will get added to the map list of the 'create' section of the lobby list, no tutorials on how to make maps as of yet but here's a couple of steps of how to setup your new map without crashing the game in the testing process:\n\n1) Open ``main_map.tscn`` and then duplicate it using ``Scene > Save Scene As..``, name it however you want.\n\n2) Right click the ``main_map`` node of the scene and click ``Attach Script``, then in the ``Inherits`` field write ``\"res://Scenes/Map/main_map.gd\"`` (with the quotes)\n\n3) Rename the ``main_map`` node to whatever you want, this is optional.\n\n4) Delete the ``main_zone`` node, we're gonna make our own.\n\n5) Open ``main_zone.tscn`` and then duplicate it using ``Scene > Save Scene As..``\n\n6) Rename ``lake_zone`` to ``main_zone``\n\n7) Feel free to remove all the nodes inside the new zone you're making, just keep in mind the following are important:\n- ``points`` (Removing it WILL crash the game)\n- ``NPCs`` contains well, the npcs.\n- ``lake_water`` and ``ocean_water`` are important, but keep in mind that ``fish_zones`` contains the areas that actually decide the 'loot pool' of fish you'll get when fishing inside the area!!\n- ``portals`` are basically the teleporters/doors\n- ``bounce_shrooms``contains the jumping mushrooms\n- ``chalk_zones`` contains the areas you can draw on, don't scale these because it will break the position of the chalk when drawing, no idea.\n- ``sonud_ambient_zones`` yup, you read that right, it has a typo. basically the background noise.\n- ``invis_walls`` is where your invisible barriers will set up\n\n8) Go back to your new map's scene, add the new zone you created inside the ``zones`` node, remember, it **must** be called ``main_zone`` else it will crash.\n\n9) Save your map and load it with lure using the ``add_map`` function Lure provides.\n\n10) Enjoy!\n\n*NOTE: Avoid using OBJ files on your custom map, they are SUPER buggy, please use GLB/GLTF instead !!*\n\n### Loading the Items, Props and Cosmetics...\n\n**Lure.add_content(``your_mod_id``,``resource_id``,``item_or_cosmetic_path``,``flags``)**
Loads a new cosmetic/item into the game, the final identifier of the cosmetic/item will be ``your_mod_id.the_resource_id``, this is to avoid mods cosmetics/items overriding other mods' so keep this in mind when using function that require a resource's identifier. Make sure you run this function last if you need to use any of the previously mentioned assign functions!\n\n*for example, if your mod's id is ``awesome`` and you're adding an item that's called ``sauce`` the final id of the item will be ``awesome.sauce``, you only have to do this for modded resources since base game resources use their file name without the ``.tres`` extension.*\n\n``flags`` is an optional array argument that Lure uses to toggle certain functionality on your new content, here's a list of flags and their uses:\n\n*the following 2 flags will add your new cosmetic/tool/prop to your inventory automatically, but with different conditions*\n- ``FREE_UNLOCK`` will make the cosmetic/item/prop remain unlocked forever.\n- ``LOCK_AFTER_SHOP_UPDATE`` will make the cosmetic/item/prop remain unlocked until the modded item shop integration update is out, it will lock them after that update drops and the flag will become obsolete.\n\n*The following flags are not implemented yet, but you can add them if you want your content to be future proof:*\n- ``SHOP_POSSUM`` adds the cosmetic or item to the possum's shop.\n- ``SHOP_FROG`` adds the cosmetic or item to the frog's shop.\n- ``SHOP_BEACH`` adds the cosmetic or item to the shop at the beach.\n\n*The following flags are not implemented yet, don't add them to your add_content arguments since its missing from the latest release.*\n- ``VENDING_MACHINE`` adds the cosmetic or item to the vending machine.\n\nkeep in mind that to access the flags you need to reference them inside Lure's ``FLAGS`` enum, so a real example would look like this:\n``[Lure.LURE_FLAGS.SHOP_POSSUM, Lure.LURE_FLAGS.FREE_UNLOCK]``\n\n## Utility Functions\n\n**Lure.get_other_mod_asset_path(``path``)**
gives you the absolute ``res://`` path of another mod's asset, you're probably not gonna use this but i wanted to add it just in case, make sure the given path uses the ``mods/://`` prefix mentioned above.","1561","TeamLure/LureRefreshed Wiki","1561-teamlurelurerefreshed-wiki","2025-01-03T18:53:45.156243Z","2025-01-03T18:53:45.163413Z","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 TeamLure-LureRefreshed","TeamLure-LureRefreshed Wiki | Thunderstore",[65],{"_37":38,"_35":39,"_40":41,"_42":43,"_44":45},"community",{"_31":130,"_105":20,"_161":-5,"_32":162,"_163":164,"_165":166,"_42":167,"_168":169,"_170":171,"_112":-5,"_172":173,"_174":175,"_176":177},"listing",{"_108":109,"_73":20,"_32":97,"_110":111,"_112":95,"_113":114,"_115":114,"_116":117,"_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":114,"_71":140,"_141":142,"_143":144,"_145":146},"listingStatus","team",{"_105":106,"_31":22,"_107":-5},"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/TeamLure-LureRefreshed-4.3.1.png","og:description","Maintainers' continuation of Lure, an API to make adding content to WEBFISHING easier, faster and compatible.","og:title","LureRefreshed by TeamLure","og:url","https://thunderstore.io/c/webfishing/p/TeamLure/LureRefreshed/wiki/2882-documentation","og:type","website","LureRefreshed by TeamLure | WEBFISHING | Thunderstore","identifier",50926,"donation_link","categories",[157],"download_count",88017,"icon_url","is_deprecated",false,"is_nsfw","is_pinned",true,"namespace","rating_count",13,"size",4552150,"latest_version_number","4.3.1","install_url","ror2mm://v1/install/thunderstore.io/TeamLure/LureRefreshed/4.3.1/","download_url","https://thunderstore.io/package/download/TeamLure/LureRefreshed/4.3.1/","community_name","WEBFISHING","dependant_count",68,"dependencies",[149],"dependency_count",1,"full_version_name","TeamLure-LureRefreshed-4.3.1","has_changelog",{"_31":22,"_147":148},"website_url","https://github.com/LureMaintainers/webfishing-lure","package_created","2025-01-03T18:39:33.356297Z","version_created","2025-01-20T09:59:44.991028Z","members",[],{"_73":20,"_32":150,"_112":151,"_152":117,"_31":153,"_118":154,"_155":156},"Mod loader & runtime script patching for Godot","https://ccdn.thunderstore.io/live/repository/icons/NotNet-GDWeave-2.0.13.png","is_active","GDWeave","NotNet","version_number","2.0.13",{"_31":158,"_40":159,"_37":160},"Libraries","libraries","1061","short_description","Thunderstore is a mod database and API for downloading mods","wiki_url","https://notnite.github.io/webfishing-mod-wiki/","discord_url","https://discord.gg/PMdFCrJnUb","2024-10-30T09:50:06.459052Z","hero_image_url","https://ccdn.thunderstore.io/assets/webfishing/webfishing-bg-1920x620.webp","cover_image_url","https://ccdn.thunderstore.io/assets/webfishing/webfishing-cover-360x480.webp","community_icon_url","https://ccdn.thunderstore.io/assets/webfishing/webfishing-icon-192x192.webp","total_download_count",5776404,"total_package_count",487,{"_31":130,"_105":20,"_161":-5,"_32":162,"_163":164,"_165":166,"_42":167,"_168":169,"_170":171,"_112":-5,"_172":173,"_174":175,"_176":177},"alerts",[],{"_27":182},[183,184,185,186,187,188,189,190,191,192],{"_35":195},{"_31":32,"_33":196},{"_88":102,"_33":103},{"_88":100,"_33":101},{"_88":98,"_33":195},{"_88":96,"_33":194},{"_88":94,"_33":173},{"_88":93,"_33":193},{"_88":91,"_33":193},{"_88":89,"_33":90},"88","Thunderstore is a mod database and API for downloading WEBFISHING mods","The WEBFISHING Mod Database","Mods for WEBFISHING","publicEnvVariables",{"_221":219,"_222":219,"_223":219,"_224":225,"_226":227,"_228":219,"_229":230,"_231":232,"_233":234},"currentUser","config",{"_218":219,"_220":-7},{"_27":203},[204,205,206,207,208,209],{"_35":90},{"_31":32,"_33":217},{"_31":216,"_33":215},{"_31":214,"_33":215},{"_212":213},{"_31":210,"_33":211},"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

Documentation