Skip to content

Portal effect

Pedro270707 edited this page Jul 16, 2026 · 2 revisions

A portal effect is a client-side effect related to portals. The portal effects file is placed in the directory assets/<namespace>/portal_effect/<path>.json, where <namespace>:<path> is the portal identifier.

Technical information

Class dev.kyanitemods.kyaniteportals.client.content.effects.PortalEffectOptions with a type dev.kyanitemods.kyaniteportals.client.content.effects.PortalEffectType. Use the method dev.kyanitemods.kyaniteportals.client.content.effects.PortalEffects#register(net.minecraft.resources.Identifier, P) to register a portal effect.

JSON format of the portal effects file

  • image: The root object.
    • image values: A list of portal effects.
      • image: A portal effect (see JSON format below).

JSON format

  • image: The root object.
    • image type: The effect type ID (see below).
    • Additional fields of the action, described below.

Effect types

kyanite_portals:nausea

Creates a nausea effect on the screen.

kyanite_portals:close_screens

Closes open screens, such as the inventory or the chat.

kyanite_portals:texture_overlay

Shows an overlay while in the portal.

Additional fields:

  • image atlas: The sprite atlas ID.
  • image texture: The texture ID, starting in the textures directory.
  • image tint: A color in integer format ranging from 0 (black) to 16777215 (white).

kyanite_portals:loading_background/nether_like

Shows an overlay after traveling through the portal.

Additional fields:

  • image atlas: The sprite atlas ID.
  • image texture: The texture ID, starting in the textures directory.
  • image tint: A color in integer format ranging from 0 (black) to 16777215 (white).

Clone this wiki locally