|
1 | 1 | # RLBot v5 botpack |
2 | 2 |
|
3 | | -A collection of ready-to-use bots made by the community. |
| 3 | +A collection of ready-to-use bots and scripts made by the community. |
| 4 | +The compiled bot pack can be downloaded directly from the [RLBot GUI](https://github.com/RLBot/gui). |
4 | 5 |
|
5 | | -To be a part of the pack, you just need to create a pull request with your bot to this repository. |
| 6 | +## Submission |
| 7 | + |
| 8 | +Everyone is welcome to submit their bot/script to the bot pack. |
| 9 | +Bots/scripts are submodules of this repository. |
| 10 | + |
| 11 | +Requirements |
| 12 | +- **Open source**: Your submission must be open source, and its repository must contain all necessary files and/or only use public dependencies. |
| 13 | +- **bot.toml**: Your submission must have a [`bot.toml`](https://wiki.rlbot.org/v5/botmaking/config-files/#bot-script-config-files) or [`script.toml`](https://wiki.rlbot.org/v5/botmaking/config-files/#bot-script-config-files) with |
| 14 | + - A unique agent id. We strongly recommend the format `<yourname>/<botname>/<version>`, |
| 15 | + - A name, |
| 16 | + - A working run command (an optionally a linux run command), |
| 17 | + - A logo file, and |
| 18 | + - All fields in the details section (description, fun fact, source link, developer, language, tags). |
| 19 | +- **bob.toml**: A properly configured `bob.toml` file which allows our tool [bob](https://github.com/swz-git/bob) to build and package the submission. See the bob repository for further instructions. |
| 20 | +- **Skill Limit**: Your bot must be platinum rank or lower (equal to Element or lower) due to the risk of cheaters taking advantage of your bot. |
| 21 | +- **License (optional)**: Add a [LICENSE](https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository) file for your bot. The license must allow this bot pack to use the code and distribute the submission. If you do not include a LICENSE, the bot pack defaults to the [MIT license](https://license.md/licenses/mit-license/). |
| 22 | + |
| 23 | +After checking the requirements above, make a pull request to this repository that adds your bot as a submodule using `git submodule add <yourgitrepo.git>`. |
| 24 | + |
| 25 | +## License |
| 26 | + |
| 27 | +The submodules in this repository are under the MIT license (see LICENSE), unless the individual submodules specify otherwise. Moreover, the owner of each submodule repository is allowed to change their license at any time as long as the new license still allows the bot pack to use the code and distribute the submission. |
| 28 | + |
| 29 | +The owner of each submodule repository can request that their repository is removed as a submodule at any time. |
6 | 30 |
|
7 | 31 | ## Bob |
8 | 32 |
|
|
0 commit comments