Starlight -「星辰」

An 'Atomic' designed server plugin aimed to cover anything you need.

Explore docs | Report issue

This project is still under development and inconsistency.

This project is a continuation of quark-plugin.
for more information and legacy downloads, please go there, also.

Description

This is an essential plugin suite for Spigot/Paper/Folia/Mohist servers, including more than 90 modules that provides countless features for servers of any scale! This plugin also includes several performance enhancements and fixes. From management to display,game features to security, these contents will improve your server from every aspect.

Possible Usages

• create a SMP server.
• create a CMP server with WorldEdit and CoreProtect.
• create a Lobby server with Citizens and sign-in plugins.

All the features are independently and composable. you can customize its function by enable or disable modules, add or remove extension packs, or even make your own pack through sdk pack.

Goal and reason of this

We are not likely to focus on those massive contents or doing things to extreme on single function. What we are doing is to create a liquid that fills the unmodified details on the server. So please do not expect we will do something as a mod——at least not in primary packages. Starlight only provide a basic and usable implementation, so if you find dedicated plugin to replace part of function provided, just use them without doubts——They are 100% better.

Core Features

• MultiPlatform support: supports basically every Bukkit-Implemented Server(see below)
• Fast: initialize on less than 600ms, support command-line hot reload.
• Modularized: all features are separately toggleable.

Installation

Artifact relations:

• starlight-core.jar: you can see this as a library or CORE, though it works differently.
• starlight-xxx.jar: recommended extension pack.
• starlight-ext-xxx.jar: addition (optional) extension pack.

1. identify correct files needed.

Modrinth does not like putting multiple files on single version. So you need to get multiple versions:

This is what a artifact id looks like:

starlight-core-0.80.0

The prefix starlight-core says the artifact jar pack. This can be located by filtering modules you need in Contents section.

The version 0.80.0 has three parts:

• Major version: 0 is the beta-alpha dev test.
• API version: 80 is API version 80. numbers between [0,10) is backward compatible.
• Snapshot version: only for verification. does not matter.

All you have to do is to match them:

Example Core Version	Example Pack Version	Compatible?	Reason
0.80.0	0.92.0	NO	API imcompatible.
0.80.0	0.83.11	NO	Pack requires a higher API version.
0.80.0	0.80.42	YES	API Matched(BEST)
0.83.0	0.81.0	YES	API backward compatible.
0.91.78	0.80.30	NO	Core API Version too high

Commonly, you need to download multiple versions for full functions. We will also publish starlight-all artifacts for lazy users. (coming soon)

2. install them.

• Stop server or type /starlight reload prepare
• Throw them into your jar.

3. reload.

• Start your server or type /starlight reload action
• Wait.

Contents

Basic concepts

• Module: The minimum unit of functions this artifact provides.
• Package: The smallest group of modules, share value configurations and i18n files. > A package or module can be enabled or disable by commands.
  > A jar will contain multiple modules.

Click on each tabs and expand them to see what is included.
This readme will become to loooooooooong if I don't do this.

starlight-core.jar

starlight-core: fixes, services and patches [INTERNAL]

• custom-language-pack-loader: load third-party language packs.
• intiallation-check: warn users if they installed this plugin incorrectly.
• modrinth-version-check: modrinth api supported version check system. [BETA]
• papi-support: use PlaceHolder API for text formatting, and inject configured vars in PAPI.
• platform-patcher: provide multiple fixes for non-standard bukkit platform.
• protocol-lib-injector: replace text sending with protocol-lib.
• version-log-viewer: allow users to view version log. [BETA]

starlight-basic.jar

starlight-commands: command shortcuts and additions

• entity-motion: provide a command that set the velocity of any entity.
• command-exec: provide a simplex version of /execute, but works with any commands.
• item-command: provide a binding to execute command when using specific item.
• worldedit-commands: provide multiple shortcut for worldedit commands.(need WorldEdit)

starlight-console: console appearance tweaks and utilities

