Kirby v1.1

Celebrating the 28th anniversary of Kirby's Dreamland, Kirby returns to SRB2 with new sprites and revamped gameplay!


Below is an explanation of Kirby's gameplay, though if you don't feel like reading this description, there's also an in game tutorial that replaces the default when you add Kirby!

Basic abilities
Kirby isn't the fastest around, but his versatility more than makes up for it!
By pressing jump mid-air, he can float around. Unlike Tails, simply holding the button will allow him to ascend, though Kirby's flight doesn't last as long. This can even be done from falling or springing!
Kirby's trademark inhale is used by pressing spin. Objects like badniks, monitors, and even some environmental objects like gargoyles can be sucked up. Kirby can spit any inhaled object as a projectile.
Kirby can also duck by pressing custom 2. While ducking, he can slide by pressing jump.

Copy abilities
Kirby, of course, also comes with his iconic copy ability! When Kirby inhales something, pressing custom 2 will allow him to swallow it and copy its ability, replacing his inhale!
There's 14 abilities in total, with a wide variety of uses ranging from speed, platforming, or combat. Copy abilities can also be discarded by pressing toss flag.

Spoiler: List of copy abilities

• Fireball
  Shoot off in a fiery blaze, bouncing off of enemies!
• Ice
  Freeze enemies with icy breath and kick them as projectiles!
• Stone
  Fall to the ground with a forceful thud, clearing enemies around you as an invulnerable stone!
• Bomb
  Explode anything that blocks your path!
• Spark
  An electrical hazard nobody would dare to get close to!
• Needle
  So prickly you can stick to walls and ceilings!
• Tornado
  Twirl around, gaining height and keeping pace! You can even chain it into floating!
• Wheel
  Roll around at the speed of sound, breaking bustable walls in your path!
• Ball
  Bounce around to gain height as you hold jump!
• Sword
  Slice straight through anything in your path!
• Hammer
  Crush your enemies! And bustable walls! And floors! And spikes!
• Mike
  Sing to your hearts content! Just, maybe not to others' content...
• Sleep
  Nothing better than a good night's sleep! Though, you do get left a bit vulnerable...
• UFO
  Fly around higher than floating can go, with a laser projectile!
• ???
  A secret ability acquired by collecting all 7 chaos emeralds, 50 rings, jumping, and pressing spin while holding toss flag...
• ???
  There may be other copy abilities hidden somewhere... Maybe try copying some other characters on the message board?

Kirby also has SRB2 Battle support! Pay 30 rings to spin the ability roulette and get a chance at a powerful copy ability!

Credits
Tripel: Programming
Maximus, KíbitoÁyame, HattyBoyo, Bendy: Sprites
Hydro, Yacker, Vinnis: Beta testing

Spoiler: Add-on support

To make skins or objects copyable by adding them to Kirby's ability table, use the following script:

if not(kirbyabilitytable)
	rawset(_G, "kirbyabilitytable", {})
end
kirbyabilitytable[MT_EXAMPLEOBJECT] = 1	// Makes MT_EXAMPLEOBJECT give fireball
kirbyabilitytable["exampleskin"] = 2	// Makes the skin "exampleskin" give ice

For custom abilities:

Spoiler:

To add a custom Kirby ability, use K_AddAbility(abilityfunction, secret, iconname)
abilityfunction is the function used for the ability. This is called every frame for the actual functionality of the ability, but it has a few other uses as well, which I'll get into later.
secret is wether or not this ability is a secret ability. The only real gameplay purpose of this is so that it has a ((1/256)/number of secret abilities) chance of appearing when the ability roulette appears.
iconname is a 7 character long name for the ability icon and name graphics. The ability icon graphic should be named I + iconname, and the name graphic N + iconname.
This will return a number for you to use in kirbyabilitytable, though keep in mind this function wont return a negative value for secret abilities!

