Game Engine for Robot Game
Project description
This is the code from https://github.com/RobotGame/rgkit with minor changes to work in Python 3.
Installing as a package
pip
The easiest way to install the kit is with pip. From the terminal, run:
pip install rgkit-py3
Or if you want the development version:
pip install git+https://github.com/saavedra29/rgkit_py3.git
Note: This will install rgkit system-wide. It is recommended to use virtualenv to manage development environments.
virtualenv
Installing with virtualenv requires the following steps:
mkdir my_robot cd my_robot virtualenv env source env/bin/activate pip install rgkit-py3
setup.py
You can also manually install directly from the source folder. Make a local copy of the git repository or download the source files. Then, using the terminal, run the following from the root directory of the source code:
python setup.py install
Note: This will install rgkit system-wide. It is recommended to use virtualenv to manage development environments.
Running the game
After installing the package, the script is executable from the command line (if you’re using virtualenv, remember to activate the environment). There are two entry points provided: rgrun and rgmap. The general usage of run is:
usage: rgrun [-h] [-m MAP] [-c COUNT] [-A] [-q] [-H | -T | -C] [--game-seed GAME_SEED] [--match-seeds [MATCH_SEEDS [MATCH_SEEDS ...]]] [-r] player1 player2 Robot game execution script. positional arguments: player1 File containing first robot class definition. player2 File containing second robot class definition. optional arguments: -h, --help show this help message and exit -m MAP, --map MAP User-specified map file. -c COUNT, --count COUNT Game count, default: 1, multithreading if >1 -A, --animate Enable animations in rendering. -q, --quiet Quiet execution. -q : suppresses bot stdout -qq: suppresses bot stdout and stderr -qqq: supresses all rgkit and bot output -H, --headless Disable rendering game output. -T, --play-in-thread Separate GUI thread from robot move calculations. -C, --curses Display game in command line using curses. --game-seed GAME_SEED Appended with game countfor per-match seeds. --match-seeds [MATCH_SEEDS [MATCH_SEEDS ...]] Used for random seed of the first matches in order. -r, --random Bots spawn randomly instead of symmetrically.
So, from a directory containing your_robot.py, you can run a game against the default robot and suppress GUI output with the following command:
rgrun -H your_robot.py defaultrobots.py
Developing with source
rgkit_py3 is packaged as a module, but you can just checkout the repository and import/run the source scripts.
./rgkit |--- rgkit | |--- __init__.py | |--- game.py | |--- run.py | |--- ... | |--- your_robot.py |--- setup.py ... /path/your_other_robot.py
Running the game
To run the game with the source configured this way, use the terminal and execute the following from the inner rgkit folder (i.e., in the same directory as run.py):
python run.py your_robot.py /path/your_other_robot.py
Coding your own robots
Once installed, you should only need the rg module to develop your own robots. The package can be imported like any other module:
import rg class Robot: def act(self): return ['guard']
Other Tools
Here are some excellent tools made by fellow players! (working with python2 for now)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file rgkit_py3-1.1.1.tar.gz
.
File metadata
- Download URL: rgkit_py3-1.1.1.tar.gz
- Upload date:
- Size: 34.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.2.0 pkginfo/1.6.1 requests/2.22.0 setuptools/44.0.0 requests-toolbelt/0.9.1 tqdm/4.51.0 CPython/3.8.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5131b2ee75c0988206e40a599ae6986cae8f805766fdabd336d3ec791f532318 |
|
MD5 | f98ae67dbcb141e6733879ac90f8a088 |
|
BLAKE2b-256 | 81793847abef601df8392f727d8adc3ae137751c1e98c6e93539c26e2737b977 |