Ktanks is a game for software developers. Multiple tanks controlled are by software and fight until only one survive or after a configurable number of round (ticks). In the last case the one with less damages wins the game. Tanks can move back and forward. Controlling software can turn tank, turret/cannon and radar. At the center of simulated world there is power source that charges tanks but if a tank is too far this tank looses energy proportionally with the distance from the power source.
- Tank software can be written in any language thanks to client-server architecture.
- Graphical UI for easier debugging.
- Server-client communication based on TCP stream or UDP packet
- Download and install following the instruction from releases page.
- Open a shell and run server:
ktanks_server.exe 2 - Open two other shell where run
dumb_robot.py <tank_name>(inexamples.zip)
Run krobots server
USAGE:
ktanks_server.exe [OPTIONS] <NUM_TANKS>
ARGS:
<NUM_TANKS> How many tanks in this game
OPTIONS:
--configuration-file <CONFIGURATION_FILE>
Tank client communication protocol. udp is faster but it has issue with NAT and firewall
-d, --debug-mode
Simulator stop waiting for command from tank client
--graphics-scaling-factor <GRAPHICS_SCALING_FACTOR>
Scaling factor of ui graphics compared to physical simulation dimension. Increment teh
value to see bigger graphics compared to physical collider [default: 0.15]
-h, --help
Print help information
-l, --log-level <LOG_LEVEL>
[default: info] [possible values: error, warn, info, debug, trace]
-m, --max-steps <MAX_STEPS>
Max number of simulation step. If 0 no end until only one survived [default: 0]
--max-num-remote-gui <MAX_NUM_REMOTE_GUI>
Maximum number supported of remote GUI Effective only if --no_gui is used [default: 1]
--no-gui
Headless server When specified server will not show any ui but it expect a connection
from ui_client
-p, --port <PORT>
Port used to register new tanks [default: 55230]
--remote-gui-port <REMOTE_GUI_PORT>
Remote gui client port. Effective only if --no_gui is used [default: 3042]
--sim-step-rate <SIM_STEP_RATE>
Simulation step x sec. This has no relation with ui frame rate [default: 60.0]
--tank-client-protocol <TANK_CLIENT_PROTOCOL>
Tank client communication protocol. udp is faster but it has issue with NAT and firewall
[default: tcp] [possible values: tcp, udp]
-V, --version
Print version informationAfter the launch server wait the connection of client until reaching the defined number of registered client.
To each client it is assigned the successive port starting from the one defined by -p option.
Important Make sure that registration port and the successive until registration port + NUM_TANKS are available. In case server is executed behind a firewall or NAT open make sure to open the used port.
The simulation is terminated when only one tank survive or reached the number of steps specified by --max-steps. Simulation can be terminated any time using Ctrl-q. When simulation is terminated file named simulation_output.csv is saved in the current working directory with data of tanks.
UI is mainly intended to support debugging of tank controlling software.
- Esc: exit
- w,a,s,d: move camera
- e: zoom in
- q: zoom out
- t: Camera tracks selected tank
This represent radar detection area.
The picture body is bigger than the actual body used by physical simulation. For this reason user can be surprised to see a cannot bullet go through the body with damaging the body. Physical tank and turret body are visible by zooming greatly and they are displayed as red empty rectangles. Tank physical body has 7.0 m length and 3.0 m width.
Red circle represent the limit of tank power source. Beyond this limit the energy of the tank decrease linearly with the distance. If the tank is within the circle the tank energy is increased inversely with the distance from the center.
Presently the simulation is synchronized with refresh rate of graphic card/monitor. So the simulation real time speed depends on monitor and graphic card settings.
One simulated sec is 60 ticks or simulation step and for each graphic frame a simulation step is executed. So if monitor refresh rate is 30 frames/sec a simulated sec is equivalent to 2 real time sec.
Angle are always in radians in the range of ]-PI,PI].
PI/2
|
|
|
|
|
|
-PI -------------------------- 0
|
|
|
|
|
-PI/2
Tank body can rotate, move forward and backward. Developer can set the fraction [-1.0,1.0] of maximum power allowed to move forward (positive value) and backward (negative value). Also to rotate the tank, developer can set a fraction of maximum allowed power to rotate counterclockwise (positive value) or clockwise (negative value). See server interface library for more details.
Tank body has a mass so an inertia this means that setting power to 0.0 doesn't stop immediately the tank. Due to the fact user set power, acceleration decrease with speed for a fixed power settings.
Developer can set angle of cannon referred to the tank. Cannon doesn't move instantaneously. Position of cannon can be read by getting TankStatus data structure. The speed of edge of cannon is added to the bullet when firing; therefore cannon and tank speed affects the direction and speed of bullet.
Speed and max range of bullets can be read using SimulationConfig data structure.
Cannon has temperature properties (cannon temperature is stored in TankStatus). If cannon temperature is >320 degrees it can not fire. For each cannon file the temperature is increased by 100 degrees and it is decremented at each simulation step by 2 degrees. Minimum cannon temperature is 20 degrees.
Tank consumes energy when:
- Radar operation
- Moving tank body
- Firing cannon
Tank is recharged at every simulation step by a quantity that is inversely proportional with the distance from
the power source. Power source is at the center of game field and its distance and direction can be read by getting TankStatus data structure. When tank is beyond the zero_power_limit energy of tank is decreased proportionally with the distance from power source. zero_power_limit distance is stored in SimulationConfig structure.
Note Radar has priority in power consumption compared to the other operation.
Tank is damaged when hit by a bullet. When damage is greater than damage_max, tank is no longer able to move, fire or using radar. damage_max is stored in SimulationConfig structure.
Presently only a python library is provided to communicate with server.
Python library and examples are available documentation
Game server doesn't wait for command from tanks client but this doesn't allow to use breakpoint and stop client program to inspect variables and execute step by step client code.
In order to overcome this limitation it his possible to run game server in debug mode by using option --debug-mode. When server runs in this mode, it wait for command from client.
It is possible to run server in headless mode
ktanks_server.exe --no-gui 10When server run in this mode it is possible to use ui_client.exe to connect to the server and show tank position.
ui_client.exe 127.0.0.1USAGE:
ui_client.exe [OPTIONS] [ARGS]
ARGS:
<IP> ipv4 address [default: 127.0.0.1]
<PORT> [default: 3042]
OPTIONS:
-h, --help Print help information
-l, --log-level <LOG_LEVEL> [default: info] [possible values: error, warn, info, debug,
trace]
-V, --version Print version informationTank .png pictures are from Robocode project Tank icon Tank icon
