[Open Assets] Game Styles 3.300

Changes:

All Styles:

+ Custom HUD Library update
  ~ Parity with MRCE's version of Custom HUD Library
  + All features coming with 4.x
+ Styles API - the hooks (See documentation here: https://github.com/TeamSprings/SRB2-Game-Styles/wiki/Add%E2%80%90on-Support)
  + "TallySetup"
  + "TallyEnd"   
  + "TallySkip" 
  + "MonitorSpawn"
  + "MonitorDeath"
  + "MonitorLoot"
  + "MonitorRemoval"
+ IT in-HUD indicator for tag
+ Multiplayer RS Emerald Display
+ Custom Emblems
  + Classic: Various Options -> See Classic Style Changelog
  + Dimps: Red Star Rings
  + Adventure: Adventure Emblems from Adventure 1/2
  + Tab Scores Icon replaced for each style
+ Ring Particles:
  + Classic: Classic Particles
  + Dimps: Sonic Rush
  + Adventure: Sonic Adventure 2
~ Fix Monitor Map Executors (At least for UDMF, not tested, however follows source code)
~ Light project reorganization in places
~ Better Name Trims
~ SRB2 Version requirement increase 2.2.14 -> 2.2.15 (Making sure everyone is on same page)

Adventure:

+ dc_menu (WIP - will be explored in next update probably but it is usable)
+ dc_playereffects (Experimental)
  + Vanilla
  + SA1
  + SA2
  + Heroes
+ dc_itemboxstyle
  + Adventure
  + Nextgen (06)
+ Exclusive Styles API Hook - "RankSetup"
+ Score Additives instead of Score popup
+ Icon Borders in monitor display
+ SA2 Bubbles
+ Sonic Heroes Key Option (Default, to avoid confusing people)
+ Emeralds in Nights
+ Vanilla HUD Emeralds Replacement (for Credits etc.)
+ Special Stage Intermission

~ Flattened invulnerability (Should be FPS boost)
~ Starposts' do not grant rewards post activation and with reached ring threshold.
~ Starposts' states are checked after retrying level
~ Fix Starposts giving you items after level reset
~ Fix Item boxes not reverting capsule scaling
~ Shield graphics changes (To fix transparency overlaying)
~ Emeralds polish
~ HUD graphic fixes & polish
~ Non-10 Rings, Pity and Invincibility PW icons changed
~ Supposedly Goal Ring mod support again...
~ Balanced values in bubble-flicky movement
~ Randomize spawn angle of bubble-flicky
~ Checkpoint timer to <min>:<sec> format with new HUD position
~ Fix boss health flicker by adding boss target lock for boss health

- Starpost timer no longer shows up if you stand still.

Dimps:

+ Super Music
+ Super After Image option
+ Game Clear jingle (Not actually played in vanilla, as vanilla skips intermission in final level)
+ Special Stage Intermission
+ Water splash
+ Support for custom Sonic Advance 3 rings graphics (STYLES_ADV3RINGS_<skin>)
+ Super Sparkles
~ Spindash dust sprite change
~ Golden monitor palette change
- Remove Brak Eggman from Eggman Voice list
- Ability thok object no longer gets removed by gba_thok (So, only spin and rev thoks get removed)

* Reverted due to inconsistent playback -- From the source, MPTMs of Advance tracks (Still thanks, bitten2up!)

Classic:

+ New Console Variable Handler:
  + Proper menu tags
  + Ease of use
  ~ Refactor options to use this
  ~ Future: Previews perhaps
+ Sonic 3D Blast Genesis Content:
  + Titlecard
  + Intermission Header
  + Intermission Background
  + Score Option (100, 200, ...)
  + Sonic 3D Blast DX Layout
+ Emblem Options
  ~ Vanilla
  + Sonic 1 Emblems
  + Sonic R Emblems
+ Token Options
  ~ Vanilla
  + Sonic 3D Blast Continues
  + Sonic R Coins
  + Sonic Origins Coins
+ New/Changed Emeralds
  + Sonic Blast Emeralds
  + Knuckles Chaotix Chaos Rings
  + Sonic 3D Blast PC Emeralds
  ~ Polished Sonic R Emeralds
  ~ Polished Sonic CD Time Stones
+ Sonic 3D Blast Explosions
+ Sonic Mania Special Stage Intermission Background
+ Sonic Mania Encore Mode Colors for Intermission BG/Title
+ Added missing visual elements into Sonic Mania Intermissions
+ Color Translations for Special Stage Backgrounds
+ Special Big Level pack detector, disables token replacements:
  - SUGOI
  - OLDC

~ Fix missing x character in life HUD element for some fonts
~ Fix Mania Intermission Font's X
~ Polished Sonic 3 Monitors
~ Polished Sonic CD Starpost
~ Polished Sonic Mania Starpost
~ Polished Sonic 1 Starpost
~ Polished Sonic 3 Starpost
~ Starposts' states are checked after leaving special stages
~ Fix Revitem reverting

#Classic style:

+ New emeralds: Sonic R + Sonic 3D Blast
+ Polished assets: Mania Emeralds, Mania monitors, Sonic 3 Emeralds,
+ Stage card option
+ Different safety measure for special stage exits (Iteration 1, not necessarily buggy but more so it doesn't counts deadly FOFs)
+ Better color for Mania intermission font

- Making sure that ALL token options are disabled in multiplayer

#Dimps style:

~ Fix golden monitors by importing Classic Style monitor destruction logic. (Some sprites might look odd, expected)

#Adventure style:

~ Fix rare random ring monitor warning

#Custom HUD library:

List of vanilla HUD items (https://www.wiki.srb2.org/wiki/Lua/Functions#Togglable_HUD_items)

+ customhud_force_enableitem <item name>
forcefully enables HUD item.
+ customhud_force_disableitem <item name>
forcefully disables HUD item.
+ customhud_force_reset
forcefully enables all HUD items (likely will also switch item mod set into vanilla)
+ customhud_setmod <mod name>
sets every item to it's mod's counterpart if it exists
+ customhud_getitemtype <item name>
prints into console active mod type of the item

#All styles:

+ Partial support for Encore mode (At least for monitors)

#Adventure style:

~ Fix "dc_ringboxrandomizer" console command
~ Move around some sprites

#Dimps style:

~ Fix Golden monitors

#Classic style:

+ Polished broken monitor sprites
+ Updated presets
~ Hud fixes
~ Menu fixes
~ Vanilla tally music breaking styles' tally
~ Fix Golden monitors

#All styles:
+ Experimental music script
+ Audio overhaul part 2
~ Turn down all power ups with music in tally state to avoid music overlap and any other issues regarding super
- Limits registration of monitors to those that have vanilla "monitor pop" states to avoid issues like replacing SRB2ThePast monitors

#Dimps style:
~ Fixed issue regarding Advance 3 hud grouping causing to lock everything hud related.
~ Music files converted into mono sound to decrease file size

#Classic style:
+ Mania Title card
+ Early Mania Intermissions
+ ALL Hud fonts now project into lower half of score tally
+ Hud layouts (Currently: Classic and Sonic 3D Blast)
+ More music options
~ Music files converted into mono sound to decrease file size

- Note: some cvar values were moved around to fix consistency. So in case of Classic style, some configs might have to be redone.
+ There are more things added, it is just mentioned were most notable. Now I will take my break finally.

I am taking break after this one, I feel just exhausted... There is still plenty of work to do. Anyway, I am taking pause for about a week (still open to interaction about styles, but preferably please write git issue or into SRB2 MB discussion.)

Changelog:

# All styles:

+ Most of non-jingle tunes now have loop points
+ Most of the jingles now fade away.
~ Music checks and fixes (Super extensive, music file dilemma is on back burner)
~ Fix losing reference to exit sector (this was cause behind inconsistent custom exit behavior)
~ Fix binary custom exits
~ Harsh fix for tally music getting interrupted (Likely to break more things)

# Classic style:

+ Menu adjustments
+ Blue fades option
+ Sonic 1 Monitor
+ Sonic Mania's monitor hopping upon being destroyed option
+ New music tracks
~ Resets additive timer after level ends (It used to exist, but it caused problems before)
~ Fix Golden monitors

# Dimps style:

+ Menu adjustments
+ 2 new monitor types:
- Rush Adventure
- Colors DS
~ Fix Golden monitors

# Adventure style:

+ New Rank graphics
+ Ability to manually predeterminate ranks in level header
- A: Lua.styles_ranks_a
- B: Lua.styles_ranks_b
- C: Lua.styles_ranks_c
- D: Lua.styles_ranks_d
+ Title card expansions
- Special Stage coloring
- Level header mission tags:
They add header to title card subtext
- Lua.styles_mission (mission number)
- Lua.styles_missiontag (mission tag string)
+ Ground player when in tally state
~ Tally adjustments

So, we rebased the custom HUD library to make it again compatible with other mods using it. Namely, Gamma.

The thok item crash should be hopefully fixed as well, and some additional safety measures to S3K special stage exit were added.

# All styles:

~ Possible fix reverting the no-thok option crashing game
~ Custom HUD Library update and rebase
+ Added customhud_setitem as part of rebasing to newer versions (Allows players to set a HUD type of each HUD item, so you can play with some SA1 HUD elements or even vanilla ones.)

[B][U]# Adventure style:[/U][/B]

~ Additional Gamma time checks

[B][U]# Dimps style:[/U][/B]

~ Possible Fix of Sonic Advance 1's HUD when Bot disappears

[B][U]# Classic style:[/U][/B]

+ Some safety measures for special stage exit
~ Slightly more orange S3K checkpoints

It should be now possible to play with this in multiplayer.
(Needs more tests, so please do not think that everything will work just out of the box now)

# All styles:

~ More checks for warps

# Adventure style:

~ Maybe fixing a music intro in multiplayer
~ Attempt \#2 at fixing boosters
~ Fixing custom tally skip exits giving tally score regardless

# Classic style:

~ Fix special stage rings despawning
~ Fix special stage rings muting music upon exiting