2024-08-08T0639Z

Author: Windows81

README.md

@@ -80,45 +80,49 @@ Game-specific options are specified in the `--config_path` argument, which defau
 | ---------------------- | ------------ | ------------------- |
 | `--config_path`, `-cp` | `int`        | `./GameConfig.toml` |
 | `--rcc_port`, `-rp`    | `int`        | 2005                |
-| `--web_port`, `-wp`    | `int`        | 2006                |
+| `--web_port`, `-wp`    | `int`        | 2005                |
 | `--run_client`, `-rc`  | `store_true` | N/A                 |
 | `--skip_rcc`           | `store_true` | N/A                 |
 | `--skip_rcc_popen`     | `store_true` | N/A                 |
 | `--skip_web`           | `store_true` | N/A                 |
 
 ### `player`
 
-| Option              | Type  | Default |
-| ------------------- | ----- | ------- |
-| `--rcc_host`, `-rh` | `str` | None    |
-| `--rcc_port`, `-rp` | `int` | 2005    |
-| `--web_host`, `-wh` | `str` | N/A     |
-| `--web_port`, `-wp` | `int` | 2006    |
-| `--user_code`, `-u` | `str` | N/A     |
+| Option                    | Type  | Default |
+| ------------------------- | ----- | ------- |
+| `--rcc_host`, `-rh`, `-h` | `str` | None    |
+| `--rcc_port`, `-rp`, `-p` | `int` | 2005    |
+| `--web_host`, `-wh`       | `str` | N/A     |
+| `--web_port`, `-wp`       | `int` | 2005    |
+| `--user_code`, `-u`       | `str` | N/A     |
 
 ### Misc.
 
 Command syntaxes for `studio` and `download` also exists, but haven't been adequately documented yet.
 
 ## Network Ports in Use
 
-Anyone can host a server and must leave **two** network ports of their choice accessible.
+**To keep it simple: just open port 2005 on both TCP and UDP.**
+
+Anyone can host a server and must leave _both a TCP and UDP network port_ of their choice accessible.
+
+It's possible to connect to a webserver and an RCC server from different hosts. However, I wouldn't recommend it.
 
 ### RCC (UDP)
 
