Stickers: added some code

This commit is contained in:
NotAKidoS 2024-08-25 06:31:47 -05:00
parent 07d6dff0a9
commit 58079d9390
36 changed files with 2092 additions and 1651 deletions

View file

@ -1,6 +1,26 @@
# Stickers
Stickers!
Stickers! Allows you to place small images on any surface- 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 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 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.
- 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.
- 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.
## Attributions
- All icons used are by [Gohsantosadrive](<https://www.flaticon.com/authors/gohsantosadrive>) on Flaticon.
- Decal generation system by [Mr F](<https://assetstore.unity.com/publishers/37453>) on the Unity Asset Store.
## Notice of partial source-code
This mod is built around a modified version of [Decalery](<https://assetstore.unity.com/packages/tools/level-design/decalery-293468>) from the Unity Asset Store. As such, only partial source code is available in this repository.
If you are looking for a similar open-source asset to generate decals at runtime, I recommend [Driven Decals (MIT)](<https://github.com/Anatta336/driven-decals>) as it is what the mod was built around originally.
---