mirror of
https://github.com/ViaVersion/ViaLoader.git
synced 2024-11-16 10:55:31 +01:00
Restructure README.md (#43)
* Restructure README.md
Various changes to recommend the pipeline classes as well as improving the documentation/making things more clear.
* Smaller improvements ™️
This commit is contained in:
parent
b486165fc2
commit
7caa8bef89
69
README.md
69
README.md
@ -76,38 +76,99 @@ ViaLoader provides a wrapper class with default values for that. To use a defaul
|
|||||||
If you want to change the default value you should create your own class which extends the base class and overrides the methods you want to change.
|
If you want to change the default value you should create your own class which extends the base class and overrides the methods you want to change.
|
||||||
|
|
||||||
The only default value you have to change is the ``VLLoader`` argument. The loader is used to register all the providers for the Via* platforms.
|
The only default value you have to change is the ``VLLoader`` argument. The loader is used to register all the providers for the Via* platforms.
|
||||||
To override the default you first create a new class which extends ``VLLoader`` and overrides the ``load`` method (Make sure to call the super method).
|
Providers are used to provide information about the platform to ViaVersion when it's (almost) impossible to get them ourselves.
|
||||||
|
|
||||||
|
To override the default you first create a new class which extends ``VLLoader`` and overrides the ``load`` method.
|
||||||
Within the ``load`` method you have to register a ``VersionProvider`` implementation which will be used to determine the target server version of a given connection.
|
Within the ``load`` method you have to register a ``VersionProvider`` implementation which will be used to determine the target server version of a given connection.
|
||||||
Here is an example implementation:
|
Here is an example implementation:
|
||||||
```java
|
```java
|
||||||
|
public class CustomVLLoaderImpl extends VLLoader {
|
||||||
|
|
||||||
|
@Override
|
||||||
|
public void load() {
|
||||||
|
super.load();
|
||||||
|
|
||||||
Via.getManager().getProviders().use(VersionProvider.class, new BaseVersionProvider() {
|
Via.getManager().getProviders().use(VersionProvider.class, new BaseVersionProvider() {
|
||||||
@Override
|
@Override
|
||||||
public ProtocolVersion getClosestServerProtocol(UserConnection connection) {
|
public ProtocolVersion getClosestServerProtocol(UserConnection connection) {
|
||||||
return ProtocolVersion.v1_8; // Change the logic here to select the target server version
|
// Change the logic here to select the target server version
|
||||||
|
return ProtocolVersion.v1_8;
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
}
|
||||||
|
}
|
||||||
```
|
```
|
||||||
Then you have to create a new instance of your loader class and pass it to the ``ViaLoader.init`` call.
|
Then you have to create a new instance of your loader class and pass it to the ``ViaLoader.init`` call.
|
||||||
|
|
||||||
To do this you can call the ``ViaLoader.init()`` method somewhere suitable in your project (You can do that async) with your desired argument values:
|
To do this you can call the ``ViaLoader.init()`` method somewhere suitable in your project (You can do that async) with your desired argument values:
|
||||||
```java
|
```java
|
||||||
ViaLoader.init(null/*ViaPlatform*/, new CustomVLLoaderImpl(), null/*ViaInjector*/, null/*ViaCommandHandler*/, ViaBackwardsPlatformImpl::new, ViaLegacyPlatformImpl::new, ViaAprilFoolsPlatformImpl::new);
|
ViaLoader.init(null/*ViaPlatform*/, new CustomVLLoaderImpl(), null/*ViaInjector*/, null/*ViaCommandHandler*/, ViaBackwardsPlatformImpl::new, ViaRewindPlatforImpl::new, ViaLegacyPlatformImpl::new, ViaAprilFoolsPlatformImpl::new, ViaBedrockPlatformImpl::new);
|
||||||
```
|
```
|
||||||
|
Make sure to have all platform impls you need added to the init call. Every platform added there needs to be in your dependencies.
|
||||||
|
|
||||||
After you have initialized the Via* platforms you can start implementing ViaLoader into your project.
|
After you have initialized the Via* platforms you can start implementing ViaLoader into your project.
|
||||||
|
|
||||||
|
### Netty modifications
|
||||||
|
|
||||||
The most important part is the modification of your netty pipeline. This is needed for ViaVersion to translate the packets in both ways.
|
The most important part is the modification of your netty pipeline. This is needed for ViaVersion to translate the packets in both ways.
|
||||||
|
|
||||||
|
Our recommended way is to use the `VLPipeline` (for codec based pipelines) or the `VLLegacyPipeline` (for decoder/encoder pipelines) as it
|
||||||
|
automatically handles the modifications required for all Via* platforms.
|
||||||
|
|
||||||
|
Here is an example implementation:
|
||||||
|
```java
|
||||||
|
public class CustomVLPipeline extends VLPipeline {
|
||||||
|
|
||||||
|
public ViaProxyVLPipeline(UserConnection user) {
|
||||||
|
super(user);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Replace these with the names of your pipeline components
|
||||||
|
@Override
|
||||||
|
protected String compressionCodecName() {
|
||||||
|
return "compression_codec";
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected String packetCodecName() {
|
||||||
|
return "packet_codec";
|
||||||
|
}
|
||||||
|
|
||||||
|
@Override
|
||||||
|
protected String lengthCodecName() {
|
||||||
|
return "length_codec";
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
||||||
|
```
|
||||||
|
The same can be done for the `VLLegacyPipeline` with similar functions for the decoder/encoder pairs.
|
||||||
|
|
||||||
|
Then you can add the Via* pipeline to your netty pipeline:
|
||||||
|
```java
|
||||||
|
final UserConnection user = new UserConnectionImpl(channel, true/*clientside or serverside*/);
|
||||||
|
new ProtocolPipelineImpl(user);
|
||||||
|
|
||||||
|
channel.pipeline().addLast(new CustomVLPipeline(user));
|
||||||
|
```
|
||||||
|
|
||||||
|
Both `VLPipeline` and `VLLegacyPipeline` contain various functions allowing you to modify/wrap the existing pipeline elements,
|
||||||
|
if you need a more complex/dynamic pipeline setup you can also manually add the Via* handlers to the pipeline.
|
||||||
Here is an example implementation:
|
Here is an example implementation:
|
||||||
```java
|
```java
|
||||||
final UserConnection user = new UserConnectionImpl(channel, true/*clientside or serverside*/);
|
final UserConnection user = new UserConnectionImpl(channel, true/*clientside or serverside*/);
|
||||||
new ProtocolPipelineImpl(user);
|
new ProtocolPipelineImpl(user);
|
||||||
|
|
||||||
|
//channel.pipeline().addBefore("packet_decoder", VLLegacyPipeline.VIA_DECODER_NAME, new ViaDecoder(user));
|
||||||
|
//channel.pipeline().addBefore("packet_encoder", VLLegacyPipeline.VIA_ENCODER_NAME, new ViaEncoder(user));
|
||||||
channel.pipeline().addBefore("packet_codec", VLPipeline.VIA_CODEC_NAME, new ViaCodec(user));
|
channel.pipeline().addBefore("packet_codec", VLPipeline.VIA_CODEC_NAME, new ViaCodec(user));
|
||||||
```
|
```
|
||||||
If you are using ViaLegacy, you should read its README to see what changes you need to make to the netty pipeline for it to work.
|
If you are using ViaLegacy, you should read its [README](https://github.com/ViaVersion/ViaLegacy?tab=readme-ov-file#vialegacy) to see what changes you need to make to the netty pipeline for it to work.
|
||||||
|
|
||||||
Depending on where you are implementing ViaLoader you might need to ensure that the pipeline is held in the correct order.
|
Depending on where you are implementing ViaLoader you might need to ensure that the pipeline is held in the correct order.
|
||||||
Minecraft clients modify the pipeline order when adding the compression handlers. You have to ensure that the Via* handlers are always on their correct location.
|
Minecraft clients modify the pipeline order when adding the compression handlers. You have to ensure that the Via* handlers are always on their correct location.
|
||||||
|
|
||||||
|
If you are using the `VLPipeline` or `VLLegacyPipeline` you can fire the `CompressionReorderEvent` once the compression handler is added to the pipeline.
|
||||||
|
|
||||||
Now you should have a working protocol translator implementation in your project.
|
Now you should have a working protocol translator implementation in your project.
|
||||||
|
|
||||||
## Configuring the protocol translation
|
## Configuring the protocol translation
|
||||||
|
Loading…
Reference in New Issue
Block a user