diff --git a/Stickers/README.md b/Stickers/README.md index 5db284d..9eab558 100644 --- a/Stickers/README.md +++ b/Stickers/README.md @@ -1,6 +1,6 @@ # Stickers -Stickers! Allows you to place small images on any surface- synced over Mod Network. +Stickers! Allows you to place small images on any surface. Requires both users to have the mod installed. Synced over Mod Network. ### How to use Any image placed in the `UserData/Stickers/` folder will be available to choose from within the BTKUI tab. Once you’ve selected an image, enter Sticker Mode or use the Desktop Binding to start placing the sticker. Remote clients running the mod will automatically request the image data if they do not have it stored locally. @@ -8,6 +8,8 @@ Any image placed in the `UserData/Stickers/` folder will be available to choose ### Limitations - Only PNG, JPG, & JPEG images are supported. - While it would be cool to send gifs, I don't want to abuse Mod Network that much lol. +- Target surface must have a renderer on the same GameObject as the collider. + - Terrain is not supported. - Image should be under 256KB in size. - Image dimensions should be a power of 2 (e.g. 512x512, 1024x1024). - If the image exceeds the size limit or is not a power of 2 the mod will automatically resize it. diff --git a/Stickers/format.json b/Stickers/format.json index 541cd73..fc4871f 100644 --- a/Stickers/format.json +++ b/Stickers/format.json @@ -1,23 +1,23 @@ { - "_id": 220, - "name": "PropLoadingHexagon", + "_id": -1, + "name": "Stickers", "modversion": "1.0.0", "gameversion": "2024r175", "loaderversion": "0.6.1", "modtype": "Mod", - "author": "Exterrata & NotAKidoS", - "description": "Adds a hexagon indicator to downloading props. Indicator is styled to look similar to Portals.\n\nCan use Delete Mode on loading hexagons to cancel stuck downloads. Setting is provided to display the hexagon for Blocked/Filtered props.", + "author": "NotAKidoS", + "description": "Stickers! Allows you to place small images on any surface. Requires both users to have the mod installed. Synced over Mod Network.\n\nLimitations:\n- Image should be under 256KB in size.\n- Image dimensions should be a power of 2 (e.g. 512x512, 1024x1024).\n - If the image exceeds the size limit or is not a power of 2 the mod will automatically resize it.\n - The automatic resizing may result in loss of quality (or may just fail), so it is recommended to resize the image yourself before placing it in the `UserData/Stickers/` folder.\n\n-# More information can be found on the [README](https://github.com/NotAKidoS/NAK_CVR_Mods/blob/main/Stickers/README.md).", "searchtags": [ - "prop", - "spawn", - "indicator", - "loading" + "stickers", + "images", + "decals", + "sprites" ], "requirements": [ "None" ], - "downloadlink": "https://github.com/NotAKidoS/NAK_CVR_Mods/releases/download/r34/PropLoadingHexagon.dll", - "sourcelink": "https://github.com/NotAKidoS/NAK_CVR_Mods/tree/main/PropLoadingHexagon/", + "downloadlink": "https://github.com/NotAKidoS/NAK_CVR_Mods/releases/download/r38/Stickers.dll", + "sourcelink": "https://github.com/NotAKidoS/NAK_CVR_Mods/tree/main/Stickers/", "changelog": "- Initial release", "embedcolor": "#f61963" } \ No newline at end of file