Merge pull request #37 from RLBot/search

NicEastvillage · web-flow · commit b59f23c1b538 · 2026-01-04T08:36:06.000+01:00
Add wiki search &amp; update remote rlbot page
diff --git a/docs/v4/botmaking/ball-path-prediction.md b/docs/v4/botmaking/ball-path-prediction.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 When writing a bot, it's very useful to know where the ball will be a few seconds in the future. This is very challenging because the ball responds to gravity, drag, friction, spin, and bounces off of curvy walls. Fortunately, chip has your back. He did a meticulous study of the ball physics and built an extremely accurate model: https://samuelpmish.github.io/notes/RocketLeague/ball_bouncing/
 
 Note: this is just an _estimate_ of what the ball will be doing in the future, **it is not exact**! It is recommended that you routinely update your predictions to have the most accurate estimates.
diff --git a/docs/v4/botmaking/bot-customization.md b/docs/v4/botmaking/bot-customization.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 # Bot customization
 
 ## GUI Customization
diff --git a/docs/v4/botmaking/config-file-documenation.md b/docs/v4/botmaking/config-file-documenation.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 # Bot Config File
 
 ## Sections
diff --git a/docs/v4/botmaking/dropshot.md b/docs/v4/botmaking/dropshot.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 As of August 19. 2018 the RLBot framework officially supports Dropshot with access to locations and states of floor tiles. This page contains information and useful values related to the Dropshot game mode.
 
 To make RLBot start a Dropshot game you have to set the following values in `rlbot.cfg`:
diff --git a/docs/v4/botmaking/hoops.md b/docs/v4/botmaking/hoops.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 The RLBot framework support the Hoops game mode. This page contains useful values specifically about Hoops.
 
 To make RLBot start a Hoops game you have to set the following values in `rlbot.cfg`:
diff --git a/docs/v4/botmaking/input-and-output-data.md b/docs/v4/botmaking/input-and-output-data.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 All supported languages have access to the same data, though syntax and conventions will vary. It is controlled by this specification: [rlbot.fbs](https://github.com/RLBot/RLBot/blob/master/src/main/flatbuffers/rlbot.fbs)
 
 Language-specific guides:
diff --git a/docs/v4/botmaking/jumping-physics.md b/docs/v4/botmaking/jumping-physics.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 # The Physics Of Jumping
 
 There are several forces that can be acting on a Rocket League car at any moment and understanding their influence is an important step towards giving your bot accurate and dependable utilities. This section will be focused on the mechanics of jumping and how these forces interact to allow you to accurately simulate a jump and provide useful information such as how high your bot can reach and at what time they'll get there. So let's get started by first declaring these "_forces_" I've been referring to thus far.
diff --git a/docs/v4/botmaking/machine-learning-faq.md b/docs/v4/botmaking/machine-learning-faq.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 Q: I'm new to ML, where should I start?
 
 A: There are a lot of helpful resources pinned to the #ml-discussion channel of the [RLBot discord](https://discord.gg/S2Y2Kdr). You should also join the [RLGym discord](https://discord.gg/t7xcJnvgfa), which is more specifically for ML.
diff --git a/docs/v4/botmaking/manipulating-game-state.md b/docs/v4/botmaking/manipulating-game-state.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 ## Overview
 
 We have a feature that lets you set exact positions, velocities, etc. for the ball and cars. You may be familiar with [BakkesMod](http://bakkesmod.com/), this is very similar. It won't be enabled during tournaments, but it's very useful when building and debugging your bot.
diff --git a/docs/v4/botmaking/matchcomms.md b/docs/v4/botmaking/matchcomms.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 ## Matchcomms allows communication between participants in a match.
 
 Use cases:
diff --git a/docs/v4/botmaking/quickchat.md b/docs/v4/botmaking/quickchat.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 ## Overview
 
 You can make your bot send quickchat! We support sending all standard quickchats, and also some custom ones! You can find the full list [here](https://github.com/RLBot/RLBot/blob/master/src/main/flatbuffers/rlbot.fbs#L376).
diff --git a/docs/v4/botmaking/rendering.md b/docs/v4/botmaking/rendering.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 # Rendering
 
 An incredibly useful new addition to RLBot v4 is the rendering feature. It allows you to draw objects on screen, which can make debugging and testing your bot so much easier. For example, you could draw the predicted ball path, or draw where the bot wants to go.
diff --git a/docs/v4/botmaking/scripts.md b/docs/v4/botmaking/scripts.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 Sometimes it can be useful to have access to game values, debug rendering or state setting while not being a bot playing within the match. The framework has an easy solution for that - scripts.
 
 Scripts are very similiar to normal bots. They need a config file and a python executable. The config file can be loaded by RLBotGUI like a normal bot - to enable it, just click the checkbox next to its name. The script will be automatically started and terminated by the framework.
diff --git a/docs/v4/botmaking/shooting-the-ball-towards-or-away-from-a-target.md b/docs/v4/botmaking/shooting-the-ball-towards-or-away-from-a-target.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 ## This tutorial is NOT language-specific!
 
 This tutorial is based on the systems used by [VirxERLU](https://github.com/VirxEC/VirxERLU) which is a fork of [GoslingUtils](https://github.com/ddthj/GoslingUtils).
diff --git a/docs/v4/botmaking/team-match-communication-protocol.md b/docs/v4/botmaking/team-match-communication-protocol.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 # TMCP
 
 ## About
diff --git a/docs/v4/botmaking/tick-rate.md b/docs/v4/botmaking/tick-rate.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 Bots have a function like `get_output(packet)` or something similar, depending on language. This gets called some number of times per second, I will refer to this as the tick rate.
 
 There are several factors which influence tick rate:
diff --git a/docs/v4/botmaking/useful-game-values.md b/docs/v4/botmaking/useful-game-values.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 # Useful game values
 
 _If you are making a bot, some of these values are given in FieldInfo. You can find more information on that [here](../input-and-output-data)_.
diff --git a/docs/v4/community/air-show.md b/docs/v4/community/air-show.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 ## Summary
 
 Rocket League, Music, and Programming: It all comes together in the 2021 Rocket League Air Show, hosted by [Rocket Sledge](https://www.youtube.com/channel/UC9t5ff1rz71eC4ZObmq6Yqg)!
diff --git a/docs/v4/community/community-guidelines.md b/docs/v4/community/community-guidelines.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 ## Social Conduct
 
 - No harassment
diff --git a/docs/v4/community/rlbot-pack.md b/docs/v4/community/rlbot-pack.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 # RLBot Pack
 
 The RLBotPack is a repository holding frequently requested bots in one convenient place. The main intended users are people joining the discord looking for a fun bot to try out. It may also be useful as a way for people running streams to get an up-to-date version of your bot.
diff --git a/docs/v4/community/rocket-league-story-mode.md b/docs/v4/community/rocket-league-story-mode.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 ![screenshot](/img/rocket-league-story-mode/screenshot.png)
 
 ## Playing Rocket League Story Mode
diff --git a/docs/v4/community/tips-for-running-tournaments.md b/docs/v4/community/tips-for-running-tournaments.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 ## Announcing the Tournament
 
 Normally tournament organizers will publish some kind of rules document. Google docs has been popular for that so far. Consider including the following:
diff --git a/docs/v4/framework/architecture.md b/docs/v4/framework/architecture.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 ## Startup
 
 ![](/img/architecture/general.png)
diff --git a/docs/v4/framework/console-commands.md b/docs/v4/framework/console-commands.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 ## Sending a Console Command
 
 To send a console command from a python bot, e.g. `Stat FPS`, you would do this:
diff --git a/docs/v4/framework/operating-system-support.md b/docs/v4/framework/operating-system-support.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 ## Windows
 
 RLBot was originally made for Windows, so Windows has the best support. Users are encouraged to watch [this video](https://www.youtube.com/watch?v=oXkbizklI2U) to get started quickly with RLBotGUI!
diff --git a/docs/v4/framework/psyonix-api-notes.md b/docs/v4/framework/psyonix-api-notes.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 Hello everyone! We're proud to announce that the Psyonix bot API has finally been integrated into RLBot! We hope you're just as excited as we are about this milestone! 🎉
 
 ## Details
diff --git a/docs/v4/framework/sockets-specification.md b/docs/v4/framework/sockets-specification.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 Sockets are currently available with Windows and Mac support only. Linux coming soon.
 
 You can use https://github.com/RLBot/RLBot/tree/master/src/main/cpp/RLBotInterface/src as a reference implementation in c++.
diff --git a/docs/v4/framework/supported-programming-languages.md b/docs/v4/framework/supported-programming-languages.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 ## Main Languages
 
 The following list of languages are supported by core developers of the RLBot framework, or have reached a very high level of documentation and support from the community. They are featured on rlbot.org.
diff --git a/docs/v4/index.md b/docs/v4/index.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 # Overview
 
 !!! tip "RLBot v5 is in pre-release!"
diff --git a/docs/v4/miscellaneous/extracting-map-meshes.md b/docs/v4/miscellaneous/extracting-map-meshes.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 ## Prerequisites
 
 - 64-bit Windows
diff --git a/docs/v4/miscellaneous/lan-setup.md b/docs/v4/miscellaneous/lan-setup.md
@@ -1,3 +1,7 @@
+---
+search:
+  boost: 0.5
+---
 
 There are three ways to play with custom bots together with other players. They are:
 
diff --git a/docs/v4/miscellaneous/missing-pages.md b/docs/v4/miscellaneous/missing-pages.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 The following wiki pages are not moved yet:
 
 - [Deploying Changes](https://github.com/RLBot/RLBot/wiki/Deploying-Changes) (maybe this should stay on the github wiki?)
diff --git a/docs/v4/miscellaneous/rlbot-specific-game-settings.md b/docs/v4/miscellaneous/rlbot-specific-game-settings.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 RLBot has the ability to change game settings only when RLBot is active. This can be useful when a different environment is desired for developing or running bots compared to playing the game yourself.
 
 This is achieved by briefly altering *TASystemSettings.ini* as RLBot starts up Rocket League. This feature is currently only available on windows, and for the default *TASystemSettings.ini* location of *%USERPROFILE%\\Documents\\My Games\\Rocket League\\TAGame\\Config*.
diff --git a/docs/v4/miscellaneous/workshop-custom-maps.md b/docs/v4/miscellaneous/workshop-custom-maps.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 ## Automated Solution
 
 RLBot has built in support for custom maps. It allows you to select a folder that has custom map (\`\*.upk) files anywhere in the directory. Once added, you can select any of the custom maps in the directory and play with bots on that map.
diff --git a/docs/v4/troubleshooting/antivirus-notes.md b/docs/v4/troubleshooting/antivirus-notes.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 If RLBotGUI can't open, won't start a match, or acts in other strange ways it may be related to your antivirus software. Do not disable your antivirus.
 
 ### If you suspect your antivirus has broken RLBot:
diff --git a/docs/v4/troubleshooting/installation-errors.md b/docs/v4/troubleshooting/installation-errors.md
@@ -1,3 +1,8 @@
+---
+search:
+  boost: 0.5
+---
+
 # Installation errors
 
 ### You are using a third-party antivirus
diff --git a/docs/v5/framework/remote-rlbot.md b/docs/v5/framework/remote-rlbot.md
@@ -1,11 +1,27 @@
 # Remote RLBot
 
 !!! warning "Automatically starting bots"
-    RLBot can't automatically start bots or scripts on remote machines. You will need to start them manually, using custom software.
-    For this process to work as intended, you should still have `auto_start_bots` set to `false` in RLBot because even though you might be starting the processes automatically, RLBot itself is not. 
+    RLBot can't automatically start bots or scripts on remote machines. You will need to start them manually, or using custom software.
+    If starting the bots manually on a remote machine, set `auto_start_bots` set to `false` in RLBot.
 
-RLBot, by default, listens for TCP connections on `0.0.0.0` (all interfaces) on port `23234`. This port can be changed by launching RLBot and specifying a different port for the first argument. For example, to have RLBot listen on port `12345` instead, you would run `RLBotServer.exe 12345`.
+RLBot, by default, listens for TCP connections on `0.0.0.0` (_all interfaces on IPv4 & IPv6_) on port `23234`.
+This port can be changed by launching RLBot and specifying a different port for the first argument.
+For example, to have RLBot listen on port `12345` instead, you would run `RLBotServer.exe 12345`.
 
 This means that external processes can connect to RLBot from other machines on the same network by specifying the IP address of the machine running RLBot and the port number RLBot is listening on.
+By utilizing RLBot's IPv6 support, you can also connect to RLBot instances running on different networks over the internet, provided that the necessary port forwarding and firewall configurations are in place.
 
-Bots and scripts using RLBot-standard compliant interfaces will read the environment variables `RLBOT_SERVER_IP` and `RLBOT_SERVER_PORT`, which default to `127.0.0.1` and `23234` respectively. You can override these environment variables to point to a different machine running RLBot. They will also expect the environment variable `RLBOT_AGENT_ID` to be set, which can be found by reading the `agent_id` field in `[settings]` header of the corresponding config toml file.
+!!! danger "RLBot on untrusted networks"
+    Exposing RLBot to untrusted networks may pose significant security risks.
+    Malicious actors could exploit currently unknown vulnerabilities in RLBot or the underlying system.
+    It is crucial to implement robust security measures, such as _**running RLBot inside a secure virtual machine**_ and _**restricting network access using firewalls**_, to mitigate potential threats.
+
+Bots and scripts using RLBot-standard compliant interfaces will read the environment variables `RLBOT_SERVER_IP` and `RLBOT_SERVER_PORT`, which default to `127.0.0.1` and `23234` respectively.
+You can override these environment variables to point to a different machine running RLBot.
+They will also expect the environment variable `RLBOT_AGENT_ID` to be set, which can be found by reading the `agent_id` field in `[settings]` header of the corresponding config toml file.
+
+??? info "What does RLBot do with the agent ID?"
+    RLBot uses the given `RLBOT_AGENT_ID` to auto-negotiate which car(s) bots will be able to control - with an incorrect one, the connection will be rejected by RLBot.
+    After the connection is established, bots will only be able to send car inputs for their assigned car and any car inputs sent by scripts will be ignored.
+    This ensures fair matches and prevents bots from interfering with each other in competitive settings.
+    It does NOT prevent extra connections to RLBot from being established and reading game state data, so be cautious about exposing RLBot to untrusted networks.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -38,6 +38,8 @@ theme:
     - navigation.tabs
     # Enable 'Edit this page' button
     - content.action.edit
+    # search will display the likeliest completion for the last word
+    - search.suggest
 
 extra:
   social:
@@ -67,6 +69,7 @@ markdown_extensions:
   - pymdownx.superfences
 
 plugins:
+  - search
   - redirects:
       redirect_maps:
         'index.md': 'v5/index.md'
diff --git a/requirements.txt b/requirements.txt
@@ -1,3 +1,3 @@
 mkdocs==1.6.1
-mkdocs-material==9.6.23
+mkdocs-material==9.7.1
 mkdocs-redirects==1.2.2
