Skip to content

Commit 5123aa6

Browse files
committed
chore: translate entire project to english for broader accessibility
1 parent ad7ff1e commit 5123aa6

File tree

3 files changed

+27
-34
lines changed

3 files changed

+27
-34
lines changed

base/src/main/java/by/milansky/protocol/base/packet/registry/BasePacketRegistry.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,8 +18,8 @@
1818
/**
1919
* @author milansky
2020
* <p>
21-
* Выглядит убого, но примерно только так можно добиться константного времени
22-
* не подключая лишних либ (e.g. BidirectionalMap - де-факто то же самое)
21+
* Looks lame, but this is roughly the only way to achieve constant time
22+
* without adding extra libraries (e.g., BidirectionalMap - de-facto the same thing)
2323
*/
2424
@NoArgsConstructor(staticName = "create")
2525
@FieldDefaults(level = AccessLevel.PRIVATE, makeFinal = true)

readme.md

Lines changed: 21 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -6,75 +6,68 @@
66
<img src="https://img.shields.io/github/stars/rmilansky/minecraft-protocol-java?style=flat" />
77
</div>
88

9-
# Введение
9+
# Introduction
1010

11-
Minecraft Protocol - проект, написанный мной из-за того, что все библиотеки для взаимодействия с пакетами слишком
12-
устарели, либо недостаточно легки для использования в моих проектах (также из-за глобальной переписи всей кодовой
13-
базы [Abelix](https://abelix.team)).
11+
Minecraft Protocol is a project I developed because all existing libraries for packet handling are either outdated or insufficiently lightweight for use in my projects (also due to a complete rewrite of the [Abelix](https://abelix.team) codebase).
1412

15-
Проект был написан буквально за один подход одним человеком, возможны баги/некрасивый код, но буду очень рад любым пулл
16-
реквестам и issue.
13+
The project was written in a single attempt by one person, so there might be bugs or less-than-perfect code. I would greatly appreciate any pull requests or issues.
1714

1815
<img src=".assets/time.jpg" width="500"/>
1916

20-
# Краткий обзор проекта
17+
# Project Overview
2118

22-
## Для чего это всё?
19+
## Purpose
2320

24-
Проект нужен для максимально удобной и интегрируемой разработки систем, для которых нужно использование пакетов
25-
протокола Minecraft (e.g. фейк энтити, неймтеги для серверов, прокси системы).
21+
This project is designed for the most convenient and integrable development of systems that require the use of Minecraft protocol packets (e.g., fake entities, nametags for servers, proxy systems).
2622

27-
## Основные задачи
23+
## Key Objectives
2824

29-
* Максимально простое взаимодействие с пакетами и их прослушкой
30-
* Интеграция во все современные ядра / standalone приложения
25+
* Simplify packet handling and monitoring as much as possible.
26+
* Ensure integration with all modern server cores and standalone applications.
3127

32-
# Руководство по использованию
28+
# Usage Guide
3329

34-
Более глубокие примеры использования можно посмотреть в директории [examples](examples).
35-
Но если попытаться объяснить кратко, то вот, например, как прослушать все ClientboundTeam пакеты:
30+
More detailed usage examples can be found in the [examples](examples) directory. However, to briefly explain, here's how you can listen to all `ClientboundTeam` packets:
3631

37-
1. Создаем сам хандлер, который будет заниматься обработкой пакетов:
32+
1. Create a handler to process packets:
3833

3934
```java
40-
4135
@Log4j2
4236
public final class ClientboundTeamHandler {
4337
@PacketProcessor
4438
public @NotNull PacketHandleResult handle(final Channel channel, final ClientboundTeam team) {
45-
// Логируем, что сервер пытается отправить пакет
39+
// Log that the server is attempting to send a packet
4640
log.info("Outbound team packet: {}", team);
4741

4842
if (team.containsPlayer("milanskyy")) {
49-
// Предотвращаем отправку пакета
43+
// Prevent the packet from being sent
5044
return BasePacketHandleResult.cancel();
5145
}
5246

53-
// Всё окей, просто разрешаем его отправку
47+
// Everything is fine; allow the packet to be sent
5448
return BasePacketHandleResult.ok();
5549
}
5650
}
5751
```
5852

59-
2. Добавляем его игроку при входе:
53+
2. Add the handler on player join:
6054

6155
```java
6256
public final class NametagListener implements Listener {
6357
@EventHandler
6458
public void onCreate(final ProtocolPlayerCreateEvent event) {
6559
val protocolPlayer = event.protocolPlayer();
6660

67-
// Так как это хандлер базированный на аннотациях, оборачиваем его в AnnotationBasedHandler
68-
// и непосредственно добавляем игроку
61+
// Since this handler is annotation-based, wrap it in an AnnotationBasedHandler
62+
// and add it to the player
6963
protocolPlayer.appendPacketHandler(AnnotationBasedHandler.create(ClientboundTeamHandler.create()));
7064
}
7165
}
7266
```
7367

7468
# Credits
7569

76-
Большое спасибо за идеи и информацию этим проектам:
70+
Special thanks for ideas and inspiration to these projects:
7771

78-
* [Velocity](https://github.com/PaperMC/Velocity), [BungeeCord](https://github.com/SpigotMC/BungeeCord) - за некоторые
79-
идеи и структуру пакетов
80-
* [BridgeNet](https://github.com/MikhailSterkhov/bridgenet) - за идею этого прекрасного readme
72+
* [Velocity](https://github.com/PaperMC/Velocity), [BungeeCord](https://github.com/SpigotMC/BungeeCord) - for some ideas and packet structures.
73+
* [BridgeNet](https://github.com/MikhailSterkhov/bridgenet) - for the idea of this beautiful readme
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
/**
22
* @author milansky
33
* <p>
4-
* Здесь находятся все классы, связанные с чтением/записью майнкрафт пакетов,
5-
* которая реализована разработчиками ядра - зачастую прокси-классы, которые позволяют нам
6-
* встроить свою логику в их код.
4+
* This package contains all the classes related to reading/writing Minecraft packets,
5+
* as implemented by the core developers — primarily proxy classes that allow us
6+
* to insert our logic into their code.
77
* <p>
8-
* Могут возникнуть проблемы на новых версиях. TODO.
8+
* Issues may arise with newer versions. TODO.
99
*/
1010
package by.milansky.protocol.vanilla.codec;

0 commit comments

Comments
 (0)