Add networking example

leiter-jakab · leiter-jakab · commit 0851cb9fdb7c · 2020-12-31T10:37:03.000+01:00
* Adds new client_server project under examples
* The project contains a very simple network communication example using
rpc calls
* Updates root Cargo.toml to add the new project
diff --git a/Cargo.toml b/Cargo.toml
@@ -14,6 +14,7 @@ members = [
     "examples/dodge_the_creeps",
     "examples/resource",
     "examples/native_plugin",
+    "examples/rpc",
     "impl/proc_macros"
 ]
 
diff --git a/examples/rpc/Cargo.toml b/examples/rpc/Cargo.toml
@@ -0,0 +1,12 @@
+[package]
+name = "rpc"
+version = "0.1.0"
+authors = ["The godot-rust developers"]
+publish = false
+edition = "2018"
+
+[lib]
+crate-type = ["cdylib"]
+
+[dependencies]
+gdnative = { path = "../../gdnative" }
diff --git a/examples/rpc/Client.tscn b/examples/rpc/Client.tscn
@@ -0,0 +1,6 @@
+[gd_scene load_steps=2 format=2]
+
+[ext_resource path="res://ServerPuppet.gdns" type="Script" id=1]
+
+[node name="Server" type="Node"]
+script = ExtResource( 1 )
diff --git a/examples/rpc/README.md b/examples/rpc/README.md
@@ -0,0 +1,25 @@
+# RPC Demo
+
+A very simple example to show peer to peer communication with Godot's high level multiplayer API calls.
+
+
+## Setup
+
+1. Build the library with `cargo build`.
+
+2. Import the Godot project in the Godot editor.
+
+3. Open the `Server.tscn` scene and start the current scene with `F6`.
+
+4. Start a second instance of the Godot editor.
+
+5. Set a separate "Remote Port" for the second editor (e.g. 6012). The two editor instances need to have different debug ports so that they can connect to their own running scenes. Needed to show the godot print messages.
+
+    `Editor > Editor Settings > Network > Debug`
+
+5. Open the `Client.tscn` scene and start the current scene with `F6`
+
+
+## References
+
+* [Godot hih-level multiplayer API](https://docs.godotengine.org/en/stable/tutorials/networking/high_level_multiplayer.html)
diff --git a/examples/rpc/Server.gdns b/examples/rpc/Server.gdns
@@ -0,0 +1,8 @@
+[gd_resource type="NativeScript" load_steps=2 format=2]
+
+[ext_resource path="res://client_server.gdnlib" type="GDNativeLibrary" id=1]
+
+[resource]
+resource_name = "Server"
+class_name = "Server"
+library = ExtResource( 1 )
diff --git a/examples/rpc/Server.tscn b/examples/rpc/Server.tscn
@@ -0,0 +1,6 @@
+[gd_scene load_steps=2 format=2]
+
+[ext_resource path="res://Server.gdns" type="Script" id=1]
+
+[node name="Server" type="Node"]
+script = ExtResource( 1 )
diff --git a/examples/rpc/ServerPuppet.gdns b/examples/rpc/ServerPuppet.gdns
@@ -0,0 +1,8 @@
+[gd_resource type="NativeScript" load_steps=2 format=2]
+
+[ext_resource path="res://client_server.gdnlib" type="GDNativeLibrary" id=1]
+
+[resource]
+resource_name = "ServerPuppet"
+class_name = "ServerPuppet"
+library = ExtResource( 1 )
diff --git a/examples/rpc/client_server.gdnlib b/examples/rpc/client_server.gdnlib
@@ -0,0 +1,17 @@
+[general]
+
+singleton=false
+load_once=true
+symbol_prefix="godot_"
+reloadable=true
+
+[entry]
+
+X11.64="res://../../target/debug/libclient_server.so"
+OSX.64="res://../../target/debug/libclient_server.dylib"
+Windows.64="res://../../target/debug/client_server.dll"
+
+[dependencies]
+
+X11.64=[  ]
+OSX.64=[  ]
diff --git a/examples/rpc/default_env.tres b/examples/rpc/default_env.tres
@@ -0,0 +1,7 @@
+[gd_resource type="Environment" load_steps=2 format=2]
+
+[sub_resource type="ProceduralSky" id=1]
+
+[resource]
+background_mode = 2
+background_sky = SubResource( 1 )
diff --git a/examples/rpc/icon.png b/examples/rpc/icon.png
diff --git a/examples/rpc/icon.png.import b/examples/rpc/icon.png.import
@@ -0,0 +1,34 @@
+[remap]
+
+importer="texture"
+type="StreamTexture"
+path="res://.import/icon.png-487276ed1e3a0c39cad0279d744ee560.stex"
+metadata={
+"vram_texture": false
+}
+
+[deps]
+
+source_file="res://icon.png"
+dest_files=[ "res://.import/icon.png-487276ed1e3a0c39cad0279d744ee560.stex" ]
+
+[params]
+
+compress/mode=0
+compress/lossy_quality=0.7
+compress/hdr_mode=0
+compress/bptc_ldr=0
+compress/normal_map=0
+flags/repeat=0
+flags/filter=true
+flags/mipmaps=false
+flags/anisotropic=false
+flags/srgb=2
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/HDR_as_SRGB=false
+process/invert_color=false
+stream=false
+size_limit=0
+detect_3d=true
+svg/scale=1.0
diff --git a/examples/rpc/project.godot b/examples/rpc/project.godot
@@ -0,0 +1,23 @@
+; Engine configuration file.
+; It's best edited using the editor UI and not directly,
+; since the parameters that go here are not all obvious.
+;
+; Format:
+;   [section] ; section goes between []
+;   param=value ; assign values to parameters
+
+config_version=4
+
+_global_script_classes=[  ]
+_global_script_class_icons={
+
+}
+
+[application]
+
+config/name="RPC Demo"
+config/icon="res://icon.png"
+
+[rendering]
+
+environment/default_environment="res://default_env.tres"
diff --git a/examples/rpc/src/client.rs b/examples/rpc/src/client.rs
@@ -0,0 +1,54 @@
+use gdnative::api::NetworkedMultiplayerENet;
+use gdnative::prelude::*;
+
+const ADDRESS: &str = "127.0.0.1";
+const PORT: i64 = 9876;
+const IN_BANDWIDTH: i64 = 1000;
+const OUT_BANDWIDTH: i64 = 1000;
+const CLIENT_PORT: i64 = 9877;
+
+#[derive(NativeClass)]
+#[inherit(Node)]
+pub struct ServerPuppet;
+
+#[methods]
+impl ServerPuppet {
+    fn new(_owner: &Node) -> Self {
+        Self
+    }
+
+    #[export]
+    fn _ready(&mut self, owner: TRef<Node>) {
+        let peer = NetworkedMultiplayerENet::new();
+        peer.create_client(
+            GodotString::from(ADDRESS),
+            PORT,
+            IN_BANDWIDTH,
+            OUT_BANDWIDTH,
+            CLIENT_PORT,
+        )
+        .unwrap();
+
+        let tree = owner.get_tree().expect("could not retreive SceneTree");
+        let tree = unsafe { tree.assume_safe() };
+
+        tree.connect(
+            "connected_to_server",
+            owner,
+            "on_connected_to_server",
+            VariantArray::new_shared(),
+            0,
+        )
+        .unwrap();
+    }
+
+    #[export]
+    fn on_connected_to_server(&mut self, owner: TRef<Node>) {
+        owner.rpc("greet_server", &[Variant::from_str("hello")]);
+    }
+
+    #[export(rpc = "puppet")]
+    fn return_greeting(&mut self, _owner: &Node, msg: GodotString) {
+        godot_print!("Server says: {}", msg);
+    }
+}
diff --git a/examples/rpc/src/lib.rs b/examples/rpc/src/lib.rs
@@ -0,0 +1,11 @@
+use gdnative::prelude::*;
+
+mod client;
+mod server;
+
+fn init(handle: InitHandle) {
+    handle.add_class::<client::ServerPuppet>();
+    handle.add_class::<server::Server>();
+}
+
+godot_init!(init);
diff --git a/examples/rpc/src/server.rs b/examples/rpc/src/server.rs
@@ -0,0 +1,44 @@
+use gdnative::api::NetworkedMultiplayerENet;
+use gdnative::prelude::*;
+
+const PORT: i64 = 9876;
+const MAX_CLIENTS: i64 = 1;
+const IN_BANDWIDTH: i64 = 1000;
+const OUT_BANDWIDTH: i64 = 1000;
+
+#[derive(NativeClass)]
+#[inherit(Node)]
+pub struct Server;
+
+#[methods]
+impl Server {
+    fn new(_owner: &Node) -> Self {
+        Self
+    }
+
+    #[export]
+    fn _ready(&mut self, owner: &Node) {
+        let peer = NetworkedMultiplayerENet::new();
+        peer.create_server(PORT, MAX_CLIENTS, IN_BANDWIDTH, OUT_BANDWIDTH)
+            .unwrap();
+
+        let tree = owner.get_tree().expect("could not retreive Scene Tree");
+        let tree = unsafe { tree.assume_safe() };
+
+        tree.set_network_peer(peer);
+    }
+
+    #[export(rpc = "master")]
+    fn greet_server(&mut self, owner: &Node, msg: GodotString) {
+        godot_print!("Client says: {}", msg);
+
+        let tree = owner.get_tree().expect("could not retreive Scene Tree");
+        let tree = unsafe { tree.assume_safe() };
+
+        owner.rpc_id(
+            tree.get_rpc_sender_id(),
+            "return_greeting",
+            &[Variant::from_str("hello")],
+        );
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@ members = [`
`14`	`14`	`"examples/dodge_the_creeps",`
`15`	`15`	`"examples/resource",`
`16`	`16`	`"examples/native_plugin",`
	`17`	`+ "examples/rpc",`
`17`	`18`	`"impl/proc_macros"`
`18`	`19`	`]`
`19`	`20`