Skip to content

Getting Started

Introduction

What the sofyCore API offers, how it is structured into packages and which modules register which services.

Packages

PackageContents
net.sofycore.apiSofyCoreApi, EventBus, PlaceholderRegistry
net.sofycore.api.rankRankService, RankAppearanceService, RankContextService, models and RankStateEvent
net.sofycore.api.moderationModerationService, ReportService, Sanction, Report, ModerationEvent
net.sofycore.api.staffStaffService, FreezeService, VanishService, StaffModeService and their events
net.sofycore.api.vippointsVippointsService, VipTemplate, VipPurchase
net.sofycore.api.maintenanceMaintenanceService, MaintenanceState
net.sofycore.api.bossbarBossBarService and catalog models
net.sofycore.api.scoreboardScoreboardService
net.sofycore.api.nametagNametagService
net.sofycore.api.menuMenuService
net.sofycore.api.essentialsEssentialsService
net.sofycore.api.userUserService, OnlineUsers, UserProfile and session events
net.sofycore.api.networkPlayerDirectory, ServerPresence, ProxyGateway
net.sofycore.api.storagePersistenceService, RedisService, StorageReadyEvent
net.sofycore.api.tag, chat, announcement, sound, configTags, chat channels, announcements, sounds and configuration files

Service availability

A service is registered only while its module is running. SofyCoreApi.service(Class) returns Optional.empty() when the module is disabled, failed to start, or (for data services) storage is not ready yet. Always handle the empty case.