- What permissions do you give others to modify and/or maintain your submission?
- Modify: YES - Maintain: YES - I give permission for my entire submission to be modified by others or used in their own work. I give permission for my entire submission to be maintained by others as well.
This is Reveries, a custom build containing a total overhaul of the game.
IMPORTANT: due to config incomptability with vanilla, Reveries will use reveries.cfg instead of config.cfg. You can either copy your old config or set up your controls again. The new Shield button from 2.2.14 is important to this mod, so keep that in mind. I also changed several defaults to ones more suitable for Reveries gameplay, but it's not a huge deal if you'd rather use your old config.
DOWNLOADS:
Windows - https://github.com/hazepastel/srb2/releases/download/f1/reveries_windows_F1.zip
Linux - https://flathub.org/apps/io.github.srb2.rphys
Android (outdated) - https://github.com/hazepastel/srb2/releases/download/rphys_v8/rphys-android.apk
Mac - good luck
About 3D models: Jeck's models work with Reveries, supporting all of the vanilla cast's custom frames excluding the Drop Boost but you need to use the models included with SRB2 versions 2.2.13 or higher, not the ones in the Jeck Jims models addon. As as of 03/12/2024, the vanilla cast models on the message board's Jeck Jims model pack are still outdated so if you install all the models from there they will get overridden. Steam Deck & Linux Flatpak users can ignore this message as the correct models are already installed thanks to the power of extra-data grabbing them directly from the 2.2.14 assets folder.
Jump+Jump: Comet Dash
Launch forwards with a burst of speed. Collide with a wall while holding jump to rebound upwards.
Jump+Spin: Drop Boost
Hold spin to charge an enhanced drop dash that gets stronger the faster you're moving.
Shield: Super Peelout
Attain supersonic speed, but jumping or rolling will end it.
Tips:
1) Bop an enemy after the Comet Dash ends to refresh the dash. This also resets the wallbonk counter, so you can take advantage badnik bouncing to scale higher than you could normally.
2) Drop Boost may be used after a Comet Dash, Anti Flying Turtle Roll, and even certain Shield Abilities.
3) Super Peelout state won't be lost in the air as long as you're not jumping or rolling. You can even maintain it across spring launches!
Jump+Jump Fly
Start flying for a limited time. Keep holding the jump button to ascend at the cost of speed.
Passive: Pickup
Carry around allies while flying! Press the shield button to throw your friend forwards.
Tips:
1) Fly has two states: passive flight and active flight. You begin flying in the active state, so simply release the jump button to switch to the passive state.
2) The flight timer only decreases while Tails is in active flight. Pay attention how quickly the tails are rotating: if they're fast, you're in active flight and thus losing flight timer.
3) Active flying doubles the power of air drag and caps your top speed to 2/3 of normal. Since air drag only has an effect while above top speed, you won't slow down further past the 2/3 mark.
Jump+Jump: Glide
Glide in the air as long as jump is held. Collide with a wall to climb along it.
Passive: Bulldoze
Break into a run and mow down everything in your path!
Tips:
1) Jumping off a wall with the jump button to point the camera away from the wall. Press spin instead to jump without changing the camera.
2) Glide & Bulldoze only deal damage from the front of Knuckles.
3) If you glide into the ground, you'll start skidding to a halt. Release jump as soon as possible to exit the skid and keep most of your speed!
Jump+Jump: Lovely Ascent
Use the power of love to jump again in the air somehow. This refreshes everything a normal jump would, including your Hammer Spin! Also, you can bop an enemy to regain the ability.
Jump+Spin: Hammer Spin
Hold spin during a jump to rapidly roate and fall faster over time. Hit the ground for a speed boost.
Shield: Hammer Whack
Press shield on the ground to swing Amy's hammer.
Tips:
1) Strike a spring with any hammer action to increase its power.
2) Hammer actions provide a significantly increased attack range. You can even use your hammer to pick up rings and some other goodies!
3) Using the Anti Flying Turtle Roll will immediately initiate a Hammer Spin.
Jump+Jump: Tail Bounce
Bounce off the ground and most hazards as long as jump is held. This can also destroy some floors.
Spin: Pop Gun
Fire a cork at the nearest target. You won't be able to move while firing.
Passive: Jerboa Time
Gets bonus jump leniency when walking off an edge.
Tips:
1) While bouncing, Fang both ignores air drag and gains a small speed boost each time he lands.
2) Releasing jump during a bounce has the same upwards momentum canceling effect releasing jump during a normal jump does. Use this as an emergency brake if you're ascending too quickly!
3) As a nonspin, springs allow Fang to use any ability off of them. If you quickly tap and release bounce off a spring you can cancel most of your vertical momentum.
Jump+Jump: Jet Burst
An aerial thrust which gets stronger during dash mode. Keep holding the jump button to resist gravity.
Spin: Quick Roll
Perform a speedy somersault. Hit a target for a boost.
Shield: Dash Charge
Stop and gather energy to enter dash mode. Release when fully charged to blast away!
Tips:
1) Dash mode can't be lost while in the air, but can only be obtained while on the ground.
2) If you hit a wall or slow down too much, Jet Burst will cancel.
3) Jet Burst allows you to ignore air drag while active.
Certain maps may have issues due to the higher gravity. I've done my best to mitigate this but it's impossible to fix everything.
The majority of custom characters should work fine.
Lua can check for the global
There is a new hook:
Clairebun: aerial popgun sprites, turning code
Logan McCloud: sprite replacements
Princess Plushima: FlowBubble
SonicX8000: font replacments
SuperPhanto: peelout sprites
Krabs: ring sprite
DirkTheHusky: dropdash sprites
IMPORTANT: due to config incomptability with vanilla, Reveries will use reveries.cfg instead of config.cfg. You can either copy your old config or set up your controls again. The new Shield button from 2.2.14 is important to this mod, so keep that in mind. I also changed several defaults to ones more suitable for Reveries gameplay, but it's not a huge deal if you'd rather use your old config.
DOWNLOADS:
Windows - https://github.com/hazepastel/srb2/releases/download/f1/reveries_windows_F1.zip
Linux - https://flathub.org/apps/io.github.srb2.rphys
Android (outdated) - https://github.com/hazepastel/srb2/releases/download/rphys_v8/rphys-android.apk
Mac - good luck
| Reveries Physics |
|---|
- Momentum past your top speed is preserved while on the ground
- Linear acceleration and friction, similar to the classic sonic titles
- Slope physics are drastically altered
- Higher gravity, higher jump heights
- More maneuverability while jumping or spinning
- Spindash min charge speed is significantly increased
- "Jerboa Time", a short window after walking off an edge where you can still jump
- Only a few frames by default, but each frame of input latency increases its duration
- Reworked airwalk to only happen during Jerboa Time
- Save files from unloaded addons now tell you who the file belongs to
- Springs are more powerful and commit you to their launch direction
- Air drag: while above top speed in the air, your speed will slowly degrade until you drop down to top speed.
- Spinning as well as certain character abilities will completely bypass air drag
- Quick Spindash! Press spin during a skid to instantly spindash without needing to completely stop.
- Characters may roll upon landing even after using an ability (when appropriate)
- Spring tricks!
- Spin characters may use the Anti Flying Turtle Roll by pressing Spin while springing upwards - this is a defensive manuever which cuts your spring launch short and enters a roll state. There are many applications for this move, but it's up to you to discover them.
- Nonspin characters may use their normal abilities off springs. Watch out for the star effect when launching off a spring - if you see it, your character qualifies.
- Many minor changes not worth listing individually
| Reveries Shields |
|---|
- Force Shield
- Replaced the Force Stop with Force Stasis. Hold down the Shield button to stall in midair, and release to restore your previous speed in the direction the camera is facing. You can also press Jump to redirect your speed downwards.
- Enhanced passive: Taking damage with a fully reinforced Force Shield won't stun you.
- Elemental Shield:
- Replaced the Elemental Stomp with Elemental Rise: Cancel all momentum and rocket directly upwards, detonating in a burst of flame (or bubbles) at the end. Press the Shield button again to detonate early!
- Enhanced passive: Fire trail also generates when running in addition to rolling.
- Whirlwind Shield:
- There is now a particle effect when using the ability. This shield was pretty good as is, and its activation conditions makes more sense thanks to the new Shield button.
- Attraction Shield:
- Homing attack is faster and may target springs and monitors. Successfully striking an enemy will refresh all of your abilities, not just the homing attack.
- Ash Shield:
- Replaces the Pity Shield. Granted to all shieldless players when popping an Armageddon Monitor, which now devastates a huge area with an instant catastophic explosion. Note that it is still possible to obtain the Armageddon Shield under certain circumstances, in which case manually detonating it will degrade it into an Ash Shield.
- Thorn Shield:
- Returning from the pure lua version of Reveries, this is a new shield that can be acquired exclusively from Pity Monitors. Other sources of Pity will give you the Ash Shield instead.
- Active: Thorn Switch - Reverses your vertical momentum, firing thorns in the direction of your previous momentum. The thorns explode into clouds of AoE poison upon contact with any surface or entity.
- Passive: Spike Immunity
- Flame Shield:
- Thrusts much faster, roughly equivalent to the Thok at minimum speed. Use it while moving fast to go even faster! This ability is kind of ridiculous, but offers little benefit outside of raw speed.
- Bubble Shield:
- Abilities may be used after bouncing.
- Nonspin characters will use roll state, making it more consistent with the other S3K shields.
- Thunder Shield:
- No changes?
| Reveries Characters |
|---|
Sonic
Jump+Jump: Comet Dash
Launch forwards with a burst of speed. Collide with a wall while holding jump to rebound upwards.
Jump+Spin: Drop Boost
Hold spin to charge an enhanced drop dash that gets stronger the faster you're moving.
Shield: Super Peelout
Attain supersonic speed, but jumping or rolling will end it.
Tips:
1) Bop an enemy after the Comet Dash ends to refresh the dash. This also resets the wallbonk counter, so you can take advantage badnik bouncing to scale higher than you could normally.
2) Drop Boost may be used after a Comet Dash, Anti Flying Turtle Roll, and even certain Shield Abilities.
3) Super Peelout state won't be lost in the air as long as you're not jumping or rolling. You can even maintain it across spring launches!
Tails
Jump+Jump Fly
Start flying for a limited time. Keep holding the jump button to ascend at the cost of speed.
Passive: Pickup
Carry around allies while flying! Press the shield button to throw your friend forwards.
Tips:
1) Fly has two states: passive flight and active flight. You begin flying in the active state, so simply release the jump button to switch to the passive state.
2) The flight timer only decreases while Tails is in active flight. Pay attention how quickly the tails are rotating: if they're fast, you're in active flight and thus losing flight timer.
3) Active flying doubles the power of air drag and caps your top speed to 2/3 of normal. Since air drag only has an effect while above top speed, you won't slow down further past the 2/3 mark.
Knuckles
Jump+Jump: Glide
Glide in the air as long as jump is held. Collide with a wall to climb along it.
Passive: Bulldoze
Break into a run and mow down everything in your path!
Tips:
1) Jumping off a wall with the jump button to point the camera away from the wall. Press spin instead to jump without changing the camera.
2) Glide & Bulldoze only deal damage from the front of Knuckles.
3) If you glide into the ground, you'll start skidding to a halt. Release jump as soon as possible to exit the skid and keep most of your speed!
Amy
Jump+Jump: Lovely Ascent
Use the power of love to jump again in the air somehow. This refreshes everything a normal jump would, including your Hammer Spin! Also, you can bop an enemy to regain the ability.
Jump+Spin: Hammer Spin
Hold spin during a jump to rapidly roate and fall faster over time. Hit the ground for a speed boost.
Shield: Hammer Whack
Press shield on the ground to swing Amy's hammer.
Tips:
1) Strike a spring with any hammer action to increase its power.
2) Hammer actions provide a significantly increased attack range. You can even use your hammer to pick up rings and some other goodies!
3) Using the Anti Flying Turtle Roll will immediately initiate a Hammer Spin.
Fang
Jump+Jump: Tail Bounce
Bounce off the ground and most hazards as long as jump is held. This can also destroy some floors.
Spin: Pop Gun
Fire a cork at the nearest target. You won't be able to move while firing.
Passive: Jerboa Time
Gets bonus jump leniency when walking off an edge.
Tips:
1) While bouncing, Fang both ignores air drag and gains a small speed boost each time he lands.
2) Releasing jump during a bounce has the same upwards momentum canceling effect releasing jump during a normal jump does. Use this as an emergency brake if you're ascending too quickly!
3) As a nonspin, springs allow Fang to use any ability off of them. If you quickly tap and release bounce off a spring you can cancel most of your vertical momentum.
Metal Sonic
Jump+Jump: Jet Burst
An aerial thrust which gets stronger during dash mode. Keep holding the jump button to resist gravity.
Spin: Quick Roll
Perform a speedy somersault. Hit a target for a boost.
Shield: Dash Charge
Stop and gather energy to enter dash mode. Release when fully charged to blast away!
Tips:
1) Dash mode can't be lost while in the air, but can only be obtained while on the ground.
2) If you hit a wall or slow down too much, Jet Burst will cancel.
3) Jet Burst allows you to ignore air drag while active.
| Extra Notes |
|---|
Source code: https://github.com/hazepastel/srb2Certain maps may have issues due to the higher gravity. I've done my best to mitigate this but it's impossible to fix everything.
The majority of custom characters should work fine.
Lua can check for the global
rphys to detect this mod's presence.There is a new hook:
PeeloutSpecial, which catches any shield button input even if you don't have a shield.
| Credits |
|---|
Clairebun: aerial popgun sprites, turning code
Logan McCloud: sprite replacements
Princess Plushima: FlowBubble
SonicX8000: font replacments
SuperPhanto: peelout sprites
Krabs: ring sprite
DirkTheHusky: dropdash sprites
