Stickers: added note about shader filter to README

This commit is contained in:
NotAKidoS 2024-08-25 22:37:51 -05:00
parent c423401d60
commit b5eabe6d63

View file

@ -6,7 +6,6 @@ Stickers! Allows you to place small images on any surface. Requires both users t
Any image placed in the `UserData/Stickers/` folder will be available to choose from within the BTKUI tab. Once youve 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.
### Limitations
- Only 512 max images per folder (otherwise Cohtml gets very upset).
- 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.
@ -15,6 +14,9 @@ Any image placed in the `UserData/Stickers/` folder will be available to choose
- 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.
- 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.
- Only 512 max images per folder (otherwise Cohtml gets very upset).
- Requires the experimental Shader Safety Settings to be disabled as it will cause crashes when decals attempt to generate on GPU.
- The mod will automatically disable this setting when it is enabled on startup.
## Attributions
- All icons used are by [Gohsantosadrive](<https://www.flaticon.com/authors/gohsantosadrive>) on Flaticon.