Implement remote scope option

docs/.vitepress/components/Editor.vue

@@ -114,7 +114,7 @@ const beforeMount = (monaco: Monaco) => {
 
 	const Calls = ["SingleSync", "SingleAsync", "ManySync", "ManyAsync"] as const;
 
-	const Options = ["typescript", "write_checks", "casing", "server_output", "client_output", "manual_event_loop", "yield_type", "async_lib"] as const;
+	const Options = ["write_checks", "typescript", "typescript_max_tuple_length", "manual_event_loop", "remote_scope", "server_output", "client_output", "casing", "yield_type", "async_lib"] as const;
 
 	const Casing = ["PascalCase", "camelCase", "snake_case"].map((value) => `"${value}"`);
 	const YieldType = ["yield", "future", "promise"].map((value) => `"${value}"`);
@@ -157,11 +157,13 @@ const beforeMount = (monaco: Monaco) => {
 		yield_type: YieldType,
 
 		typescript: Operators,
+		typescript_max_tuple_length: [],
 		write_checks: Operators,
 		manual_event_loop: Operators,
 
-		output_server: [],
-		output_client: [],
+		remote_scope: [],
+		server_output: [],
+		client_output: [],
 		async_lib: [],
 	} as const;
 

docs/config/options.md

@@ -27,6 +27,26 @@ The paths are relative to the configuration file and should point to a lua(u) fi
 
 <CodeBlock :code="outputExample" />
 
+## `remote_scope`
+
+This option changes the name of the remotes generated by Zap.
+
+### Default
+
+<CodeBlock code = 'opt remote_scope = "ZAP"' />
+
+
+The generated remotes will be `ZAP_RELIABLE` and `ZAP_UNRELIABLE` respectively.
+
+
+### Example
+
+<CodeBlock code = 'opt remote_scope = "PACKAGE_NAME"' />
+
+
+The generated remotes will change to be `PACKAGE_NAME_RELIABLE` and `PACKAGE_NAME_UNRELIABLE` respectively.
+
+
 ## `casing`
 
 This option changes the casing of the API generated by Zap.

zap/src/config.rs

@@ -14,6 +14,8 @@ pub struct Config<'src> {
 	pub typescript_max_tuple_length: f64,
 	pub manual_event_loop: bool,
 
+	pub remote_scope: &'src str,
+
 	pub server_output: &'src str,
 	pub client_output: &'src str,
 

zap/src/output/luau/client.rs

@@ -133,6 +133,7 @@ impl<'src> ClientOutput<'src> {
 			self.push_line(&format!("local function {send_events}()"));
 			self.indent();
 		} else {
+			self.push_line("local time = 0");
 			self.push_line("RunService.Heartbeat:Connect(function(dt)");
 			self.indent();
 			self.push_line("time += dt");
@@ -828,6 +829,23 @@ impl<'src> ClientOutput<'src> {
 		self.push_line("return returns");
 	}
 
+	pub fn push_remotes(&mut self) {
+		self.push_line(&format!("local reliable = ReplicatedStorage:WaitForChild(\"{}_RELIABLE\")", self.config.remote_scope));
+		self.push_line(&format!("local unreliable = ReplicatedStorage:WaitForChild(\"{}_UNRELIABLE\")", self.config.remote_scope));
+		self.push("\n");
+		self.push_line(&format!("assert(reliable:IsA(\"RemoteEvent\"), \"Expected {}_RELIABLE to be a RemoteEvent\")", self.config.remote_scope));
+		self.push_line(&format!("assert(unreliable:IsA(\"UnreliableRemoteEvent\"), \"Expected {}_UNRELIABLE to be an UnreliableRemoteEvent\")", self.config.remote_scope));
+		self.push("\n");
+	}
+
+	pub fn push_check_server(&mut self) {
+		self.push_line("if RunService:IsServer() then");
+		self.indent();
+		self.push_line("error(\"Cannot use the client module on the server!\")");
+		self.dedent();
+		self.push_line("end");
+	}
+
 	pub fn output(mut self) -> String {
 		self.push_file_header("Client");
 
@@ -839,7 +857,9 @@ impl<'src> ClientOutput<'src> {
 
 		self.push_studio();
 
-		self.push(include_str!("client.luau"));
+		self.push_check_server();
+
+		self.push_remotes();
 
 		self.push_tydecls();
 

zap/src/output/luau/server.rs

@@ -877,6 +877,63 @@ impl<'a> ServerOutput<'a> {
 		self.push_line("return returns");
 	}
 
+	pub fn push_check_client(&mut self) {
+		self.push_line("local Players = game:GetService(\"Players\")");
+		self.push("\n");
+		self.push_line("if RunService:IsClient() then");
+		self.indent();
+		self.push_line("error(\"Cannot use the server module on the client!\")");
+		self.dedent();
+		self.push_line("end");
+	}
+
+	pub fn push_create_remotes(&mut self) {
+		self.push_line(&format!("local reliable = ReplicatedStorage:FindFirstChild(\"{}_RELIABLE\")", self.config.remote_scope));
+		self.push_line("if reliable == nil then");
+		self.indent();
+		self.push_line("reliable = Instance.new(\"RemoteEvent\")");
+		self.push_line(&format!("reliable.Name = \"{}\"", self.config.remote_scope));
+		self.push_line("reliable.Parent = ReplicatedStorage");
+		self.dedent();
+		self.push_line("end");
+
+		self.push("\n");
+
+		self.push_line(&format!("local unreliable = ReplicatedStorage:FindFirstChild(\"{}_UNRELIABLE\")", self.config.remote_scope));
+		self.push_line("if unreliable == nil then");
+		self.indent();
+		self.push_line("unreliable = Instance.new(\"UnreliableRemoteEvent\")");
+		self.push_line(&format!("unreliable.Name = \"{}\"", self.config.remote_scope));
+		self.push_line("unreliable.Parent = ReplicatedStorage");
+		self.dedent();
+		self.push_line("end");
+	}
+
+	pub fn push_player_map(&mut self) {
+		self.push_line("local player_map = {}");
+		self.push("\n");
+		self.push_line("local function load_player(player: Player)");
+		self.indent();
+		self.push_line("if player_map[player] then");
+		self.indent();
+		self.push_line("load(player_map[player])");
+		self.dedent();
+		self.push_line("else");
+		self.indent();
+		self.push_line("load_empty()");
+		self.dedent();
+		self.push_line("end");
+		self.dedent();
+		self.push_line("end");
+		self.push("\n");
+		self.push_line("Players.PlayerRemoving:Connect(function(player)");
+		self.indent();
+		self.push_line("player_map[player] = nil");
+		self.dedent();
+		self.push_line("end");
+		self.push("\n");
+	}
+
 	pub fn output(mut self) -> String {
 		self.push_file_header("Server");
 
@@ -888,7 +945,11 @@ impl<'a> ServerOutput<'a> {
 
 		self.push_studio();
 
-		self.push(include_str!("server.luau"));
+		self.push_check_client();
+
+		self.push_create_remotes();
+
+		self.push_player_map();
 
 		self.push_tydecls();
 

zap/src/parser/convert.rs

@@ -92,6 +92,7 @@ impl<'src> Converter<'src> {
 
 		let (server_output, ..) = self.str_opt("server_output", "network/server.lua", &config.opts);
 		let (client_output, ..) = self.str_opt("client_output", "network/client.lua", &config.opts);
+		let (remote_scope, ..) = self.str_opt("remote_scope", "ZAP", &config.opts);
 
 		let casing = self.casing_opt(&config.opts);
 		let yield_type = self.yield_type_opt(typescript, &config.opts);
@@ -107,6 +108,8 @@ impl<'src> Converter<'src> {
 			typescript_max_tuple_length,
 			manual_event_loop,
 
+			remote_scope,
+
 			server_output,
 			client_output,