Skip to content

Example Mana Mod

Gugas749 edited this page Nov 5, 2026 · 1 revision

Complete example: a mana mod

A small mod that uses most of the API: synced data, a packet, a command, an overlay, a continuous effect and a GUI screen.

// ── MyMod.java (NeoForge 1.21.1) ─────────────────────────────────────────────
@Mod("mymod")
public class MyMod {
    public MyMod(IEventBus modBus) {
        MyData.init();        // registers the synced attachment
        MyPackets.init();     // creates the channel

        // Purple vignette whenever mana is empty: driven by our own effect, bound on both sides
        AbyssScreenOverlay.bindEffect(MyEffects.MANA_BURN,
                AbyssOverlaySpec.vignette(0x6A00FF, 0.5f).fade(5, 20));

        NeoForge.EVENT_BUS.addListener((RegisterCommandsEvent e) -> new MyCommands().registerAll(e.getDispatcher()));
        NeoForge.EVENT_BUS.addListener(MyMod::onPlayerTick);
    }

    private static void onPlayerTick(PlayerTickEvent.Post event) {
        if (!(event.getEntity() instanceof ServerPlayer player)) return;

        ManaData m = MyData.MANA.get(player);
        if (m.current() < m.max()) {
            ManaData next = m.withCurrent(m.current() + 1);
            if (player.tickCount % 20 == 0 || next.current() == next.max()) MyData.MANA.set(player, next);
            else MyData.MANA.setSilently(player, next);
        }
    }
}

// ── MyData.java ──────────────────────────────────────────────────────────────
public final class MyData {
    public static final AbyssSyncedAttachment<ManaData> MANA =
            AbyssSyncedAttachment.register("mymod", "mana", ManaData.DEFAULT, ManaData.CODEC);
    public static void init() {}
}

// ── MyPackets.java ───────────────────────────────────────────────────────────
public final class MyPackets {
    public static final AbyssChannel CHANNEL = AbyssNetworking.createChannel("mymod", "1", MyPackets::register);
    public static void init() {}

    private static void register(AbyssPacketRegistrar r) {
        r.c2s("cast", CastPacket.class, CastPacket.CODEC, MyPackets::onCast);
    }

    private static void onCast(CastPacket pkt, AbyssPacketContext ctx) {
        ctx.enqueueWork(() -> {
            if (!(ctx.player() instanceof ServerPlayer player)) return;
            ManaData m = MyData.MANA.get(player);
            if (m.current() < 30) {
                player.addEffect(new MobEffectInstance(MyEffects.MANA_BURN, 60, 0));   // triggers the overlay
                return;
            }
            MyData.MANA.set(player, m.withCurrent(m.current() - 30));
            AbyssScreenOverlay.show(player, Constants.id("mymod", "cast"),
                    AbyssOverlaySpec.tint(0x60D4FF, 0.3f).fade(0, 10), 10);
            // ... do the spell
        });
    }
}

public record CastPacket() {
    public static final CastPacket INSTANCE = new CastPacket();
    public static final AbyssPacketCodec<CastPacket> CODEC = AbyssPacketCodec.unit(INSTANCE);
}

// ── ManaScreen.java (client) ─────────────────────────────────────────────────
public class ManaScreen extends AbyssPanelScreen {
    public ManaScreen() { super(Component.literal("Mana")); }

    @Override protected AbyssPermissionLevel requiredLevel() { return AbyssPermissionLevel.PLAYER; }

    @Override
    protected void addTabs(List<AbyssTab> tabs) {
        tabs.add(new AbyssTab() {
            @Override public Component title() { return Component.literal("Mana"); }

            @Override public void init(TabContext ctx) {
                ctx.add(new AbyssButton(ctx.x, ctx.y + 20, 100, Component.literal("Cast (30)"),
                        b -> MyPackets.CHANNEL.sendToServer(CastPacket.INSTANCE)));
            }

            @Override public void render(GuiGraphics g, TabContext ctx, int mx, int my, float pt) {
                ManaData m = MyData.MANA.getClient();
                AbyssDraw.sectionTitle(g, ctx.font(), Component.literal("MANA " + m.current() + "/" + m.max()), ctx.x, ctx.y);
                int barW = ctx.width, filled = barW * m.current() / Math.max(1, m.max());
                g.fill(ctx.x, ctx.y + 46, ctx.x + barW, ctx.y + 52, AbyssTheme.DIVIDER);
                g.fill(ctx.x, ctx.y + 46, ctx.x + filled, ctx.y + 52, AbyssTheme.ACCENT);
                AbyssDraw.outline(g, ctx.x, ctx.y + 46, barW, 6, AbyssTheme.TITLE);
            }
        });
    }
}

The same mod on Forge 1.20.1. Everything except the mod class is identical. In the mod class:

@Mod("mymod")
public class MyMod {
    public MyMod() {
        MyData.init();
        MyPackets.init();

        // MyEffects.MANA_BURN is a RegistryObject<MobEffect> here: bind by id
        AbyssScreenOverlay.bindEffect(new ResourceLocation("mymod", "mana_burn"),
                AbyssOverlaySpec.vignette(0x6A00FF, 0.5f).fade(5, 20));

        MinecraftForge.EVENT_BUS.addListener((RegisterCommandsEvent e) -> new MyCommands().registerAll(e.getDispatcher()));
        MinecraftForge.EVENT_BUS.addListener(MyMod::onPlayerTick);
    }

    private static void onPlayerTick(TickEvent.PlayerTickEvent event) {
        if (event.phase != TickEvent.Phase.END || !(event.player instanceof ServerPlayer player)) return;
        // ... same body as the NeoForge version
    }
}
// and in onCast: new MobEffectInstance(MyEffects.MANA_BURN.get(), 60, 0)

Clone this wiki locally