-RCC is an acronym for 'Rōblox Cloud Compute', which is the `exe` program we use to run the Rōblox servers. It leaves one (maybe two) relevant port open.
+RCC is an acronym for 'Rōblox Cloud Compute', which is the `exe` program we use to run the Rōblox servers. The UDP-based protocol it communicated with built under [RakNet](http://www.raknet.com/).
 
 Host is specified by the `--rcc_host` or `-rh` option.
 
-Port is specified by the `--rcc_port` or `-rp` option **(defaults to 2005)**.
+Port is specified by the `--rcc_port` or `-rp` option.
 
 ### Webserver (HTTPS)
 
 The webserver is responsible for facilitating player connections and loading in-game assets.
 
 Host is optionally specified by the `--webserver_host` or `-wh` option, in case RCC is hosted elsewhere.
 
-Port is specified by the `--webserver_port` or `-wp` option **(defaults to 2006)**.
+Port is specified by the `--webserver_port` or `-wp` option.
 
 ## Studio?
 
@@ -156,13 +160,13 @@ Where `...` is [your command-line prefix](#installation),
 ### Server
 
 ```shell
-... server -rp 2005 -wp 2006 --config ./GameConfig.toml
+... server -rp 2005 --config ./GameConfig.toml
 ```
 
 ### Player
 
 ```shell
-... player -rh 172.88.194.43 -rp 2005 -wp 2006
+... player -rh 172.88.194.43 -rp 2005
 ```
 
 ## Config File Structure

ReleaseNewVersion.ps1

@@ -59,4 +59,4 @@ UpdateAndPush
 CreateBinary
 CreateZippedDirs
 
-gh release create "$commit_name" --notes "" --title "$release_name" $files -p
+gh release create "$release_name" --notes "" $files -p

Source/launcher/__init__.py

@@ -2,7 +2,6 @@
     download,
     player,
     server,
-    studio,
 )
 
 from .subparsers.args_aux import (

Source/launcher/routines/_logic.py

@@ -52,14 +52,11 @@ def get_app_base_url(self) -> str:
 
 
 class bin_ssl_arg_type(bin_arg_type):
-    web_host: str | None = None
-    web_port: web_server_logic.port_typ = web_server_logic.port_typ(
-        port_num=80,
-        is_ssl=True,
-        is_ipv6=False,
-    )
+    web_host: str
+    web_port: web_server_logic.port_typ
 
     def send_request(self, path: str, timeout: float = 7) -> http.client.HTTPResponse:
+        assert self.web_port.port_num is not None
         try:
             return urllib.request.urlopen(
                 f'{self.get_base_url()}{path}',
@@ -74,24 +71,21 @@ def send_request(self, path: str, timeout: float = 7) -> http.client.HTTPRespons
 
 
 class host_arg_type(arg_type):
-    rcc_host: str | None = None
-    rcc_port_num: int = 2005
-
-    web_host: str | None = None
-    web_port: web_server_logic.port_typ = web_server_logic.port_typ(
-        port_num=80,
-        is_ssl=False,
-        is_ipv6=False,
-    ),  # type: ignore
+    rcc_host: str
+    rcc_port_num: int
+
+    web_host: str
+    web_port: web_server_logic.port_typ
     user_code: str | None = None
     launch_delay: float = 0
 
     def sanitise(self) -> None:
         super().sanitise()
 
-        self.web_host, self.rcc_host = \
-            self.web_host or self.rcc_host or 'localhost', \
-            self.rcc_host or self.web_host or 'localhost'
+        if self.rcc_host == 'localhost':
+            self.rcc_host = '127.0.0.1'
+        elif ':' in self.rcc_host:
+            self.rcc_host = f'[{self.rcc_host}]'
 
         if self.rcc_host == 'localhost':
             self.rcc_host = '127.0.0.1'
@@ -103,7 +97,6 @@ def sanitise(self) -> None:
             self.web_host = self.app_host = '127.0.0.1'
 
         elif self.web_host and ':' in self.web_host:
-
             # The ".ipv6-literal.net" replacement only works on Windows and might not translate well on Wine.
             # It's strictly necessary for 2021E because some CoreGUI stuff will crash if the BaseUrl doesn't have a dot in it.
             unc_ip_str = self.web_host.replace(':', '-')

Source/launcher/routines/clear_appdata.py

@@ -1,6 +1,3 @@
-import web_server._logic as web_server_logic
-import web_server as web_server
-
 from . import _logic as logic
 import dataclasses
 import threading

Source/launcher/routines/player.py

@@ -1,6 +1,4 @@
 import web_server._logic as web_server_logic
-import web_server as web_server
-
 from . import _logic as logic
 import urllib.request
 import util.resource
@@ -74,14 +72,10 @@ def process(self) -> None:
 class arg_type(logic.bin_ssl_arg_type, logic.host_arg_type):
     obj_type = obj_type
 
-    rcc_host: str = 'localhost'
-    rcc_port_num: int = 2005
-    web_host: str | None = None
-    web_port: web_server_logic.port_typ = web_server_logic.port_typ(
-        port_num=80,
-        is_ssl=False,
-        is_ipv6=False,
-    ),  # type: ignore
+    rcc_host: str
+    rcc_port_num: int
+    web_host: str
+    web_port: web_server_logic.port_typ
     user_code: str | None = None
     launch_delay: float = 0
 
@@ -91,7 +85,7 @@ def finalise_user_code(self) -> None:
         it needs to be executed after `launch_delay` seconds.
         The `sanitise` method gets executed before that delay.
         '''
-        if self.user_code:
+        if self.user_code is not None:
             return
         res = self.send_request('/rfd/default-user-code')
         self.user_code = str(res.read(), encoding='utf-8')

Source/launcher/routines/rcc_server.py Source/launcher/routines/rcc.pySource/launcher/routines/rcc_server.py renamed to Source/launcher/routines/rcc.py

@@ -1,6 +1,4 @@
 import web_server._logic as web_server_logic
-import web_server as web_server
-
 from ..startup_scripts import rcc_server
 from . import _logic as logic
 import util.const as const
@@ -148,17 +146,16 @@ def make_rcc_popen(self) -> None:
             [
                 self.get_versioned_path('RCCService.exe'),
 
-                f'-placeid:{const.PLACE_ID_CONST}',
+                f'-PlaceId:{const.PLACE_ID_CONST}',
 
-                '-localtest', self.get_versioned_path(
+                '-LocalTest', self.get_versioned_path(
                     'GameServer.json',
                 ),
 
-                '-settingsfile', self.get_versioned_path(
+                '-SettingsFile', self.get_versioned_path(
                     'DevSettingsFile.json',
                 ),
 
-                '-port 64989',
                 *(('-verbose',) if self.local_args.verbose else ()),
             ],
             stdin=subprocess.PIPE,
@@ -182,12 +179,12 @@ def process(self) -> None:
             self.make_rcc_popen()
 
 
-@ dataclasses.dataclass
+@dataclasses.dataclass
 class arg_type(logic.bin_ssl_arg_type):
     obj_type = obj_type
 
+    rcc_port_num: int | None
     game_config: config.obj_type
-    rcc_port_num: int = 2005
     skip_popen: bool = False
     verbose: bool = False
     web_port: web_server_logic.port_typ = web_server_logic.port_typ(

Source/launcher/routines/studio.py

@@ -1,5 +1,5 @@
 import web_server._logic as web_server_logic
-import web_server as web_server
+import web_server
 
 from . import _logic as logic
 import config.structure
@@ -56,5 +56,6 @@ class arg_type(logic.arg_type):
 
     game_config: config.obj_type
     web_ports: list[web_server_logic.port_typ] = dataclasses.field(
-        default_factory=list)
+        default_factory=list,
+    )
     verbose: bool = False

Source/launcher/routines/web_server.py Source/launcher/routines/web.pySource/launcher/routines/web_server.py renamed to Source/launcher/routines/web.py

@@ -7,14 +7,12 @@ class launch_mode(enum.Enum):
     ALWAYS = 'always'
     SERVER = 'server'
     PLAYER = 'player'
-    STUDIO = 'studio'
     DOWNLOAD = 'download'
 
 
 ENABLED_LAUNCH_MODES = {
     launch_mode.SERVER,
     launch_mode.PLAYER,
-    # launch_mode.STUDIO, TODO: get some Studio binaries.
     launch_mode.DOWNLOAD,
 }