Circling Boo Buddies API

[S1eth]

This is an API for creating the boo buddy circles from Super Mario World and Super Mario Maker.

Version history:

Spoiler: show

1.0.0

• Initial release

1.0.1

• fixed incorrect boo hitboxes

1.0.2

• Boo Buddy Circles will now be drawn even when the game is paused.

Download



Features

• Super Mario World and Super Mario Maker-style boo circles.
• Boo graphics from SMW, SMB3 or SMB1
• Spinjump/Link downstab/Yoshi bouncing (optional)
• Can be killed with the kuriboh shoe or starman(single player only) (optional)

How to use:

1. Download and unzip into your level's graphics folder.
2. Load the API into your lunadll.lua file with local booBuddies = API.load("booBuddies");
3. Configure spinjumping and what your boo circles will die to.
4. Create boo circles.

Example:

Code: Select all

local booBuddies = API.load("booBuddies");

local myBooCircles = {};

function onStart()
	booBuddies.diesTo = {shoe = true, starman = true};
	booBuddies.canSpinjump = true;
	
	myBooCircles[1] = booBuddies.create({x = -159760, y = -160432, preset = "SMM"});
	myBooCircles[2] = booBuddies.create({x = -159472, y = -160304});
		
	myBooCircles[3] = booBuddies.create({x = -158992, y = -160432, preset = "SMM", style = "SMB1", layer = "Boo Layer"});
	myBooCircles[4] = booBuddies.create({x = -158704, y = -160304, style = "SMB1", layer = "Boo Layer"});
	
	myBooCircles[5] = booBuddies.create({x = -157904, y = -160176, preset = "SMM", style = "SMB3"});
	
	myBooCircles[6] = booBuddies.create({x = -157136, y = -160304});
	
end

Functions:

booBuddies.create (returns a BooCircle object)

mandatory arguments:
x and y coordinates

optional arguments:
preset: "SMM" or "SMW"(Default) provides default arguments for boo circle creation.
style: "SMW", "SMB3", "SMB1" or "SMM-SMW". Determines the graphic style used for the boos.
section: Circle will only be drawn when the player is in the section. If no section is provided, it tries to find the section based on the coordinates.
layer: Name of the layer. If the layer is hidden, the circle is hidden as well.
circleRadius: radius of the boo buddy circle
angularSpeed: speed at which it rotates
angularDirection: "clockwise"/"CW" or "counterclockwise"/"CCW". Determines the direction in which the circle spins.
numberOfBoos: by default 10 boos in the SMW preset, 8 boos in the SMM preset
booRadius: size of an individual boo
booFrameTime: ticks spent per animation frame
booSpacing: distance between individual boos in degrees.
angle: starting angle of the circle

BooCircle functions:

BooCircle:kill()
BooCircle:delete()

Notes;

If you want to use killable SMB1-style boos, copy the effect-94.png file into your graphics folder. This replaces the SMB3 boo death animation.

[snoruntpyro]

Woah, this is super neat! This'll be amazing for ghost house levels.

[Kevsoft]

You might want to add this to the PGE Wiki.

[Willhart]

This looks great. I like how customizable it is.

[S1eth]

Added this to the PGE wiki: http://wohlsoft.ru/pgewiki/BooBuddies.lua

Also applied some bugfixes. (mainly hitboxes)
If anyone downloaded this, please update to the latest version.

[PROX]

well this is very useful to me Expect to see this in my episode

[Alagirez]

Oh yes finally i can make a circling boo gimmick with this. I will use this later.

[S1eth]

Version 1.0.2 patch notes:

Boo Buddy Circles will now be drawn even when the game is paused.

[PixelPest]

I just came to the realization, could something similar to this be used for rotating coin circles?

[Quantix]

I just came to the realization, could something similar to this be used for rotating coin circles?

Now that you mention it, that's a great idea!

[PixelPest]

I just came to the realization, could something similar to this be used for rotating coin circles?

Now that you mention it, that's a great idea!

Thanks! Rotating platforms would be super cool too

[Sambo]

Version 1.0.2 patch notes:

Boo Buddy Circles will now be drawn even when the game is paused.

How did you do that?

[Kevsoft]

Version 1.0.2 patch notes:

Boo Buddy Circles will now be drawn even when the game is paused.

How did you do that?

Putting rendering-code into the onDraw event, which is called even if you have your game paused.

[Westretroman]

I can't get this working, I dunno how to even get the boo circles to spawn.

[PixelPest]

I can't get this working, I dunno how to even get the boo circles to spawn.

Read the example and documentation

[Westretroman]

I can't get this working, I dunno how to even get the boo circles to spawn.

Read the example and documentation

Already did that, got confused and stuck.

[PixelPest]

I can't get this working, I dunno how to even get the boo circles to spawn.

Read the example and documentation

Already did that, got confused and stuck.

It says in the documentation and shows exactly how to do so as well in the example. It's the booBuddies.create() function

[Westretroman]

Read the example and documentation

Already did that, got confused and stuck.

It says in the documentation and shows exactly how to do so as well in the example. It's the booBuddies.create() function

How the heck do I use the create to spawn it in SMBX? do I need to use a separate lua file?

[PixelPest]

Already did that, got confused and stuck.

It says in the documentation and shows exactly how to do so as well in the example. It's the booBuddies.create() function

How the heck do I use the create to spawn it in SMBX? do I need to use a separate lua file?

Read. The. Documentation. I just told you to use the booBuddies.create() function. Look at the arguments in the documentation. Look at the example

[Westretroman]

It says in the documentation and shows exactly how to do so as well in the example. It's the booBuddies.create() function

How the heck do I use the create to spawn it in SMBX? do I need to use a separate lua file?

Read. The. Documentation. I just told you to use the booBuddies.create() function. Look at the arguments in the documentation. Look at the example

Just read it, and I still don't understand. Is there any EASY way to explain this.