Skip to content
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.

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

Remove (most of the) advanced API #536

Closed
Tim203 opened this issue Aug 24, 2024 · 0 comments
Closed

Remove (most of the) advanced API #536

Tim203 opened this issue Aug 24, 2024 · 0 comments
Milestone

Comments

@Tim203
Copy link
Member

Tim203 commented Aug 24, 2024

Remove the following APIs, which will result in breaking changes in the API between Floodgate 2 and Floodgate 3:

  • handshake handlers
  • packet handlers
  • injector addons
  • floodgate logger

Handshake handlers

As of creating this issue the only API that already has been marked as deprecated already (for two years.) This system may be replaced with an event, but that's not certain yet.

Packet handlers

The idea was since Floodgate will be on many servers, we could make it a bit easier for people to use our existing injection so that they don't have to use other libraries. But instead of exposing the packets directly we should have a proper API to do what they want to do.

Injector addons

Injector addons are called when a channel has been injected by Floodgate (so when a player joins) and are called again when a player has left the server. Just like with packet handlers we should focus on creating an API that handles the logic for you and allows you to do what you want, without handling packets/channels directly.

Floodgate logger

To be honest, I don't know why this was ever part of the API.

Why

The first three items all have in common that they expose Netty logic. Netty should not be exposed in a library like this. Additionally with Floodgate 3 we want to be able to not just support Netty 4 but also Netty 5 and no Netty at all.

@Tim203 Tim203 added this to the Floodgate 3.0 milestone Aug 24, 2024
@Tim203 Tim203 added this to Floodgate Aug 24, 2024
@Tim203 Tim203 moved this to Todo in Floodgate Aug 24, 2024
@Tim203 Tim203 moved this from Todo to In Progress in Floodgate Sep 1, 2024
Tim203 added a commit that referenced this issue Sep 1, 2024
@Tim203 Tim203 closed this as completed Sep 4, 2024
@Tim203 Tim203 moved this from In Progress to Done in Floodgate Sep 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

No branches or pull requests

1 participant