Update README.md for clarity on running the game and agent setup; add instructions for separate RPC server execution and binary creation process; modify requirements.txt to include Nuitka; add sleep in start.py for improved timing

Author: naderzare

README.md

@@ -57,7 +57,7 @@ Finally, to watch the game, download the monitor from [the original repository](
 
 ### Running a game
 
-This section assumes you have installed the server & proxy using the scripts (as mentioned above).
+This section assumes you have download (installed) the server & proxy using the scripts (as mentioned above).
 
 To run a game, you must first run the RoboCup Soccer Server, then your team and opponent team, and finally the monitor.
 
@@ -97,7 +97,7 @@ To watch the game, you must run the rcssmonitor or soccerwindow2. press <kbd>Ctr
 
 ### start.py Arguments
 
-##### Team and Name Customization
+| Team and Name Customization
 
 | Argument                  | Short | Description                                                      | Default Value   |
 |---------------------------|-------|------------------------------------------------------------------|-----------------|
@@ -106,7 +106,7 @@ To watch the game, you must run the rcssmonitor or soccerwindow2. press <kbd>Ctr
 
 ---
 
-##### RPC Server Configuration
+| RPC Server Configuration
 
 | Argument                  | Short | Description                                                      | Default Value   |
 |---------------------------|-------|------------------------------------------------------------------|-----------------|
@@ -117,7 +117,7 @@ To watch the game, you must run the rcssmonitor or soccerwindow2. press <kbd>Ctr
 
 ---
 
-##### RoboCup Soccer Server Configuration
+| RoboCup Soccer Server Configuration
 
 | Argument                  | Short | Description                                                      | Default Value   |
 |---------------------------|-------|------------------------------------------------------------------|-----------------|
@@ -126,7 +126,7 @@ To watch the game, you must run the rcssmonitor or soccerwindow2. press <kbd>Ctr
 
 ---
 
-##### Agent Proxies
+| Agent Proxies
 
 | Argument                  | Short | Description                                                      | Default Value   |
 |---------------------------|-------|------------------------------------------------------------------|-----------------|
@@ -137,7 +137,7 @@ To watch the game, you must run the rcssmonitor or soccerwindow2. press <kbd>Ctr
 
 ---
 
-##### Debug and Logging Options
+| Debug and Logging Options
 
 | Argument                  | Short | Description                                                      | Default Value   |
 |---------------------------|-------|------------------------------------------------------------------|-----------------|
@@ -185,11 +185,70 @@ As seen in the figure, the proxy handles connecting to the server, receiving sen
 
 ## Other Solutions To Run The Base Code
 
-TODO
+### Running the base code with different rpc port
+
+In soccer simulation 2D games (official competitions), each agents (players and coach) should be run in a separate process. So, you need to connect each agent to a rpc server (each agent has a separate rpc server). In this case, you need to run the rpc server for each agent separately. You can use the following commands to run the rpc server for each agent for debugging purposes.
+
+| Note: For official competitions, tournament script will run each player/coach with separate command, so it will be like the next section, but the result will be the same as this section because the rpc server will be run for each agent separately.
+
+``` Bash
+python3 start.py --use-different-rpc-port
+// or
+./start.sh --use-different-rpc-port
+```
+
+### Running each agent and server separately
+
+In soccer simulation 2D games (official competitions), each agents (players and coach) should be run in a separate process. So, you need to connect each agent to a rpc server (each agent has a separate rpc server). You can use the following commands to run each agent and rpc server separately.
+
+``` Bash
+python3 start.py --goalie
+python3 start.py --player (you need to run this command 11 times)
+python3 start.py --coach
+// or
+./start.sh --goalie
+./start.sh --player (you need to run this command 11 times)
+./start.sh --coach
+```
+
+### Running the rpc server and proxy separately
+
+To run the rpc server and proxy separately, you can use the following commands.
+
+``` Bash
+python3 server.py
+cd scripts/proxy
+./start.sh --rpc-type=grpc
+```
 
 ## Create Binary
 
-TODO
+As you know python is an interpreted language and it is slow in comparison to C++. In official tournaments, an agent should send actions to the server in less than 100ms. Also, python may not be installed on the tournament server. So, you need to create a binary from your python code. You can use the following commands to create a binary from your python code.
+
+``` Bash
+cd scripts
+./create_binary.sh
+```
+
+After creating the binary, you can find it in the `scripts/binary` directory. In this directory, you can find the following files and directories:
+
+- `start.bin`: The binary file that behaves like the `start.py` script. So, by running this file, you can run one rpc server and 12 proxy agents (11 players and 1 coach).
+- `start`: The tournament script will run this file to run your team in the tournament. This file will run one agent and one rpc server on random port.
+- `startAll`: This script is available for testing purposes. By running this file, it will call the `start` file 12 times to run 12 agents and 12 rpc servers.
+- `scripts`: This directory contains the necessary files to run the proxy.
+- `src`: This directory contains the formations of your team.
+
+## How to debug your team
+
+There are three different solution for debugging your team:
+
+### Logging
+
+You can use the logging module to log the information in rpc server code. By default, the logs are stored in the `logs` directory. For example, `agentX_Y.log` is the log file for the agent with unum `X` and `Y` is the unique id of the agent in rpc server (This one is not important for you). `proxy.log` is the log file for the proxy for all agents. `start-team.log` is the log file for the `start.py` script.
+
+### Debug Mode
+
+If you enable the debug mode, the proxy agents will be run in debug mode, so you can check graphical logs in `soccerwindow2` application. You can use `message Log` or `message DebugClient` to send the debug information to the proxy and then proxy will save them in file or send them directly to the `soccerwindow2` application to show them in the graphical interface. For more information, you can check the [IDL section in the documentation](https://clsframework.github.io/docs/idl/protobuf).
 
 ## Test Performance by using AutoTest
 

requirements.txt

@@ -1,4 +1,5 @@
 grpcio==1.65.4
 grpcio-tools==1.65.4
 scipy==1.14.1
-pyrusgeom==0.1.2
+pyrusgeom==0.1.2
+Nuitka==2.5

start.py

@@ -10,6 +10,7 @@
 from server import main
 import random
 import select
+import time
 
 
 # Set up logging
@@ -175,6 +176,7 @@ def signal_handler(sig, frame):
                 args.player = False
                 if i == 0:
                     args.goalie = True
+                    time.sleep(1)
                 elif i == 12:
                     args.coach = True
                 else: