Skip to content

Commit 78ff7f6

Browse files
Updated RLBot v5 overview for pre-release and fix grammar
Updated the RLBot v5 overview to reflect its stable pre-release status and improvements over v4. Fixed grammatical issues and clarified the transition from DLLs to web sockets.
1 parent 704ac23 commit 78ff7f6

File tree

1 file changed

+17
-17
lines changed

1 file changed

+17
-17
lines changed

docs/v5/framework/v5.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# RLBot v5 (Beta) Overview
22

3-
RLBot v5 is the next major version of the RLBot framework bringing a host of reliability improvements and some new features to the table.
3+
RLBot v5 is the next major version of the RLBot framework, bringing a host of reliability improvements and some new features to the table.
44

5-
RLBot v5 is now in beta.
6-
In this beta period we will fix bugs, incorporate feedback, and potentially make minor breaking changes.
7-
However, RLBot v5 is now about feature-complete and people can start adopting it.
8-
Note that the various language interfaces are currently in development and may be unstable.
5+
RLBot v5 is now in pre-release!
6+
RLBot v5 is now stable and almost feature-complete, meaning people can start adopting it.
7+
Note that the various language interfaces are still in development and may be unstable.
8+
There is also a functional GUI ready for bot development, with only QoL features still missing.
99

1010
Windows Installer: [DOWNLOAD](https://github.com/RLBot/launcher/releases/tag/installer)
1111

12-
Any updates to RLBot v5 beta and the language interfaces will be announced in the [RLBot Discord #annoucements](https://discord.com/channels/348658686962696195/352588748401410049) channel.
12+
Any updates to RLBot v5 and the language interfaces will be announced in the [RLBot Discord #annoucements](https://discord.com/channels/348658686962696195/352588748401410049) channel.
1313

1414
- If you find bugs, please report them on [Github](https://github.com/RLBot/core/issues).
1515
- If you run into issues with v5, you can find help on Discord, either in the appropriate [language channel](https://discord.com/channels/348658686962696195/446761380654219264) or in the [#framework-dev](https://discord.com/channels/348658686962696195/423167304956903428) channel.
@@ -25,25 +25,25 @@ In the remainder of this document we will cover:
2525

2626
## Why v5?
2727

28-
RLBot v4 has been incredibly user-friendly, feature rich, and stable.
28+
RLBot v4 has been incredibly user-friendly, feature-rich, and stable.
2929
It was made in 2018 when RLBot was still using DLL injection.
30-
Later, in 2019, the collaboration with Psyonix and the official API were introduced.
31-
Since then, there have only been minor changes and new features, which proves how well-designed v4 was.
30+
Later, in 2019, the collaboration with Psyonix and the official API was introduced.
31+
Since then, there have only been minor changes and new features, which prove how well-designed v4 was.
3232
In fact, v5 is not that different from v4.
33-
It is primarily a rewrite and an opportunity fix the flaws of v4 that have been revealed over the years.
33+
It is primarily a rewrite and an opportunity to fix the flaws of v4 that have been revealed over the years.
3434
So here are the main reasons we made v5:
3535

3636
- The closed-source part of v4 is doing more than just communication with the Psyonix API.
3737
This has long prevented the community from fixing certain bugs themselves.
38-
Therefore we are extracting that functionality into the open-source part of RLBot, making the closed-source part exclusively about communication with the API.
38+
Therefore, we are extracting that functionality into the open-source part of RLBot, making the closed-source part exclusively about communication with the API.
3939
- The closed-source part of v4 is written in C++.
40-
By rewritting the backend of RLBot in C# we hope that more people feel comfortable contributing to it.
41-
- No more DLLs. You may not be aware, but most bots still uses a DLL to communicate directly to the RLBot backend.
40+
By rewriting the backend of RLBot in C#, we hope that more people feel comfortable contributing to it.
41+
- No more DLLs. You may not be aware, but most bots still use a DLL to communicate directly to the RLBot backend.
4242
In v5, the transition to web sockets is finally complete and this allows the bot interfaces to be improved (e.g. Python type hints are not a hack anymore).
43-
- All languages can start matches in v4, but the logic for launching of Rocket League and bots was only implemented in Python (and partially Rust).
44-
This discouraged people from writing match starters (GUI, autoleague, etc) in other languages than Python (even CleoPetra written in Java uses a Python process to start matches).
45-
Therefore we are moving this logic to the backend for v5 such that more languages can benefit from it.
46-
- We are releasing ourselves from design choices made under restrictions of the DLL injection.
43+
- All languages can start matches in v4, but the logic for launching Rocket League and bots was only implemented in Python (and partially Rust).
44+
This discouraged people from writing match starters (GUI, autoleague, etc) in languages other than Python (even CleoPetra, written in Java, uses a Python process to start matches).
45+
Therefore, we are moving this logic to the backend for v5, such that more languages can benefit from it.
46+
- We are freeing ourselves from design choices made under the restrictions of the DLL injection.
4747
- The Psyonix API made a few extra features available to us, but we never integrated them in v4. They are integrated in v5.
4848
- Python is very slow. The rewrite in C# has made this clear.
4949
- The `.cfg` file format has no standard. We are changing to the similar `.toml` format.

0 commit comments

Comments
 (0)