GB Studio 4.0 - Plugin Pak

A set of experimental plugins for GB Studio 4.0. Use them at your own risk :)

Dialogue & Menus

Display Advanced Dialogue

Show a dialogue box at the bottom of the game screen.

The Text tab behaves exactly like the Display Dialogue event.

The Layout tab allows to configure multiple options for the dialogue box:

• Minimum and maximum height of the display box, and if the frame should be rendered or not.
• The starting position of the text.
• The maxmimum number of lines before the text will start scrolling up.
• Configure when the dialogue will close:
  • When a button is pressed
  • When the text finishes rendering
  • Never (the dialogue box will remain on screen and allow other interactions. The dialogue can be hidden using the Hide Overlay or Overlay Move To events).
• If the previous content should be removed when displaying the dialogue. This is useful to avoid the text flickering when dialogue boxes are open with Instant speed.
• If the dialogue should render at the bottom or the top of the screen. (Note: Pay attention to the warnings on the event when using top position)

Display Advanced Menu

Display a menu of multiple options and set the specified variable to the value of the chosen option.

Menu option position and navigation order can be set for each item in the Items tab. The dialogue box size and the opening and closing direction can be set in the Layout tab.

There's no maximum character length per item, but the total amount of displayed characters is limited to by the number of tiles reserved for UI text (52 for non-color mode).

Note: The event can get very long when there's a lot of items.

Display Background Text

Renders a line of text at a specified position in the scene background.

There's no maximum character length for the text, but the total amount of displayed characters in a scene is limited to by the number of tiles reserved for UI text (52 for non-color mode), this includes text displayed with this event but also any other dialogue or menu.

Printer

Note: The embedded GB Studio emulator doesn't have support for printing, this event will always fail when tested there. Use a real device or an emulator with printer support.

Print Screen Background

Prints the visible background of the current scene using GB Printer. In Color Mode the CPU will be set to Single-speed mode while the event is running.

• On Error: A script to run if there's an error when trying to print.

Real Time Clock

A set of events that give access to the Real Time Clock functionality present in some GB cartridges.

Note: Cartridge type needs to be set to MBC3 in the project Settings, for RTC to work.

Set Clock Time

Set the values of the real time clock fields with a number or the value of a variable.

Store Clock Time In Variables

Store the current time in one variable for each value.

Start Clock

Starts the real time clock.

Stop Clock

Stops the real time clock.

Music & Sound Effects

Mute Channel

Mutes one or more channels for the currently playing music.

Player Fields

Store Player Field In Variable

Store the value of a Player Field in a variable.

The available fields are:

• Platformer scenes:
  • Player Velocity X: Current horizontal velocity for the player.
  • Player Velocity Y: Current vertical (jumping) velocity for the player.
  • Player is in the ground: 1 if the player is jumping or 0 if it's not.
  • Player is on ladder: 0 if the player is on a ladder or 1 if it's not.

Player Field Update

Change the value of a Player Field.

The available fields are:

• Platformer scenes:
  • Player Velocity X: Current horizontal velocity for the player.
  • Player Velocity Y: Current vertical (jumping) velocity for the player.

Camera

Store Camera Field In Variable

Store the value of a Camera Field in a variable.

The available fields are:

• Camera X: Current horizontal camera position.
• Camera Y: Current vertical camera position.
• Scroll X: Current horizontal scroll position.
• Scroll Y: Current vertical scroll position.
• Camera Deadzone X: Current horizontal edge for the camera window.
• Camera Deadzone Y: Current vertical edge for the camera window.
• Camera Offset X: Current horizontal camera position relative to the edge of the screen.
• Camera Offset Y: Current vertical camera position relative to the edge of the screen.

Camera Field Update

Change the value of a Camera Field.

The available fields are:

• Camera Deadzone X: Current horizontal edge for the camera window.
• Camera Deadzone Y: Current vertical edge for the camera window.
• Camera Offset X: Current horizontal camera position relative to the edge of the screen.
• Camera Offset Y: Current vertical camera position relative to the edge of the screen.

Screen

Smooth Fade

Color Mode Only

Fade some or all of the current scene's background or sprites palettes to or from a white or black screen, interpolating the color values for a smooth fade.

β Plugins

The plugins in this category are even more experimental than the ones above and might change in the future.

• Set Dialogue Frame:
  • Replace the dialogue frame with a tileset. Only 24x24px tilesets are valid.
• Move Variable Actor To and Store Variable Actor Position In Variables:
  • These events duplicate existing GB Studio Actor events but instead of using a dropdown to select the actor they use a variable. The value of the variable represents the index of the actor in the scene (the player is always 0 and the rest of the actors have an index assigned based on when they were added to the scene).
• Actor FX:
  • Run visual effects on an actor. Currently only Split In / Split Out effects are implemented. More to come (maybe?).
• Pin Actor to Screen and Unpin Actor from Screen:
  • Pin or Unpin the actor to its current screen coordinates. Be aware of the current state of the actor: If it's already pinned or unpinned when the event is called its position will be wrongly offset based on the scroll position.

How to Install

Drop the plugins folder in your project. All the above events will be available from the Add Event button.

Looking for more plugins?

• NalaFala (Yousurname)'s GB Studio Plugin Collection
• Platformer+
• Advanced Dialog and Menu vB
• Shin's GB Studio plugins