Getting Started
Introduction
What the sofyCore API offers, how it is structured into packages and which modules register which services.
Packages
| Package | Contents |
|---|---|
net.sofycore.api | SofyCoreApi, EventBus, PlaceholderRegistry |
net.sofycore.api.rank | RankService, RankAppearanceService, RankContextService, models and RankStateEvent |
net.sofycore.api.moderation | ModerationService, ReportService, Sanction, Report, ModerationEvent |
net.sofycore.api.staff | StaffService, FreezeService, VanishService, StaffModeService and their events |
net.sofycore.api.vippoints | VippointsService, VipTemplate, VipPurchase |
net.sofycore.api.maintenance | MaintenanceService, MaintenanceState |
net.sofycore.api.bossbar | BossBarService and catalog models |
net.sofycore.api.scoreboard | ScoreboardService |
net.sofycore.api.nametag | NametagService |
net.sofycore.api.menu | MenuService |
net.sofycore.api.essentials | EssentialsService |
net.sofycore.api.user | UserService, OnlineUsers, UserProfile and session events |
net.sofycore.api.network | PlayerDirectory, ServerPresence, ProxyGateway |
net.sofycore.api.storage | PersistenceService, RedisService, StorageReadyEvent |
net.sofycore.api.tag, chat, announcement, sound, config | Tags, 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.