refactor start scripts and binaries for improved clarity and functionality

Author: naderzare

README.md

@@ -1,11 +1,13 @@
-# Sample Python Base Code (gRPC)
+# PY2D Soccer Simulation Base Code
 
 [![Documentation Status](https://readthedocs.org/projects/clsframework/badge/?version=latest)](https://clsframework.github.io/docs/introduction/)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-This repository contains a sample decision-making server for the RoboCup 2D Soccer Simulation, which allows you to create a team by using Python. This server is compatible with the [Cross Language Soccer Framework](https://arxiv.org/pdf/2406.05621). This server is written in Python and uses gRPC to communicate with the [proxy](https://github.com/CLSFramework/soccer-simulation-proxy).
-
-The Soccer Simulation Server sends the observations to the proxy, which processes the data, create state message and sends it to the decision-making server. The decision-making server then sends the actions to the proxy, and then the proxy convert actions to the server commands and sends them to the server.
+![alt text](image.png)
+PY2D Soccer Simulation Base Code is a base code for RoboCup 2D Soccer Simulation teams, which is written in Python.
+This base code is powered by the [Cross Language Soccer Framework](https://arxiv.org/pdf/2406.05621), which allows you to create a team by using any programming language that supports gRPC or Thrift.
+This base code uses `Helios Base` as a proxy to communicate with the RoboCup 2D Soccer Simulation server.
+PY2D base is the most power full base code for RoboCup 2D Soccer Simulation which developed in Python.
 
 For more information, please refer to the [documentation](https://clsframework.github.io/).
 
@@ -24,8 +26,8 @@ sudo apt-get install fuse #Used to run AppImages
 Clone this repository & install the required python libraries (such as gRPC). Don't forget to activate your virtual environment!
 
 ``` Bash
-git clone https://github.com/CLSFramework/sample-playmaker-server-python-grpc.git
-cd sample-playmaker-server-python-grpc
+git clone https://github.com/CLSFramework/py2d.git
+cd py2d
 # Activate venv/anaconda before this step!
 pip install -r requirements.txt
 
@@ -63,7 +65,9 @@ cd scripts/rcssserver
 Then we must run the proxy & the decisionmaking server:
 
 ``` Bash
-./start-team.sh
+./start.sh
+// or
+python3 start.py
 ```
 
 ### Options

image.png

@@ -24,21 +24,22 @@ cp -r ../src/formations binary/src/formations
 
 # create binary
 
-nuitka --standalone --onefile --output-dir=binary ../start_agent.py
+nuitka --standalone --onefile --output-dir=binary ../start.py
 
 # remove build directory
 
-rm -rf binary/start_agent.build
-rm -rf binary/start_agent.dist
-rm -rf binary/start_agent.onefile-build
+rm -rf binary/start.build
+rm -rf binary/start.dist
+rm -rf binary/start.onefile-build
 
-# copy start_agents.sh to binary directory
+# copy start.sh to binary directory
 
-cp ../start_agents.sh binary/start_agents.sh
+cp ../start.sh binary/start.sh
 
-# change all `python3 start_agent.py`` to ./start_agent.bin in binary/start_agents.sh
+# change start.sh to run binary instead of python and to use separate rpc server
 
-sed -i 's/run_bin=false/run_bin=true/g' binary/start_agents.sh
+sed -i 's/run_bin=false/run_bin=true/g' binary/start.sh
+sed -i 's/separate_rpc_server=false/separate_rpc_server=true/g' binary/start.sh
 
 # copy start to binary directory
 

scripts/create_binary.sh

@@ -12,12 +12,12 @@ options="--team_name $teamname --server-host $HOST --use-random-port --close-ser
 
 case $NUM in
     1)
-        ./start_agent.bin $options --goalie
+        ./start.bin $options --goalie
         ;;
     12)
-        ./start_agent.bin $options --coach
+        ./start.bin $options --coach
         ;;
     *)
-        ./start_agent.bin $options
+        ./start.bin $options --player
         ;;
 esac

scripts/start

@@ -11,17 +11,17 @@
 from server import main
 import random
 
-
 # Set up logging
 log_dir = None
 start_team_logger = None
 
-
 def run_server_script(args):
     # Define a wrapper function to pass the arguments to the main function
     def server_main():
         import sys
-        sys.argv = ['server.py', '--rpc-port', str(args.rpc_port), '--log-dir', log_dir, '--disable-log-file' if args.disable_log_file else '']
+        sys.argv = ['server.py', '--rpc-port', str(args.rpc_port), '--log-dir', log_dir]
+        if args.disable_log_file:
+            sys.argv += ['--disable-log-file']
         main()
 
     # Start the main function as a new process
@@ -31,12 +31,18 @@ def server_main():
 
 def run_start_script(args):
     # Start the start.sh script in its own directory as a new process group
-    process = subprocess.Popen(
-        ['bash', 'start-agent.sh' if not args.debug else 'start-debug.sh', 
-         '-t', args.team_name, 
+    arguments = ['bash']
+    if args.player or args.coach or args.goalie:
+        arguments += ['start-agent.sh', '--coach' if args.coach else '--goalie' if args.goalie else '--player']
+    else:
+        arguments += ['start.sh' if not args.debug else 'start-debug.sh']
+        
+    arguments += ['-t', args.team_name, 
          '--rpc-port', args.rpc_port, '--rpc-type', 'grpc', 
-         '-p', args.server_port, '-h', args.server_host,
-         '--coach' if args.coach else '--goalie' if args.goalie else '--player'],
+         '-p', args.server_port, '-h', args.server_host]
+        
+    process = subprocess.Popen(
+        arguments,
         cwd='scripts/proxy',  # Corrected directory to where start.sh is located
         preexec_fn=os.setsid,  # Create a new session and set the process group ID
         stdout=subprocess.PIPE,
@@ -46,7 +52,6 @@ def run_start_script(args):
 
 stop_thread = threading.Event()
 
-
 def stream_output_to_file(process, name, args):
     # Stream output from the process and log it to a file with the given name
     f = None if args.disable_log_file else open(f"{log_dir}/{name}.log", "a")
@@ -88,6 +93,7 @@ def kill_rpc_server_process(process):
     parser.add_argument('--server-host', required=False, help='The host of the server', default='localhost')
     parser.add_argument('--server-port', required=False, help='The port of the server', default='6000')
     parser.add_argument('--close-server', required=False, help='Close the server', default=False, action='store_true')
+    parser.add_argument('--player', required=False, help='Use coach instead of proxy', default=False, action='store_true')
     parser.add_argument('--coach', required=False, help='Use coach instead of proxy', default=False, action='store_true')
     parser.add_argument('--goalie', required=False, help='Use goalie instead of proxy', default=False, action='store_true')
     parser.add_argument('--disable-log-file', required=False, help='Disable logging to a file', default=False, action='store_true')
@@ -99,9 +105,8 @@ def kill_rpc_server_process(process):
         log_dir = os.path.join(os.getcwd(), 'logs', f"{datetime.datetime.now().strftime('%Y-%m-%d_%H-%M-%S')}_{random.randint(100000, 999999)}")
     else:
         log_dir = args.log_dir
-    start_team_logger = setup_logger('start-team', log_dir, console_level=logging.DEBUG, file_level=logging.DEBUG if not args.disable_log_file else None,
-                                     console_format_str='%(message)s')
-    
+    start_team_logger = setup_logger('start-team', log_dir, console_level=logging.DEBUG, file_level=logging.DEBUG if not args.disable_log_file else None, console_format_str='%(message)s')
+
     start_team_logger.debug(f"Arguments: {args=}")
 
     try:

scripts/start_agents.sh

@@ -6,6 +6,7 @@ server_host=127.0.0.1
 server_port=6000
 disable_log_file=false
 run_bin=false
+separate_rpc_server=false
 
 while [ $# -gt 0 ]
 do
@@ -24,6 +25,9 @@ do
     --run-bin)
       run_bin=true
       ;;
+    --separate-rpc-server)
+      separate_rpc_server=true
+      ;;
     *)
       echo 1>&2
       echo "invalid option \"${1}\"." 1>&2
@@ -65,28 +69,33 @@ else
   options="$options --disable-log-file"
 fi
 
-# Run start_agent.py or start_agent.bin
+# Run start.py or start.bin
 if [ $run_bin = true ]; then
-  run_command="./start_agent.bin"
+  run_command="./start.bin"
 else
   # active .venv
   source $python_env
-  run_command="python3 start_agent.py"
+  run_command="python3 start.py"
 fi
 
-# Run start_agent.py 11 times and store each PID in the array
-$run_command $options --goalie &
-pids+=($!)
+if [ $separate_rpc_server = true ]; then
+  # Run start_agent.py 11 times and store each PID in the array
+  $run_command $options --goalie &
+  pids+=($!)
 
-sleep 2
+  sleep 2
 
-for i in {2..11}; do
+  for i in {2..11}; do
+    $run_command $options --player &
+    pids+=($!)
+  done
+
+  $run_command $options --coach &
+  pids+=($!)
+else
   $run_command $options &
   pids+=($!)
-done
-
-$run_command $options --coach &
-pids+=($!)
+fi
 
 # Wait for all background processes to finish
 for pid in "${pids[@]}"; do