kneesox/NAK_CVR_Mods
1
0
Fork 0
mirror of https://github.com/NotAKidoS/NAK_CVR_Mods.git synced 2025-09-02 14:29:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Stickers: update format.json & README

Browse source
This commit is contained in:
NotAKidoS 2024-08-25 06:55:20 -05:00
parent 58079d9390
commit 53b4efbc10
2 changed files with 13 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Stickers/README.md
View file

@ -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.