[Open Assets] Redberries 1a

Hi, you've reached the custom build Redberries (also known as SRB2 Cherry), a mod aiming to add quality of life features cherry-picked from Reveries to the vanilla game while also not modifying the physics or anything else like that.

The main attractions in this mod are the Shield Button and Gamepad Refactor, which are explained in further detail under the Gamplay Features section.

To install on Windows, simply click the download button and extract the zip into your SRB2 folder. Other platform options are pending, but you may always compile it yourself from https://git.do.srb2.org/pastel/SRB2/-/tree/redberries-candied or if you use Debian 12-based OS you can try the pipeline build: https://git.do.srb2.org/pastel/SRB2/-/jobs/74885/artifacts/download

IMPORTANT: Redberries uses a different config to avoid conflicting with vanilla. You can import your old config by opening your SRB2 folder and copying+renaming config.cfg to redberries.cfg

For modders who want to support this build: you may check for MODID == 62 in Lua, however if you are only adding support for the shield button and not using any of this build's other features I highly recommend checking if BT_SHIELD instead as this will also support other builds that include the shield button.

• Shield Button
  • Original code by SMS Alfredo & Zwip Zwap Zapony with fixes and edits by me
  • Works out of the box with 99% of mods, Sugoi custom shields being a notable exception (they will still work but you need to hold Spin+Shield)
  • Unlike the version shipped with 2.2.14, Shield may be used to activate the Whirlwind Shield emergency jump in addition to Jump
  • If you do not want this, assign Shield Ability to the same button as Spin and the game will emulate vanilla's behaviour
• Gamepad Refactor
  • Original code by Lactozilla with fixes and edits by me
  • Allows binding triggers like normal buttons and drastically reduces axis nonsense in general
  • Lets you play using the gamepad while the console or team chat is open
  • Adds a Menu Confirm Button setting under Player 1's Gamepad options which allows you to swap the confirm button between:
    • Standard - Confirm on [South Face Button], cancel on [West & East Face Buttons]
    • Nintendo - Confirm on [East Face Button], cancel on [South & West Face Buttons]
    • Backspace is always on [North Face Button]
  • Every bug (that I know of) which prevented its merge into the vanilla game has been fixed
  • Added support for title screen cheats on dpad
    • ULTIMATE is the Sonic 1 code (Up Down Left Right)
    • Level Select is the Sonic & Knuckles code (Left Left Left Right Right Right Up Up Up)
  • Currently does not come with Lua library, I want this to be well-tested in the wild first
• Small changes to vanilla shields
  • Attraction may target springs and monitors
  • Bubble & Attraction now reset your ability in general instead of doing a weird hack only allowing reuse of the shield
  • Flame Shield is a bit faster

• NameChange lua hook for detecting player name changes
• ShieldButtonSpecial hook backported from Reveries
  • This is essentially like JumpSpecial or SpinSpecial for the shield button
  • ShieldSpecial only trips if you have a shield (same behaviour as vanilla), while ShieldButtonSpecial fires earlier and can entirely prevent ShieldSpecial from activating if it returns true
  • Will automatically not fire if spin and shield are assigned to the same button
• More coming later probably (feel free to request)

• Various performance optimisations courtesy of Hanicef, Lactozilla, and myself
• Several bugfixes to 2.2.15, including some texture-related crashes and netcode shenanigans

Q: Is this netplay compatible with vanilla?
A: Unfortunately, no. Shield button and gamepad refactor are both very netplay-incompatible changes.

Q: Why did my config reset?
A: Redberries uses a different config to avoid conflicting with vanilla. You can import your old config by opening your SRB2 folder and copying+renaming config.cfg to redberries.cfg.

Q: I found a bug (that isn't in vanilla), where do I report it?
A: On the discussion thread is fine. Alternatively, if you have a Codeberg or SRB2 Gitlab account you can open an issue at https://codeberg.org/lavla/cherry or https://git.do.srb2.org/pastel/SRB2 respectively.

Q: How do I install this on Android?
A: Follow the tutorial here.

Q: Can I contribute code?
A: Maybe. Open a pull request at https://codeberg.org/lavla/cherry targeting the redberries branch cherry-candied and I'll look at it, but there is no guarantee I accept anything.