Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ENHANCEMENT] Better mod support for stickers (StickerRegistry) #4003

Open
wants to merge 11 commits into
base: develop
Choose a base branch
from

Conversation

AbnormalPoof
Copy link
Contributor

@AbnormalPoof AbnormalPoof commented Jan 15, 2025

Does this PR close any issues? If so, link them below.

Implements #3969

Briefly describe the issue(s) fixed.

This PR moves sticker sets to its own registry called StickerRegistry, and replaces the old (and quite frankly crude) StickerInfo class with a new class called StickerSet. This should hopefully streamline the process of making custom sticker sets, since mods no longer need to directly replace stickers-set-1 or use JSON patching.

Notes

  • This could be considered a breaking change, since JSON files for sticker sets now reside in data/stickersets (and StickerInfo being removed). But that's up to Eric to decide.
  • I've created a pull request on the funkin.assets repository to update stickers-set-1: Move stickers-set-1 to data/stickersets/ funkin.assets#109
  • StickerSprite now takes a file path instead of sticker set and sticker names to support custom file paths for sticker sets.

@github-actions github-actions bot added haxe Issue/PR modifies game code documentation Issue/PR modifies documentation or README files large A large pull request with more than 100 changes labels Jan 15, 2025
@ChillyBeanBAM
Copy link

Oh, this is nice! Good work!

@EliteMasterEric
Copy link
Member

I like how this standardizes the stickers to match how the rest of the game uses data.

However, this PR has merge conflicts with v0.6 (it utilizes the previously unused sticker pack system). We can resolve those at that point.

@EliteMasterEric EliteMasterEric added status: planned This suggestion/enhancement is planned to be implemented some time in the future. type: enhancement Provides an enhancement or new feature. labels Jan 16, 2025
@EliteMasterEric EliteMasterEric self-assigned this Jan 16, 2025
@EliteMasterEric EliteMasterEric added status: planned This suggestion/enhancement is planned to be implemented some time in the future. and removed status: planned This suggestion/enhancement is planned to be implemented some time in the future. labels Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Issue/PR modifies documentation or README files haxe Issue/PR modifies game code large A large pull request with more than 100 changes status: planned This suggestion/enhancement is planned to be implemented some time in the future. type: enhancement Provides an enhancement or new feature.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants