rdiscord_sdk 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 59a94f08d97089f6680144bf0ce256826b3f4ea2cec5d11f1b8f911eecd87b7f
-  data.tar.gz: 83f15af9437acd1c2723d444b50bba6fe6109929f4a7c9d27f1bbd8d9961c949
+  metadata.gz: 4e5d12918d76fbea01b9bb6bce5669c0546f45791aa0081f69f36c691dec7b68
+  data.tar.gz: bad3da53840bee73db47a0b073c46d2c5c138eb10911ec42622b063d28501c41
 SHA512:
-  metadata.gz: afc945ab00ec2106cc0b590e2af30b6de702160af959f73cdb3dfae2c92e564963cc866b0420d2da65fb93ddecf1a5de31987597600e2de891e6bb6168bbd4bf
-  data.tar.gz: 07ef99cda3316b89d7fa31888c4dd78c7b99eec08cf57559c1e693108bd8e26a3fb6214fdefad1a5d2afd692f3e25c463d101426ac010b24eadb8667e47409d6
+  metadata.gz: a60fb59f7a09136cbb3209d66a5b15a5d160047004b2f026c7f755575d4154e8869829d0172fcdd1c3c2c6d0b13a6b362ced5fb3fb4ef59607558754f86e2be7
+  data.tar.gz: 74c0ee7ad4b07ca3c87a28511709cc5bb2ca71cdc22fd43535dba351bf22b82c132fe888bedab6151f161fbf075701f189f00afde460117225f188fb9d60afb2

data/.ruby-version

@@ -0,0 +1 @@
+3.1.1

data/.vscode/c_cpp_properties.json

@@ -4,9 +4,8 @@
             "name": "Win32",
             "includePath": [
                 "${workspaceFolder}/**",
-                // "/usr/local/lib/ruby/**",
-                // "/usr/local/include/ruby-3.0.0/**",
                 "C:\\Ruby31-x64\\**",
+                "~/.rbenv/versions/3.1.1/**"
             ],
             "defines": [
                 "_DEBUG",
@@ -17,7 +16,7 @@
             "compilerPath": "/usr/bin/gcc",
             "cStandard": "c17",
             "cppStandard": "c++17",
-            "intelliSenseMode": "windows-msvc-x64"
+            "intelliSenseMode": "linux-gcc-x64"
         }
     ],
     "version": 4

data/README.md

