Skip to content

docs(core): clarify super endpoint metadata contract #56

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
robinbraemer merged 2 commits into from
Jul 13, 2026
+6 −9
Merged

docs(core): clarify super endpoint metadata contract #56

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7e123f1
docs: clarify super endpoint metadata
robinbraemer Jul 13, 2026
341da45
no-mistakes(review): Align super-endpoint Javadoc with parent metadat…
robinbraemer Jul 13, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 0 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,9 +75,6 @@ own proxies as well as through the Connect network.
You don't need to use own proxies since the Connect network already works like a global shared proxy
where every Minecraft server/proxy can connect to.

There will be public APIs available for you to manage your connected endpoints and players like
sending players a message, moving them between your servers and so on.

## Special thanks

**Special thanks goes to the [GeyserMC](https://github.com/GeyserMC) developers for their Floodgate
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/java/com/minekube/connect/config/ConnectConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,8 +61,8 @@ public class ConnectConfig {
private BedrockIdentityConfig bedrockIdentity = new BedrockIdentityConfig();

/**
* Super endpoints are authorized to control this endpoint via Connect API.
* e.g. disconnect players from this endpoint, send messages to players, etc.
* Optional parent endpoint names sent to WatchService as Connect-Endpoint-Parents.
* Connect Java does not expose a public endpoint-control API.
*/
private List<String> superEndpoints;

Expand Down
4 changes: 2 additions & 2 deletions core/src/main/resources/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ endpoint: ${endpoint}
# If left blank, the correct mode will be securely detected automatically.
allow-offline-mode-players: false

# Super endpoints are authorized to control this endpoint via Connect API.
# e.g. disconnect players from this endpoint, send messages to players, etc.
# Optional parent endpoint names sent to WatchService as Connect-Endpoint-Parents.
# This plugin does not expose a public endpoint-control API.
#
# You can add as many super endpoint names as you want.
#super-endpoints:
Expand Down
4 changes: 2 additions & 2 deletions core/src/main/resources/proxy-config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ allow-offline-mode-players: false
# The default locale for Connect. By default, Connect uses the system locale
#default-locale: en_US

# Super endpoints are authorized to control this endpoint via Connect API.
# e.g. disconnect players from this endpoint, send messages to players, etc.
# Optional parent endpoint names sent to WatchService as Connect-Endpoint-Parents.
# This plugin does not expose a public endpoint-control API.
#
# You can add as many super endpoint names as you want.
#super-endpoints:
Expand Down
Loading