Ability function:
The ability function should have the following arguments:
(checkflags, destroy, late, player)
If checkflags is true, the function is being called to check for ability flags. The function should immedietly return ability flags.
If destroy is true, then the ability is being discarded or otherwise lost. If you spawn an object for Kirby to hold, or mess with his flags, this is where you should restore them! Immedietly return after you're done cleaning up.
If late is true, then the function is being called at the end of Kirby's ThinkFrame hook. Once again, its a good idea to return after you do whatever you need to at this point, so normal and late functionality remain separate.
If none of the above are true, then the ability should run its normal functionality.
player is simply the player_t thats using the ability.

Ability flags:
AF_NOFLOAT		Disable Kirby's ability to float
AF_NODUCK		Disable Kirby's ability to duck
AF_NOJUMP		Disable Kirby's ability to jump
AF_NOSWIM		Disable Kirby's ability to swim
AF_NODROP		Disable dropping the ability with toss flag
AF_NOLOSE		Disable dropping the ability from taking damage or dying
AF_ALLOWSUCK		Allow Kirby to inhale like normal Kirby (this will not allow him to copy abilities)
AF_WALKSWIM		Use walking frames for swimming, even without something inhaled

Custom feet sprites:
If you create custom frames for Kirby, you probably want his feet to change color like normal
To do this, call K_AddCustomFeet(kirbysprite, feetsprite)
kirbysprite is the sprite Kirby is using, and feetsprite is the sprite the feet should use when Kirby uses this sprite.
If you use a sprite2 for your ability instead of a normal sprite, then make Kirby's feet the super version and he'll automatically use them.

Spoiler: Changelog

v1.1

• Custom abilities are now possible, as well as custom feet sprites! Details added to main post.
• Gold monitors are no longer inhalable.
• Kirby will now be awarded the contents of monitors after swallowing them after inhaling them, if it has no ability tied to it.
• Fixed Lua error when inhaling a monitor on a sloped surface that caused any future spawned objects to break, caused by a typo on a single line.
• Kirby can no longer duck in THZ goop.
• Kirby can no longer aim any projectiles vertically.
• Inhaled players (and objects) will no longer fall through the floor when Kirby dies.
• Players being inhaled will no longer fall through the floor when Kirby gets hurt and drops them.
• Stars and spat players now move at a speed of 60 fracunits, down from 80.
• Fixed being able to spit when in pain.
• Fixed HUD breaking when switching renderers during gameplay
• All audio is now compressed, resulting in a much smaller file size. Music in particular has been heavily compressed.
• NES sound effects have been rebalanced, and should hopefully sound better.
• Fireball can now break bustable walls.
• Fireball now recoils when hitting a solid wall.
• Fixed bug with ice not destroying parts of multi-object badniks, along with a potential crash that can be caused by this.
• Fixed being able to use stone in minecarts, ropes, and RVZ stones.
• Kirby is now forced to unstone when using springs.
• Fixed Kirby being unable to jump or inhale after entering a dust devil while using stone.
• Fixed Kirby being immune to death pits with stone.
• Bomb sparks no longer linger after exploding.
• Bomb can now destroy bustable walls.
• Tornado can now ascend by pressing jump or spin, instead of only spin.
• Fixed wheel breaking walls too early.
• Eggman TVs now give sleep instead of nothing.
• Crawla Commanders now give UFO instead of sleep.
• Canarivores now give ice instead of nothing.
• Banpyuras now gives ball instead of tornado.
• Added special interation with Silver

[TeriosSonic]

Originally Posted by palauball

I want to modify the codes, but i don't have SLADE or other ones. If i use notepad or word pad it just displays a bunch of unicodes. Please fix!

1. Why would you even want to? Kirby isn't reusable content.
2. The reason "SLADE or other ones" even exist, is because you can't open .PK3/.Wad files with any normal system app. Only formats Notepad can open are .SOC and .Lua.
3. You're bumping.

[Sonic Robo Blast 2 Newbie]

This is great! Sucks that most server doesn't even use it!

[Ogilvie Maurice]

i'm getting really annoyed how i keep accadentally inhaling egg boxes and getting sleep

[izzy]

Originally Posted by Ogilvie Maurice

