Repository navigation
Quick Reference
Gugas749 edited this page Nov 16, 2026
·
2 revisions
| I want to… | Use |
|---|---|
| Check if a player is staff (server) | AbyssPermissionHandler.has(player, MODERATOR) |
| Gate a command |
.requires(src -> AbyssPermissionHandler.sourceHas(src, LEVEL)) on your sub-literal |
| Reject a packet with a message | if (!AbyssPermissionHandler.require(player, LEVEL)) return; |
| Hide a button for non-staff (client) | AbyssClientPermission.has(MODERATOR) |
| Make someone a moderator |
AbyssPermissionHandler.grant(uuid, MODERATOR) + AbyssPermissionSync.sync(player)
|
| Send a packet |
AbyssNetworking.createChannel(...) -> CHANNEL.sendToPlayer/All/Tracking/TrackingAndSelf/Server
|
| Store per-player data that the client can read | AbyssSyncedAttachment.register(modId, name, default, codec) |
| Raise or lower corruption |
AbyssCorruption.add(player, n) / addProgress(player, ticksPerLevel)
|
| Read corruption on the HUD | AbyssCorruption.get(Minecraft.getInstance().player) |
| Damage + effect in one call | AbyssDamage.deal(target, source, dmg, new MobEffectInstance(...)) |
| Build a damage source for any type | AbyssDamageSources.source(key, level[, attacker | direct, causing]) |
| A new damage type | Key + DamageTypeBuilder datagen or a damage_type JSON + lang key |
| Keep an effect on permanently | AbyssEffectHandler.registerContinuousEffect(uuid, instance) |
| Draw my own texture Abyss-style | AbyssDraw.nineSlice(g, texture, texW, texH, sprite, border, x, y, w, h) |
| Tint the screen while an effect is active |
AbyssScreenOverlay.bindEffect(holder | id | effect, spec), on both sides |
| A HUD players can move, resize, hide and configure |
AbyssHud + AbyssHudElement (§14.9); render from your layer, openEditor() / editorCommand("name")
|
| Per-element HUD options (gear popup) |
AbyssHudElement.settings() -> HudSetting.toggle / cycle / choice / slider
|
| Flash the screen on a damage type | AbyssScreenOverlay.bindDamageType(key, spec, ticks) |
| Flash the screen from code |
AbyssScreenOverlay.show(player, id, spec, ticks) / clear(player, id)
|
| Organize commands |
extends AbyssCommandRegistrar + registerAll(dispatcher)
|
| A staff screen with tabs |
extends AbyssPanelScreen + AbyssTabs |
| A confirm or delete popup |
AbyssDialog.confirm / confirmDanger / input / alert
|
| Lay out widgets |
ctx.column(gap), ctx.row(gap), AbyssLayout.grid(...)
|
| An animated GeckoLib item or entity |
extends AbyssGeoItem / AbyssGeoEntity
|
| Respect vanish in my mod | VanishManager.canSee(viewer, target) |
| A 3D effect (shockwave, beam, wings...) | AbyssVfx.of(VfxType.X).at(pos).scale(s).colors(a, b).duration(t).send(level) |
| My own 3D effect |
extends VfxInstance + AbyssVfxClient.register(id, Factory::new) (client), AbyssVfx.of(id) (server) |
| A cutscene / camera orbit / letterbox + title |
AbyssCinematic.builder(id, ticks)...build() + AbyssCinematics.play(player, c)
|
| Screen shake for everyone nearby | AbyssCinematics.quake(level, pos, radius, ticks, strength) |
| Run server code at tick N of a cinematic | AbyssCinematics.schedule(server, n, task) |
| Colour one player's sky for a while |
AbyssSky.set(player, AbyssSkySpec.tint(rgb, 0.8f), ticks) / clear(player)
|
| A saved sky for a dimension |
AbyssSky.setDimension(server, dimension, spec) or /abysscore sky panel
|
| No rain / no clouds / no lightning |
AbyssWeather.set(server, AbyssWeather.settings().withRain(false)...) or the menu's Weather tab |
| Whispers on someone's screen | AbyssVoices.send(player, AbyssVoiceSpec.of("...").withCount(n).withColor(rgb)) |
| Package | Classes |
|---|---|
api.attachment |
AbyssSyncedAttachment, AttachmentNbt, AttachmentStorage, SyncAttachmentPacket, SyncAttachmentClientHandler
|
api.cinematic |
AbyssCinematic (Builder, Letterbox, Fill, Vignette, Text, HideHud, Camera, Orbit, Shake, Fov, LockView, FullBright, TextAnchor, CameraMode), AbyssCinematics, Keyframes, Ease, CinematicText, CinematicPacket* |
api.cinematic.client |
AbyssCinematicsClient |
api.command |
AbyssCommand, AbyssCommandRegistrar
|
api.corruption |
AbyssCorruption, CorruptionData
|
api.damages |
AbyssDamage, AbyssDamageSources, AbyssDamageTypes, DamageTypeBuilder
|
api.effects |
AbyssEffectHandler |
api.geckolib (per loader)
|
AbyssGeoBase, AbyssGeoItem, AbyssGeoEntity
|
api.gui.dialog |
AbyssDialog |
api.gui.layout |
AbyssLayout (Flow, Grid), AbyssSized
|
api.gui.render |
AbyssDraw |
api.gui.screen |
AbyssPanelScreen, AbyssTab, TabContext
|
api.gui.theme |
AbyssTheme (Sprite) |
api.gui.widget |
AbyssButton, AbyssIconButton, AbyssLabel, AbyssScrollList, AbyssSlider, AbyssTabButton, AbyssTextField, AbyssToggle
|
api.network |
AbyssNetworking, AbyssChannel, AbyssPacketCodec, AbyssPacketContext, AbyssPacketRegistrar
|
api.overlay |
AbyssScreenOverlay, AbyssOverlaySpec, AbyssOverlayRenderer, ScreenOverlayPacket
|
api.permission |
AbyssPermissionHandler, AbyssPermissionLevel, AbyssClientPermission, AbyssPermissionSync, PermissionSyncPacket* |
api.sky |
AbyssSky, AbyssSkySpec, SkyPacket* |
api.sky.client |
AbyssSkyClient |
api.voices |
AbyssVoices, AbyssVoiceSpec, VoicePacket* |
api.voices.client |
AbyssVoicesClient |
api.weather |
AbyssWeather (Type), AbyssWeatherSettings, WeatherSyncPacket* |
api.weather.client |
AbyssWeatherClient |
api.vfx |
AbyssVfx (Builder), VfxType, VfxSpec, VfxPacket* |
api.vfx.client |
AbyssVfxClient, VfxInstance (Spark), VfxCanvas, VfxRenderTypes, VfxShaders
|
api.vfx.client.effects |
LightEffects, MotionEffects, VoidEffects (the built-in effects; extend VfxInstance instead) |
* Internal plumbing. It's public because AbyssCore's loaders need it; don't call it yourself.
AbyssCore © 2026 Gugas749, BSD 3-Clause License.
- Setup: depending on AbyssCore
- Sides, threads and lifecycle: read this first
- Permissions
- Networking
- Synced player data
- Corruption
- Damage
- Continuous effects
- Screen overlays
- VFX: 3D effects
- Cinematics
- Sky
- Commands
- GUI toolkit
- GeckoLib
- Outside the API package: vanish and config queries
- Complete example: a mana mod
- Limitations, troubleshooting and changelog
- Quick reference