Merge feature/implementMoreConvinientMethods int develop (#10)

* move proto file * small improve on Dispose * remove proto file * move .proto files * fix examples folder * clear using * first working websocket thanks to @Versette * work on clean up * Set up readme and so * add some events * Still need to debug because some are not working idk why * totaly rework the app logic by removing the callback principe implement entityinfo * add ServerInfo and ServerMap * add segregation between legacy code and explicit objects * rework RustPlus socket * add examples * add more test examples
HandyS11 · May 30, 2024 · eb20a33 · eb20a33
1 parent 5188e49
commit eb20a33
Show file tree

Hide file tree

Showing 109 changed files with 5,358 additions and 326 deletions.
diff --git a/README.md b/README.md
@@ -2,6 +2,8 @@
 
 ## 📊 Features
 
+### RustPlusApi
+
 This is a list of the features that the Rust+ API provides:
 
 - `GetEntityInfo` Get current state of a Smart Device
@@ -16,6 +18,10 @@ This is a list of the features that the Rust+ API provides:
 
 Feel free to **explore** the `./RustPlusApi/Examples/` folder to see how to **use** the API.
 
+### RustPlusApi.Fcm
+
+
+
 ## 🖊️ Versions 
 
 ![skills](https://skillicons.dev/icons?i=cs,dotnet)
@@ -24,14 +30,20 @@ Feel free to **explore** the `./RustPlusApi/Examples/` folder to see how to **us
 
 ## 📍 NuGet
 
-Simply use this nuget by running the following command:
+Simply use this library in your project by running the following commands:
 
 ```dotnet
 dotnet add package RustPlusApi
 ```
 
+```dotnet
+dotnet add package RustPlusApi.Fcm
+```
+
 ## ⚙️ Usage
 
+### RustPlusApi
+
 First, instantiate the `RustPlus` class with the necessary parameters:
 
 ```csharp
@@ -43,9 +55,11 @@ Parameters:
 - `server`: The IP address of the Rust+ server.
 - `port`: The port dedicated for the Rust+ companion app (not the one used to connect in-game).
 - `playerId`: Your Steam ID.
-- `playerToken`: Your player token acquired with FCM.
+- `playerToken`\*: Your player token acquired with FCM.
 - `useFacepunchProxy`: Specifies whether to use the Facepunch proxy. Default is false.
 
+\* To aquired the player token, you can use the `FcmListener` and received at least one notification. Go to the next section to see how to use it.
+
 Then, connect to the Rust+ server:
 
 ```csharp
@@ -68,8 +82,59 @@ Remember to dispose the `RustPlus` instance when you're done:
 rustPlusApi.Dispose(); 
 ```
 
+---
+
+### RustPlusApi.Fcm
+
+First, instantiate the `FcmListener` class with the necessary parameters:
+
+```csharp
+var fcmListener = new FcmListener(credentials, persistentIds);
+```
+
+Parameters:
+
+- `credentials`: The `Credentials`\* object containing the FCM & GCM credentials + the keys to decrypt the notification.
+- `persistentIds`: A list of notification IDs that should be ignored. Default is null.
+
+\* Go to the [Credentials](#credentials) section to know how to get it.
+
+Then, connect to the FCM socket:
+
+```csharp
+await fcmListener.ConnectAsync();
+```
+
+You can subscribe to events to handle connection, disconnection, errors, and received messages:
+
+```csharp
+fcmListener.Connecting += (sender, e) => { /* handle connecting event */ };
+fcmListener.Connected += (sender, e) => { /* handle connected event */ };
+fcmListener.Disconnected += (sender, e) => { /* handle disconnected event */ };
+fcmListener.ErrorOccurred += (sender, e) => { /* handle error event */ };
+fcmListener.MessageReceived += (sender, e) => { /* handle received message event */ };
+```
+
+Remember to dispose the `FcmListener` instance when you're done:
+
+```csharp
+fcmListener.Dispose(); 
+```
+
+### Credentials
+
+Currenlty, there is not simple way to get the FCM & GCM credentials using **.NET**.
+I've planned to implement a solution but it's not ready yet.
+
+To use this library, you need to get the FCM & GCM credentials manually.
+To do so I recommand you to use [this project](https://github.com/liamcottle/rustplus.js) to get the credentials.
+
+I'm sorry for the inconvenience but since the API is not fully complete it's the easiest way.
+
 ## 🖼️ Credits
 
-This project is grandly inspired by [liamcottle/rustplus.js](https://github.com/liamcottle/rustplus.js).
+*This project is grandly inspired by [liamcottle/rustplus.js](https://github.com/liamcottle/rustplus.js).*
+
+Special thanks to [**Versette**](https://github.com/Versette) for his work on the `RustPlusApi.Fcm` socket.
 
 * Author: [**HandyS11**](https://github.com/HandyS11)
diff --git a/RustPlusApi.sln b/RustPlusApi.sln
diff --git a/RustPlusApi/Examples/Fcm/FcmListener/FcmListener.csproj b/RustPlusApi/Examples/Fcm/FcmListener/FcmListener.csproj
@@ -0,0 +1,14 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+	<PropertyGroup>
+		<OutputType>Exe</OutputType>
+		<TargetFramework>net8.0</TargetFramework>
+		<ImplicitUsings>enable</ImplicitUsings>
+		<Nullable>enable</Nullable>
+	</PropertyGroup>
+
+	<ItemGroup>
+		<ProjectReference Include="..\..\..\RustPlusApi.Fcm\RustPlusApi.Fcm.csproj" />
+	</ItemGroup>
+
+</Project>
diff --git a/RustPlusApi/Examples/Fcm/FcmListener/Program.cs b/RustPlusApi/Examples/Fcm/FcmListener/Program.cs
@@ -0,0 +1,38 @@
+using RustPlusApi.Fcm;
+using RustPlusApi.Fcm.Data;
+
+var credentials = new Credentials
+{
+    Keys = new Keys
+    {
+        PrivateKey = "",
+        PublicKey = "",
+        AuthSecret = "",
+    },
+    Fcm = new FcmCredentials
+    {
+        Token = "",
+        PushSet = "",
+    },
+    Gcm = new GcmCredentials
+    {
+        Token = "",
+        AndroidId = 0,
+        SecurityToken = 0,
+        AppId = "",
+    }
+};
+
+var listener = new FcmListener(credentials);
+
+listener.NotificationReceived += (_, message) =>
+{
+    Console.WriteLine($"[MESSAGE]: {DateTime.Now}:\n{message}");
+};
+
+listener.ErrorOccurred += (_, error) =>
+{
+    Console.WriteLine($"[ERROR]: {error}");
+};
+
+await listener.ConnectAsync();
diff --git a/.../GetEntityChanges/GetEntityChanges.csproj → ...amples/Fcm/FcmRegister/FcmRegister.csproj b/.../GetEntityChanges/GetEntityChanges.csproj → ...amples/Fcm/FcmRegister/FcmRegister.csproj
@@ -8,8 +8,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <ProjectReference Include="..\..\RustPlusApi\RustPlusApi.csproj" />
-    <ProjectReference Include="..\__Constants\__Constants.csproj" />
+    <ProjectReference Include="..\..\..\RustPlusApi.Fcm\RustPlusApi.Fcm.csproj" />
   </ItemGroup>
 
 </Project>
diff --git a/RustPlusApi/Examples/Fcm/FcmRegister/Program.cs b/RustPlusApi/Examples/Fcm/FcmRegister/Program.cs
@@ -0,0 +1,10 @@
+using RustPlusApi.Fcm;
+using Newtonsoft.Json;
+
+// NOT WORKING, NEEDS TO BE FIXED
+return;
+
+/* var senderId = "976529667804";
+var credentials = await FcmRegister.RegisterAsync(senderId);
+
+Console.WriteLine(JsonConvert.SerializeObject(credentials, Formatting.Indented));*/
diff --git a/...amples/GetEntityInfo/GetEntityInfo.csproj → ...Examples/GetAlarmInfo/GetAlarmInfo.csproj b/...amples/GetEntityInfo/GetEntityInfo.csproj → ...Examples/GetAlarmInfo/GetAlarmInfo.csproj
@@ -7,9 +7,9 @@
     <Nullable>enable</Nullable>
   </PropertyGroup>
 
-  <ItemGroup>
-    <ProjectReference Include="..\..\RustPlusApi\RustPlusApi.csproj" />
-    <ProjectReference Include="..\__Constants\__Constants.csproj" />
-  </ItemGroup>
+	<ItemGroup>
+		<ProjectReference Include="..\..\RustPlusApi\RustPlusApi.csproj" />
+		<ProjectReference Include="..\__Constants\__Constants.csproj" />
+	</ItemGroup>
 
 </Project>
diff --git a/...PlusApi/Examples/GetEntityInfo/Program.cs → RustPlusApi/Examples/GetAlarmInfo/Program.cs b/...PlusApi/Examples/GetEntityInfo/Program.cs → RustPlusApi/Examples/GetAlarmInfo/Program.cs
@@ -5,15 +5,15 @@
 using static __Constants.ExamplesConst;
 
 var rustPlus = new RustPlus(Ip, Port, PlayerId, PlayerToken);
+const uint entityId = 0;
 
 rustPlus.Connected += async (_, _) =>
 {
-    await rustPlus.GetEntityInfoAsync(EntityId, message =>
-    {
-        Console.WriteLine($"Infos:\n{JsonConvert.SerializeObject(message, JsonSettings)}");
-        rustPlus.Dispose();
-        return true;
-    });
+    var message = await rustPlus.GetAlarmInfoAsync(entityId);
+
+    Console.WriteLine($"Infos:\n{JsonConvert.SerializeObject(message, JsonSettings)}");
+
+    rustPlus.Dispose();
 };
 
 await rustPlus.ConnectAsync();
diff --git a/RustPlusApi/Examples/GetEntityChanges/Program.cs b/RustPlusApi/Examples/GetEntityChanges/Program.cs
diff --git a/RustPlusApi/Examples/GetInfo/Program.cs b/RustPlusApi/Examples/GetInfo/Program.cs
@@ -8,12 +8,11 @@
 
 rustPlus.Connected += async (_, _) =>
 {
-    await rustPlus.GetInfoAsync(message =>
-    {
-        Console.WriteLine($"Infos:\n{JsonConvert.SerializeObject(message, JsonSettings)}");
-        rustPlus.Dispose();
-        return true;
-    });
+    var message = await rustPlus.GetInfoAsync();
+
+    Console.WriteLine($"Infos:\n{JsonConvert.SerializeObject(message, JsonSettings)}");
+
+    rustPlus.Dispose();
 };
 
 await rustPlus.ConnectAsync();
diff --git a/RustPlusApi/Examples/GetMap/Program.cs b/RustPlusApi/Examples/GetMap/Program.cs
@@ -1,20 +1,25 @@
-using RustPlusApi;
+using Newtonsoft.Json;
+
+using RustPlusApi;
 
 using static __Constants.ExamplesConst;
 
 var rustPlus = new RustPlus(Ip, Port, PlayerId, PlayerToken);
 
 rustPlus.Connected += async (_, _) =>
 {
-    await rustPlus.GetMapAsync(message =>
-    {
-        var imageData = message.Response.Map.JpgImage.ToByteArray();
-        if (imageData == null) return false;
-        File.WriteAllBytes("map.jpg", imageData);
-        Console.WriteLine(@"Saved under .\RustPlusApi\RustPlusApi\Examples\GetMap\bin\Debug\net8.0");
-        rustPlus.Dispose();
-        return true;
-    });
+    var message = await rustPlus.GetMapAsync();
+
+    if (!message.IsSuccess) return;
+
+    File.WriteAllBytes("map.jpg", message.Data?.JpgImage!);
+
+    message.Data!.JpgImage = null;
+    Console.WriteLine($"Infos:\n{JsonConvert.SerializeObject(message, JsonSettings)}");
+
+    Console.WriteLine($"Image saved under: {Directory.GetCurrentDirectory()}");
+
+    rustPlus.Dispose();
 };
 
 await rustPlus.ConnectAsync();
diff --git a/RustPlusApi/Examples/GetMapMarkers/Program.cs b/RustPlusApi/Examples/GetMapMarkers/Program.cs
@@ -8,12 +8,12 @@
 
 rustPlus.Connected += async (_, _) =>
 {
-    await rustPlus.GetMapMarkersAsync(message =>
-    {
-        Console.WriteLine($"Infos:\n{JsonConvert.SerializeObject(message, JsonSettings)}");
-        rustPlus.Dispose();
-        return true;
-    });
+    //await rustPlus.GetMapMarkersAsync(message =>
+    //{
+    //    Console.WriteLine($"Infos:\n{JsonConvert.SerializeObject(message, JsonSettings)}");
+    //    rustPlus.Dispose();
+    //    return true;
+    //});
 };
 
 await rustPlus.ConnectAsync();
diff --git a/...Examples/StrobeEntity/StrobeEntity.csproj → ...witchChanges/GetSmartSwitchChanges.csproj b/...Examples/StrobeEntity/StrobeEntity.csproj → ...witchChanges/GetSmartSwitchChanges.csproj
@@ -7,9 +7,9 @@
     <Nullable>enable</Nullable>
   </PropertyGroup>
 
-  <ItemGroup>
-    <ProjectReference Include="..\..\RustPlusApi\RustPlusApi.csproj" />
-    <ProjectReference Include="..\__Constants\__Constants.csproj" />
-  </ItemGroup>
+	<ItemGroup>
+		<ProjectReference Include="..\..\RustPlusApi\RustPlusApi.csproj" />
+		<ProjectReference Include="..\__Constants\__Constants.csproj" />
+	</ItemGroup>
 
 </Project>
diff --git a/RustPlusApi/Examples/GetSmartSwitchChanges/Program.cs b/RustPlusApi/Examples/GetSmartSwitchChanges/Program.cs
@@ -0,0 +1,22 @@
+using Newtonsoft.Json;
+
+using RustPlusApi;
+
+using static __Constants.ExamplesConst;
+
+var rustPlus = new RustPlus(Ip, Port, PlayerId, PlayerToken);
+const uint entityId = 0;
+
+rustPlus.Connected += async (_, _) =>
+{
+    var message = await rustPlus.GetSmartSwitchInfoAsync(entityId);
+
+    Console.WriteLine($"Infos:\n{JsonConvert.SerializeObject(message, JsonSettings)}");
+};
+
+rustPlus.OnSmartSwitchTriggered += (_, message) =>
+{
+    Console.WriteLine($"SmartSwitch:\n{JsonConvert.SerializeObject(message, JsonSettings)}");
+};
+
+await rustPlus.ConnectAsync();
diff --git a/RustPlusApi/Examples/GetSmartSwitchInfo/GetSmartSwitchInfo.csproj b/RustPlusApi/Examples/GetSmartSwitchInfo/GetSmartSwitchInfo.csproj
@@ -0,0 +1,15 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>net8.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+  </PropertyGroup>
+
+	<ItemGroup>
+		<ProjectReference Include="..\..\RustPlusApi\RustPlusApi.csproj" />
+		<ProjectReference Include="..\__Constants\__Constants.csproj" />
+	</ItemGroup>
+
+</Project>