Add Rider debug notes, remove references to port.cfg

TangilJ · TangilJ · commit 595e10d5ac64 · 2021-03-07T15:21:15.000Z
diff --git a/CSharpBot/Bot/Program.cs b/CSharpBot/Bot/Program.cs
@@ -14,16 +14,24 @@ static void Main(string[] args)
             }
             catch (Exception e)
             {
-                // If you're trying to run in a debugger, look up the port number used in PythonAgent.py
-                // Right-click the project, choose Properties, go to the Debugging section -- there is a box for "Command Arguments", enter the port there.
+                // If you're trying to run in a debugger, look up the port number used in PythonAgent.py in get_port()
+
+                // If you're using Visual Studio:
+                // Right-click the project, choose Properties, go to the Debug section -- there is a box for
+                // "Command line arguments", enter the port there.
+
+                // If you're using Rider:
+                // Click the configuration dropdown to the left of the Run and Debug buttons (top right of the window),
+                // choose Edit Configurations -- there is a box for "Program arguments", enter the port there.
+
                 // Example: 45031
                 Console.WriteLine("Could not get port from arguments to CSharp bot!");
                 throw e;
             }
 
             RLBotDotNet.BotManager<Bot> botManager = new RLBotDotNet.BotManager<Bot>(0);
-            // Start the server on the port given in the port.cfg file.
+            // Start the server on the port given in the first argument
             botManager.Start(port);
         }
     }
-}
+}
diff --git a/PythonAgent/PythonAgent.py b/PythonAgent/PythonAgent.py
@@ -5,7 +5,7 @@
 
 class DotNetBot(ExecutableWithSocketAgent):
     def get_port(self) -> int:
-        return 45031  # Should match port.cfg in the C# area
+        return 45031  # The port given to the executable in the program arguments
 
     def load_config(self, config_header: ConfigHeader):
         self.executable_path = config_header.getpath('executable_path')

Original file line number	Diff line number	Diff line change
`@@ -14,16 +14,24 @@ static void Main(string[] args)`
`14`	`14`	`}`
`15`	`15`	`catch (Exception e)`
`16`	`16`	`{`
`17`		`- // If you're trying to run in a debugger, look up the port number used in PythonAgent.py`
`18`		`- // Right-click the project, choose Properties, go to the Debugging section -- there is a box for "Command Arguments", enter the port there.`
	`17`	`+ // If you're trying to run in a debugger, look up the port number used in PythonAgent.py in get_port()`
	`18`	`+`
	`19`	`+ // If you're using Visual Studio:`
	`20`	`+ // Right-click the project, choose Properties, go to the Debug section -- there is a box for`
	`21`	`+ // "Command line arguments", enter the port there.`
	`22`	`+`
	`23`	`+ // If you're using Rider:`
	`24`	`+ // Click the configuration dropdown to the left of the Run and Debug buttons (top right of the window),`
	`25`	`+ // choose Edit Configurations -- there is a box for "Program arguments", enter the port there.`
	`26`	`+`
`19`	`27`	`// Example: 45031`
`20`	`28`	`Console.WriteLine("Could not get port from arguments to CSharp bot!");`
`21`	`29`	`throw e;`
`22`	`30`	`}`
`23`	`31`
`24`	`32`	`RLBotDotNet.BotManager<Bot> botManager = new RLBotDotNet.BotManager<Bot>(0);`
`25`		`- // Start the server on the port given in the port.cfg file.`
	`33`	`+ // Start the server on the port given in the first argument`
`26`	`34`	`botManager.Start(port);`
`27`	`35`	`}`
`28`	`36`	`}`
`29`		`-}`
	`37`	`+}`