@@ -1,4 +1,4 @@
-# R(uby) Discord SDK
+# R(uby) Discord SDK ![Gem](https://img.shields.io/gem/v/rdiscord_sdk) ![Gem](https://img.shields.io/gem/dt/rdiscord_sdk)
 
 This is a Ruby gem that implements bindings to the [Discord Game SDK](https://discord.com/developers/docs/game-sdk/discord).
 It is intended to be used in [ModShot](https://github.com/Astrabit-ST/Modshot-Core), although will work in any ruby application.
@@ -26,6 +26,8 @@ There are a couple of minor differences, such as the lack of a need to initializ
 - Events are also method blocks
 - Pending callbacks and events are accessible
 - Some functions return an array, usually the result being at [0] and an object at [1] (such as Discord::UserManager.get_current_user)
+- Images will likely not be supported on many platforms aside from mkxp-z, as mkxp-z has the ability to create bitmaps from strings
+- Some network manager events and methods return/take in an array of bytes (integers from 0-255, similar to a byte array in C#) rather than how you'd expect in C++
 
 As mentioned above, some functions return arrays. An easy way to deal with these would be to:
 ```rb
@@ -159,17 +161,16 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Speak2
 - [x] ActivityManager
 - [ ] RelationshipManager
 - [ ] LobbyManager
-- [ ] NetworkManager
-- [ ] OverlayManager
+- [x] NetworkManager
+- [x] OverlayManager
 - [ ] StorageManager
 - [ ] StoreManager
 - [ ] VoiceManager
 - [ ] AchievementManager
 
 ### Others
-- [ ] Core functionality
+- [x] Core functionality
   - [x] Initialization
-  - [ ] Teardown
   - [x] Run callbacks
   - [x] Log hooks
 - [x] All enums
@@ -180,8 +181,8 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/Speak2
   - [x] ActivityEvents
   - [ ] RelationshipEvents
   - [ ] LobbyEvents
-  - [ ] NetworkEvents
-  - [ ] OverlayEvents
+  - [x] NetworkEvents
+  - [x] OverlayEvents
   - [ ] StoreEvents
   - [ ] VoiceEvents
-  - [ ] AchievementEvents
+  - [ ] AchievementEvents

data/ext/rdiscord_sdk/gem_network_manager.cpp

@@ -0,0 +1,163 @@
+#include "gem_network_manager.h"
+#include <rice/rice.hpp>
+#include "common.h"
+#include "discord.h"
+#include <cstdint>
+#include <iostream>
+
+Module rb_mNetworkManager;
+
+std::uint64_t rb_network_manager_get_peer_id() {
+    CHECK_CORE_INITIALIZED;
+
+    std::uint64_t peerId;
+
+    DiscordSDK.core->NetworkManager().GetPeerId(&peerId);
+
+    return peerId;
+}
+
+int rb_network_manager_flush() {
+    CHECK_CORE_INITIALIZED;
+
+    return (int) DiscordSDK.core->NetworkManager().Flush();
+}
+
+int rb_network_manager_open_peer(std::uint64_t peer_id, const char* route_data) {
+    CHECK_CORE_INITIALIZED;
+
+    return (int) DiscordSDK.core->NetworkManager().OpenPeer(peer_id, route_data);
+}
+
+int rb_network_manager_update_peer(std::uint64_t peer_id, const char* route_data) {
+    CHECK_CORE_INITIALIZED;
+
+    return (int) DiscordSDK.core->NetworkManager().UpdatePeer(peer_id, route_data);
+}
+
+int rb_network_manager_close_peer(std::uint64_t peer_id) {
+    CHECK_CORE_INITIALIZED;
+
+    return (int) DiscordSDK.core->NetworkManager().ClosePeer(peer_id);
+}
+
+int rb_network_manager_open_channel(std::uint64_t peer_id, std::uint8_t channel_id, bool reliable) {
+    CHECK_CORE_INITIALIZED;
+
+    return (int) DiscordSDK.core->NetworkManager().OpenChannel(peer_id, channel_id, reliable);
+}
+
+int rb_network_manager_close_channel(std::uint64_t peer_id, std::uint8_t channel_id) {
+    CHECK_CORE_INITIALIZED;
+
+    return (int) DiscordSDK.core->NetworkManager().CloseChannel(peer_id, channel_id);
+}
+
+int rb_network_manager_send_message(std::uint64_t peer_id, std::uint8_t channel_id, Array rb_data) {
+    CHECK_CORE_INITIALIZED;
+
+    std::uint32_t data_length = rb_array_len(rb_data);
+    std::uint8_t data[data_length];
+
+    int value;
+    for (std::uint32_t i = 0; i < data_length; i++) {
+        value = NUM2INT(
+            rb_ary_entry(rb_data, i)
+        );
+        if (value > 255 || value < 0) {
+            rb_raise(rb_eRangeError, "Expected Integer between 0 and 255, encountered %d at index %d", value, i);
+            return 4;
+        }
+        data[i] = (std::uint8_t) value;
+    }
+
+    return (int) DiscordSDK.core->NetworkManager().SendMessage(peer_id, channel_id, data, data_length);
+}
+
+
+int rb_network_manager_on_message_connect() {
+    CHECK_CORE_INITIALIZED;
+
+    VALUE event_proc  = rb_common_get_event_proc(4);
+    int token = DiscordSDK.core->NetworkManager().OnMessage.Connect(
+        [event_proc](std::uint64_t peer_id, std::uint8_t channel_id, std::uint8_t* data, std::uint32_t data_length) {
+            if (event_proc == Qnil)
+                return;
+
+            if (!rb_obj_is_kind_of(event_proc, rb_cProc))
+                rb_raise(rb_eTypeError, "Proc expected in callback, got %d instead", rb_obj_classname(event_proc));
+
+            VALUE rb_data = rb_ary_new();
+            for (int i = 0; i < data_length; i++) {
+                rb_ary_push(rb_data, INT2NUM(data[i]));
+            }
+
+            VALUE array = rb_ary_new_from_args(4, event_proc, INT2NUM(peer_id), INT2NUM(channel_id), rb_data);
+
+            int state;
+            state = rb_discord_call_proc(array);
+
+            LOG_ERROR_IF_STATE;
+        }
+    );
+    rb_common_add_proc_to_hash(Symbol("on_message" + token), event_proc);
+
+    return token;
+}
+
+Object rb_network_manager_on_message_disconnect(int token) {
+    CHECK_CORE_INITIALIZED;
+
+    DiscordSDK.core->NetworkManager().OnMessage.Disconnect(token);
+    rb_hash_delete(rb_oProcEvents, Symbol("on_message" + token));
+
+    return Qnil;
+}
+
+int rb_network_manager_on_route_update_connect() {
+    CHECK_CORE_INITIALIZED;
+
+    VALUE event_proc  = rb_common_get_event_proc(1);
+    int token = DiscordSDK.core->NetworkManager().OnRouteUpdate.Connect(
+        [event_proc](const char* route_data) {
+            if (event_proc == Qnil)
+                return;
+
+            if (!rb_obj_is_kind_of(event_proc, rb_cProc))
+                rb_raise(rb_eTypeError, "Proc expected in callback, got %d instead", rb_obj_classname(event_proc));
+
+            VALUE array = rb_ary_new_from_args(2, event_proc, rb_str_new_cstr(route_data));
+
+            int state;
+            state = rb_discord_call_proc(array);
+
+            LOG_ERROR_IF_STATE;
+        }
+    );
+    rb_common_add_proc_to_hash(Symbol("on_route_update" + token), event_proc);
+
+    return token;
+}
+
+Object rb_network_manager_on_route_update_disconnect(int token) {
+    CHECK_CORE_INITIALIZED;
+
+    DiscordSDK.core->NetworkManager().OnRouteUpdate.Disconnect(token);
+    rb_hash_delete(rb_oProcEvents, Symbol("on_route_update" + token));
+
+    return Qnil;
+}
+
+void rb_network_init_manager(Module module) {
+    rb_mNetworkManager = define_module_under(module, "NetworkManager");
+    rb_mNetworkManager.define_module_function("get_peer_id", &rb_network_manager_get_peer_id);
+    rb_mNetworkManager.define_module_function("flush", &rb_network_manager_flush);
+    rb_mNetworkManager.define_module_function("open_peer", &rb_network_manager_open_peer);
+    rb_mNetworkManager.define_module_function("update_peer", &rb_network_manager_update_peer);
+    rb_mNetworkManager.define_module_function("close_peer", &rb_network_manager_close_peer);
+    rb_mNetworkManager.define_module_function("open_channel", &rb_network_manager_open_channel);
+    rb_mNetworkManager.define_module_function("close_channel", &rb_network_manager_close_channel);
+    rb_mNetworkManager.define_module_function("send_message", &rb_network_manager_send_message);
+    DEF_METHOD_EVENT(rb_mNetworkManager, message, network_manager);
+    DEF_METHOD_EVENT(rb_mNetworkManager, route_update, network_manager);
+}

data/ext/rdiscord_sdk/gem_network_manager.h

@@ -0,0 +1,8 @@
+#pragma once
+
+#include "rdiscord_sdk.h"
+
+using namespace Rice;
+
+extern Module rb_NetworkManager;
+void rb_network_init_manager(Module module);

data/ext/rdiscord_sdk/gem_overlay_manager.cpp

@@ -0,0 +1,112 @@
+#include "gem_overlay_manager.h"
+#include <rice/rice.hpp>
+#include "common.h"
+#include "discord.h"
+
+using namespace Rice;
+
+Module rb_mOverlayManager;
+
+bool rb_overlay_manager_is_enabled() {
+    CHECK_CORE_INITIALIZED;
+
+    bool enabled;
+
+    DiscordSDK.core->OverlayManager().IsEnabled(&enabled);
+
+    return enabled;
+}
+
+bool rb_overlay_manager_is_locked() {
+    CHECK_CORE_INITIALIZED;
+
+    bool locked;
+
+    DiscordSDK.core->OverlayManager().IsLocked(&locked);
+
+    return locked;
+}
+
+void rb_overlay_manager_set_locked(bool locked) {
+    CHECK_CORE_INITIALIZED;
+    
+    VALUE callback_proc = rb_common_get_callback_proc(1);
+    DiscordSDK.core->OverlayManager().SetLocked(
+        locked,
+        rb_discord_callback_wrapper_basic(callback_proc)
+    );
+}
+
+void rb_overlay_manager_open_activity_invite(int type) {
+    CHECK_CORE_INITIALIZED;
+
+    VALUE callback_proc = rb_common_get_callback_proc(1);
+    DiscordSDK.core->OverlayManager().OpenActivityInvite(
+        (discord::ActivityActionType) type,
+        rb_discord_callback_wrapper_basic(callback_proc)
+    );
+}
+
+void rb_activity_open_guild_invite(const char* code) {
+    CHECK_CORE_INITIALIZED;
+
+    VALUE callback_proc = rb_common_get_callback_proc(1);
+    DiscordSDK.core->OverlayManager().OpenGuildInvite(
+        code,
+        rb_discord_callback_wrapper_basic(callback_proc)
+    );
+}
+
+void rb_overlay_manager_open_voice_settings() {
+    CHECK_CORE_INITIALIZED;
+
+    VALUE callback_proc = rb_common_get_callback_proc(1);
+    DiscordSDK.core->OverlayManager().OpenVoiceSettings(
+        rb_discord_callback_wrapper_basic(callback_proc)
+    );
+}
+
+int rb_overlay_manager_on_toggle_connect() {
+    CHECK_CORE_INITIALIZED;
+
+    VALUE event_proc  = rb_common_get_event_proc(1);
+    int token = DiscordSDK.core->OverlayManager().OnToggle.Connect(
+        [event_proc](bool locked) {
+            if (event_proc == Qnil)
+                return;
+            
+            if (!rb_obj_is_kind_of(event_proc, rb_cProc))
+                rb_raise(rb_eTypeError, "Proc expected in callback, got %d instead", rb_obj_classname(event_proc));
+
+            
+            VALUE array = rb_ary_new_from_args(2, event_proc, BOOL2RB(locked));
+            int state;
+            rb_protect(rb_discord_call_proc, array, &state);
+
+            LOG_ERROR_IF_STATE;
+        }
+    );
+    rb_common_add_proc_to_hash(Symbol("on_toggle" + token), event_proc);
+
+    return token;
+}
+
+Object rb_overlay_manager_on_toggle_disconnect(int token) {
+    CHECK_CORE_INITIALIZED;
+
+    DiscordSDK.core->OverlayManager().OnToggle.Disconnect(token);
+    rb_hash_delete(rb_oProcEvents, Symbol("on_toggle" + token));
+
+    return Qnil;
+}
+
+void rb_overlay_init_manager(Module module) {
+    rb_mOverlayManager = define_module_under(module, "OverlayManager");
+    rb_mOverlayManager.define_module_function("is_enabled", &rb_overlay_manager_is_enabled);
+    rb_mOverlayManager.define_module_function("is_locked", &rb_overlay_manager_is_locked);
+    rb_mOverlayManager.define_module_function("set_locked", &rb_overlay_manager_set_locked);
+    rb_mOverlayManager.define_module_function("open_activity_invite", &rb_overlay_manager_open_activity_invite);
+    rb_mOverlayManager.define_module_function("open_guild_invite", &rb_activity_open_guild_invite);
+    rb_mOverlayManager.define_module_function("open_voice_settings", &rb_overlay_manager_open_voice_settings);
+    DEF_METHOD_EVENT(rb_mOverlayManager, toggle, overlay_manager);
+}

data/ext/rdiscord_sdk/gem_overlay_manager.h

@@ -0,0 +1,8 @@
+#pragma once
+
+#include "rdiscord_sdk.h"
+
+using namespace Rice;
+
+extern Module rb_mOverlayManager;
+void rb_overlay_init_manager(Module module);

data/ext/rdiscord_sdk/rdiscord_sdk.cpp

@@ -4,6 +4,8 @@
 #include "activity.h"
 #include "user.h"
 #include "gem_user_manager.h"
+#include "gem_overlay_manager.h"
+#include "gem_network_manager.h"
 
 using namespace Rice;
 
@@ -74,4 +76,6 @@ void Init_rdiscord_sdk()
     rb_activity_init_class(rb_mDiscord);
     rb_user_init_class(rb_mDiscord);
     rb_user_init_manager(rb_mDiscord);
+    rb_overlay_init_manager(rb_mDiscord);
+    rb_network_init_manager(rb_mDiscord);
 }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rdiscord_sdk
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Matthew Lyons
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-03-29 00:00:00.000000000 Z
+date: 2022-03-30 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -19,6 +19,7 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".rubocop.yml"
+- ".ruby-version"
 - ".vscode/c_cpp_properties.json"
 - ".vscode/settings.json"
 - Gemfile
@@ -36,6 +37,10 @@ files:
 - ext/rdiscord_sdk/extconf.rb
 - ext/rdiscord_sdk/gem_activity_manager.cpp
 - ext/rdiscord_sdk/gem_activity_manager.h
+- ext/rdiscord_sdk/gem_network_manager.cpp
+- ext/rdiscord_sdk/gem_network_manager.h
+- ext/rdiscord_sdk/gem_overlay_manager.cpp
+- ext/rdiscord_sdk/gem_overlay_manager.h
 - ext/rdiscord_sdk/gem_user_manager.cpp
 - ext/rdiscord_sdk/gem_user_manager.h
 - ext/rdiscord_sdk/rdiscord_sdk.cpp
@@ -46,7 +51,6 @@ files:
 - lib/rdiscord_sdk/enums.rb
 - lib/rdiscord_sdk/rdiscord_sdk.so
 - lib/rdiscord_sdk/version.rb
-- rdiscord_sdk.gemspec
 - third-party/include/achievement_manager.cpp
 - third-party/include/achievement_manager.h
 - third-party/include/activity_manager.cpp
@@ -86,7 +90,8 @@ files:
 - third-party/lib/x86_64/discord_game_sdk.dylib
 - third-party/lib/x86_64/discord_game_sdk.so
 homepage: https://github.com/Speak2Erase/rdiscord_sdk
-licenses: []
+licenses:
+- GPL-3.0
 metadata:
   homepage_uri: https://github.com/Speak2Erase/rdiscord_sdk
   source_code_uri: https://github.com/Speak2Erase/rdiscord_sdk

data/rdiscord_sdk.gemspec

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-Gem::Specification.new do |spec|
-  spec.name = "rdiscord_sdk"
-  spec.version = "1.1.0"
-  spec.authors = ["Matthew Lyons"]
-  spec.email = ["matthew@nowaffles.com"]
-
-  spec.summary = "Ruby bindings for the Discord Game SDK"
-  spec.homepage = "https://github.com/Speak2Erase/rdiscord_sdk"
-  spec.required_ruby_version = ">= 2.6.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = spec.homepage
-
-  # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (f == __FILE__) || f.match(%r{\A(?:(?:test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
-    end
-  end
-  spec.bindir = "exe"
-  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib", "ext"]
-  spec.extensions = ["ext/rdiscord_sdk/extconf.rb"]
-
-  # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
-
-  # For more information and examples about making a new gem, checkout our
-  # guide at: https://bundler.io/guides/creating_gem.html
-end