diff --git a/README.md b/README.md index c6ec5e7634a87c61f1001cc08842d51e9e427336..376dbe19a2c380b5867549e24bbaf19f89c26e0a 100644 --- a/README.md +++ b/README.md @@ -20,21 +20,22 @@ Download all the files to convinient folder. # Setup There are a few variables you can change in Godot -You can open the script by clicking like shown in the screenshot: +You can open the script by clicking the script-button as shown in the screenshot: + ## World -Lines: 39-41 -1. human_player: If set to true, you can drive with wasd and brake with space. Otherwise it waits for a client to connect. -2. learn_with_images: Also returns a 60x80 screenshot of the game in every step, if set to true. +The variables are found in lines 39-41. +1. human_player: If set to true, you can drive with wasd and brake with space. Otherwise the Godot-server waits for a client to connect. +2. learn_with_images: In addition to the other information Godot also returns a 60x80 screenshot of the game in every step, if set to true. 3. show_game: If set to false, it won't render the game, but still sends all the information to the client. ## Car -Lines: 5-8 +The variables are found in lines 5-8. 1. brake_str: Can be used to reduce the brake-strength of the car. 2. NUMBER_OF_SENSORS: Determines the number of sensors around the car (Always start at the front and goes clockwise). -3. max_range_sensor: Range of the sensors in pixels (~31 m) -4. range_per_step_sensor: Accuracy of the sensors in pixels (~0.31 m) +3. max_range_sensor: Range of the sensors in pixels (by default ~31 m (1 m = 32 pixels)) +4. range_per_step_sensor: Accuracy of the sensors in pixels (by default ~0.31 m (1 m = 32 pixels)) # Running the Project @@ -46,8 +47,8 @@ Lines: 5-8 ## Python 1. After starting the Project in Godot you can run your own Python programm or the example progamm (main_test) from the files -- Press "Windows"-Key + "R" and type "cmd" -- Type "cd (your rootfolder)/" -- To run the example code type "python main_test.py" + 1. Open the command-console + 2. Type "cd (your rootfolder)/" + 3. To run the example code type "python main_test.py" ___ Created by Midras Lappe and Theo Brockmann