https://github.com/rlbot/trackandfield

https://github.com/rlbot/trackandfield

Last synced: 7 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/rlbot/trackandfield
• Owner: RLBot
• License: mit
• Created: 2021-11-27T23:39:41.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2021-12-09T21:24:53.000Z (almost 3 years ago)
• Last Synced: 2023-03-02T21:06:00.451Z (over 1 year ago)
• Language: Python
• Size: 67.4 KB
• Stars: 1
• Watchers: 9
• Forks: 4
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RLBot Track and Field

This is a script that facilitates track and field style events

for Rocket League bots, e.g. waypoint races, shotput, etc.

It uses the [Scripts system](https://github.com/RLBot/RLBot/wiki/Scripts)

and [Matchcomms](https://github.com/RLBot/RLBot/wiki/Matchcomms).

## Usage

Track and Field relies on RLBotGUI.

1. Clone this repository

2. Open RLBotGUI, and in that interface:

   1. Add -> Load Folder

   2. Choose the folder where this code lives

   3. In the "Scripts" section, toggle on "Track and Field".

   4. If there's a yellow triangle, click it and install dependencies.

   5. Choose bots to compete, drag them on to any team.

   6. Start the match

3. Expect the match to start, and the bots to de-spawn during kickoff.

4. Follow instructions that will appear in-game.

Event progress is saved in a file at ./data/current_competition.json,

and and additional files in subfolders.

- You can resume an event by re-running the match through RLBotGUI

- If you want to start a new event, you must move or rename current_competition.json.

## Making Bots to Compete

To compete in Track and Field, a bot must support

[Matchcomms](https://github.com/RLBot/RLBot/wiki/Matchcomms).

- Upon startup, the bot should send a message to matchcomms in this format:

`{ "readyForTrackAndField": True, "supportedEvents": ["WaypointRace", "etc"] }`

- The bot will then need to listen for message(s) from matchcomms regarding

the event they're participating in.

Each python file in the 'events' folder has specific documentation on

the message(s) it sends and how a bot is expected to behave.

## Contributing new events to Track and Field

Pull requests are welcome!

Create a new class in the 'events' folder, as a subclass of `Event`

(see event.py). You may find it convenient to copy-paste waypoint_race.py

and modify it to create your new event.

To start using your event, modify the `get_event_list` function in

track_and_field.py.