Skip to content

Commit 6741adc

Browse files
authored
Add "Configuring for the v5 botpack" to README.md
1 parent 079b70d commit 6741adc

File tree

1 file changed

+24
-0
lines changed

1 file changed

+24
-0
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,3 +22,27 @@ Example of a Python bot using the RLBot framework
2222

2323
- Bot behavior is controlled by `src/bot.py`
2424
- Bot appearance is controlled by `src/loadout.toml`
25+
26+
## Configuring for the v5 botpack
27+
28+
1. `pip install pyinstaller`
29+
1. `pyinstaller --onefile src/bot.py --paths src`
30+
This will create a file called `bot.spec`.
31+
1. Create `bob.toml` in the same directory as the spec file with the following content:
32+
```toml
33+
[[config]]
34+
project_name = "PythonExample"
35+
bot_configs = ["src/bot.toml"]
36+
37+
[config.builder_config]
38+
builder_type = "pyinstaller"
39+
entry_file = "bot.spec"
40+
```
41+
42+
- `project_name` will be the name of your bot's folder in the botpack
43+
- `bot_configs` is a list of bot configs that will be included in the botpack
44+
- `builder_type` should always be `pyinstaller`
45+
- `entry_file` is the name of the spec file
46+
47+
1. Commit both `bot.spec` and `bob.toml` to your bot's repository.
48+
Note that `bob.toml` CANNOT be renamed, but `bot.spec` can be anything as long as `entry_file` is also renamed to reflect the change.

0 commit comments

Comments
 (0)