li2058088 / FeverBasketballOpenSource

This project is the open-source of Fever Baksetball environment for research purpose.

Quick Start

1. Clone the project to your computer and install requirements:
$ git clone https://github.com/Anonymous-IJCAI21/FeverBasketballOpenSource.git
$ pip3 install -r requirements.txt

2. Download game clients:

• from Google drive
• from Baidu disk (extraction code: 0163)

3. Run socket server to handle requests of basketball players from game clients:
$ python3 ./server/server_3v3.py to start the server for communication with game clients. There are also several configurations:

• '-f': Run full game mode or 'divide and conquer' mode
• '-m': Use multi-agent mode or single agent mode
• '-a': Choose corresponding algorithm
• '-p': Port to communicate with game clients
• '-l': Log port
• '-t': Test mode

4. Start game client on computer with windows7/8/10 operation system (package for Linux coming soon):
1. cd 'client', unzip 'builtinAI.zip' or 'selfplay.zip' to get game clients for playing with built-in AI or doing selfplay.
2. double-click 'run_3v3_client.bat' to start corresponding 3v3 game (remember to change the ip address to the server's ip first, see Game setting and notice that this command can be run multiple times to launch a number of game clients.)

Adding new algorithms

Put your algorithm in .server/algorithm/method to add your own algorithm. (Please see the dqn.py demo for the interaction APIs.)

Contents

• Game introduction
• Game scenarios and rules
• Game playing
• Game settings
• Game observations
• Game actions
• Benchmarks

Game introduction

Fever Basketball simulates a half-court (length=11.4 meters, width=15 meters) basketball match between two teams. The game includes the most common basketball aspects, such as jump ball, dribble, three-pointer, dunk, rebound, etc. The objective of each team is to score as much as possible to win the match within a limited time.

Game scenarios and rules

We currently offer two packages (the self-play pack and the built-in AI pack) and three modes (1v1, 2v2 and 3v3) for both game playing and training. Within each scenario, there are five positions with various attributes and skills (i.e. C, PF, SF, PG, SG) to be chosen from before a match (see Game setting). Taking the 3v3 match for instance, one player from each team will do the jump ball first at the beginning of each match. The team which gets the ball will be the offense team and the other team will be the defense team. The player holding the ball in the offense team is in the attack state and the other two players are in the assist state. Players in the offense team should use offense strategies (such as screen, fast break, jockey for position, etc.) and shooting manners (such as jump shot, layup, dunk, etc.) to score. For players in the defense team, they should try their best to prevent the offense team from scoring by applying defense strategy like one-on-one check, steals, rejections and so on. Once the ball is out of the hands of the player who possessing it, all of the players will be in freeball state. At such a moment, if players of the defense team manage to fetch the ball, they have to go through an attack-defense switch process named ballclear to regain the possession of the ball by dribbling out of the three-point-line. Generally speaking, a typical match lasts for three minutes (with an average FPS of 60) except for the overtime. We manually extend the length of a match to infinity for the convenience of training purpose. Besides, players who make the shot clock violation (20 seconds) will be punished by handling the ball possession to the opposite team.

Game playing

After having started the server by runing $ python3 ./Manager/run_server.py, you can run the game clinets in different packs to play with the built-in AI or playing with your trained agents. The key is to set the game clinet args '-p' to number in [0, 1, 2] instead of -1 (see Game setting), which means you can control the first/second/third player in the host team (rendered in color).

The mapping of the keyboard is as follows. Notice that the keys map to different actions in different scenes.

• ARROW UP: go up
• ARROW DOWN: go down
• ARROW LEFT: go left
• ARROW RIGHT: go right
• W: dribble / defense
• A: drivein / auto-defense / screen
• S: pass / steal / fetch / request
• D: shoot / block

Benchmarks

Please refer to our paper for more information.