• clear-console: create a command that can clear console.(honestly, i think it's useless)
• console-execute: enable user to execute command as console.
• custom-log-format: customize console style by replacing Log4j config. [EXPERIMENTAL]
• log-color-patch: bring ANSI color support on specific platform. [EXPERIMENTAL]
• stop-confirm: let you use /stop confirm just as what /reload confirm do.

starlight-display: create client's visual look, but not only UI.

• action-bar-hud: render a HUD displaying basic info on actionbar title position.
• afk: just as it's name, announce when player start afk and end afk.
• chat-format: re-format chat-line for a more advance look.
• custom-death-message: modify death message by adding prefix.
• custom-motd: integrated basic motd provider.
• custom-scoreboard: create a scoreboard information display.
• drop-item-info: add label representing type and count on dropped item stacks.
• hover-display: just as hologram does.
• inventory-menu: creating customized inventory menu by writing yml.
• player-name-header: add a header before player name, like"[OWNER]Player1145"
• tab-menu: customize information displayed on TAB.
• welcome-message: send player some test when player first joined server.
• we-session-renderer: visualize player's worldedit selection.

starlight-management: let server moderator to manage their server easily.

• ban: a more advanced /ban command that supports broadcast and temp-ban.
• chat-filter: automatically filter bad words in player's chat.
• chat-report: a simple chat report system that send triggers when chat is reported.
• kick-on-reload: kick all player out of server when server reloading.
• maintenance: provide a maintenance mode when only ops and allowed player can join.
• mute: mute system.(yep that's it)
• plugin-manager-command: integrated plugin management system.
• server-info: query server information by a single command.
• tps-bar: create a boss bar that displays TPS and MSPT.

starlight-security: server security and protections.

• advaced-permission-control: create permission for more world-interaction actions.
• explosion-defender: defend explosion easily.
• ip-defender: check player's ip-address and do actions.
• permission-manager: a simple and easy permission manager.(definitely worse than LuckPerms)

starlight-sideload: sideload some contents without restart.

• recipe-loader: load recipe configured by yml.

starlight-utilities: some utilities and oddities.

• block-update-locker: lock most block updates, like redstone or water.
• calculator: provide a command-line calculator.
• camera-movement: simulate camera smooth moves on server side.
• chat-at: allow you to @someone or @all.
• chat-component: allow you to write text components in chat and commands.
• dynamic-view-distance: allow you to customize view distance.
• hitokoto: get random beautiful and inspiring sentences online.
• player-ping-command: allow player to query their ping with command.
• player-position-lock: allow player to LOCK their position.
• position-align: allow player to align their position and facing.
• surrounding-refresh: allow players to forcibly refresh their blocks which could fix fake-blocks issue.
• tick-manager: wrap of /tick command.

starlight-warps: a warping system support.

• back-to-death: allow player to go back to their latest death position.
• rtp: randomly teleport player to a safe position.
• tpa: allow players to request to teleport to others or reversed.
• waypoints: provide a waypoint system for private or public waypoints.

Compatibility

We STRONGLY recommend you to use paper based server to enable full features. it could work on other platform, but who knows what will happen? (since lazy GrassBlock2022 never test them)

Versions showed in versions page are just for placeholder. all versions can work in [1.13-1.20]

Platform	Features	Interactive Text	Support	Description
Paper	Full	Full	Full	Recommended
Spigot	Most	Full	BugFix
Bukkit	Few	No	Test
Folia	Most	Full	BugFix	No hot reload
Mohist	Few	No	Test	UnexpectedBlockChange not sync

FAQ

What relationship does it have to that Starlight mod?

Basically, nope :D
Starlight mod has a totally different function from this artifact.It rewrites light engine and simply provide optimizes.

Why I can't see any changes after installing starlight-core.jar?

Man! What can I say? see Installation section :D

Why it is renamed?

This project is originally name quark-plugin. To avoid being collided with that mod——which everybody loves it, I decide to change its name.

But the reason is not only for this. This project actully starts from long long long long ago, from a small plugin. The most bad thing is that when I started this project, I actually have NO understandings to java.

So now, when this plugin is getting more appreciation, start off from the blank and refactor the WHOLE archtecture to ensure extandability is important.

What will happen since this project is a continuation?

Unfortunately, to wholly frick the architecture away, I HAVE to sacrifice A lot, especially, compatibility. from the following version, This project will enter alpha stages.The plugin will use a completely different namespace and ID.

As soon as the refactor done, the auto-migaration code will be added, to allow you to upgrade Player Data and module data from old plugin data folder, and the new starlight plugin can work with the old one together.

Help us test

Alpha stage goes with inconsistentcy, so it's now for you to offer help. Please submit any bugs or feature requests to github link above, thank you sooooo much.

Working with quark-plugin

The new starlight kernal now register things in a different namespace, but feature conflicts still exists. You have to manually disable modules that has duplicated feature with starlight in your older plugin.

Upgrading and migration

Currently, to port all modules and functions to new kernal system as fast as possible, data compatibility is not primary tasks. Once beta test stage is completed, data migration command will be added to let you move:

• Stored player data(like some of their personal settongs like view distance)
• Stored global data(waypoints…)
• Some of stored assets(permission data, midi musics…)

Unfortunately, since most of ids and values are changed, it's not possible to move or migrate legacy language or config file, so please re-configure them once it's ready.

Why I can't disable some module?

Some modules(mostly in starlight-core) provides basic features or relied by other systems. Enable them will not cost any resources.

Why I can't see some of the features after downloading this?

There are two possibilities.

1. Some features are not automatically enabled.

This is manually defined, since we won't expect them to load after we install the WHOLE bundler. For example, the log color patching module work fine on some server, but crash on others. It's hard to say why since it works like injecting, and there is no evidence points to platform api issue. To resolve this, after you KNOW what will happen, filter the correct module ID and enable it manually.

2. Some features require certain platform.

Bukkit-based server has multiple branches, and most of them are technically different. For example, Folia based server does NOT have scoreboard API(currently), and a MIXED server(combine forge/fabric with bukkit) has a horrible(not bad) class loading design. We just can't expect some features to work when our platform is missing needed API.

---

Starlight -「星辰」

A open project by GrassBlock2022, owning by @ATCraftMC 2020-2024