i'm getting really annoyed how i keep accadentally inhaling egg boxes and getting sleep

That's... just a you problem.

[Dark Magician Girl]

This must be good!

[MacDK]

This is gonna sound dumb but how do i lose the ability when i have the abilty

[GamerLuna2020]

Originally Posted by MacDK

This is gonna sound dumb but how do i lose the ability when i have the abilty

Simple. Do what Cure Blossom does:

Put yourself under enemy attack.

[LuxisLand]

Originally Posted by GamerLuna2020

Simple. Do what Cure Blossom does:

Put yourself under enemy attack.

Or better, press Toss Flag. (i don't remember if that was the button)

[Daviroll_Limit]

Originally Posted by LuxisLand

Or better, press Toss Flag. (i don't remember if that was the button)

the same Tossflag that also allows you to super transform when you get all the 7 chaos emeralds

[Damianaman]

can you make a modern design version?
just the design would be different

[「AxeCrusader」]

Originally Posted by Damianaman

can you make a modern design version?
just the design would be different

You know that making new sprites is hard right? Especially this addon which has a lot of copy abilities. In fact, this is entirely based of the game Kirby's Adventure on the NES, so making different hats just for a Modern Kirby to wear them is literally asking for a lot of work.

[smashmallow101]

I would love to see a version of this character that has multiple attacks for abilities.


Also, what is up with UFO's controls? you could have just made it so that you press jump to ascend and duck to descend, but it's really weird.

[Flash Trickstar]

Originally Posted by smashmallow101

I would love to see a version of this character that has multiple attacks for abilities.

So a "Super Star" styled version? Yeah that'd be cool.

[smashmallow101]

Originally Posted by Flash Trickstar

So a "Super Star" styled version? Yeah that'd be cool.

Yeah, and some more abilities.
classic ones like wing and beam, modern ones like spider or water, and others. wing would be great for improved flight, beam could provide a mid range attack, spider for increased level altering potential, and water for better underwater control.

[DANNY1]

Does anyone have a list of what enemies give you what copy ability?

[Superjustinbros]

I messed with some ability spawns in private to give some abilities more exposure. Take this more as a "what if" in a way.



Since the Robofish was on the pool of "no Ability" and Sword was only given by the Lance-A-Bot in CEZ, I wondered if it'd be fitting for the Robofish in GHZ1 to give Sword since it attacks with something razor-sharp (its teeth). This would make the ability obtainable a bit earlier on (especially for what is one of the more iconic abilities in the series).



I also toyed with Robohood giving Sword if you're fast enough to catch one since it also attacks with something sharp but it wasn't as fitting and it's made redundant by the Lancebot appearing in the same zone. If Archer had existed it would make more sense but that ability isn't part of the ability pool in the older games so.



Continuing the experiment I manipulated Pterabytes into giving Tornado, an ability only given by two other sources, but I suppose one of those sources being very common and being on almost every level (the Whirlwind Shield monitor) combined with the difficulty of getting Kirby to inhale a Pterabyte is why it doesn't give anything under normal circumstances.

[Maximus Universal]

This was something only shown off on discord (we forgot to share the 1.2 sneak peeks here) that solves the issue of abilities being too rare. They were planned for the initial release, but were scrapped due to the anniversary release timing.

[Daviroll_Limit]

Originally Posted by Maximus Universal

This was something only shown off on discord (we forgot to share the 1.2 sneak peeks here) that solves the issue of abilities being too rare. They were planned for the initial release, but were scrapped due to the anniversary release timing.

looking very cool right there, thank lord this character is still being worked on.
seriously, i love using Kirby a lot

[PHCC]

Amazing character! Just an observation, though: I can't get past Mystic Realm's Sunken Plant Zone boss with Kirby without a copy ability because apparently he can't inhale Dr. Eggman's special goo. Not a priority since it's a custom level pack but I thought I should let you know that.


EDIT: Here are some neat speedruns for you.

[RedsterTheGamer]

Could anybody be able to create and post a list of which enemies give what abilities?
Also 3D models would be great!