GSoC Midterm Evaluation: Steam Workshop SDK/Third Party Integration

.gitignore

@@ -32,6 +32,10 @@
 /CompilerSource/stupidity-buffer/obj
 /ENIGMAsystem/SHELL/.vs/*
 /ENIGMAsystem/SHELL/.vscode/*
+/.vscode/*
+/CMakeFiles/*
+/ENIGMAsystem/SHELL/.build/*
+CMakeCache
 .DS_Store
 
 enigma-launch.bat

CommandLine/testing/SimpleTests/steam_initialised.sog/create.edl

@@ -0,0 +1,4 @@
+
+is_initialized = steam_initialised();
+
+gtest_assert_eq(is_initialized,  true);

ENIGMAsystem/SHELL/Platforms/General/PFmain.cpp

@@ -7,11 +7,28 @@
 #include "Universal_System/roomsystem.h"
 #include "Universal_System/mathnc.h" // enigma_user::clamp
 
+#include "Universal_System/Extensions/DataStructures/include.h"
+#include "Universal_System/Instances/instance.h"
+
+#include "Universal_System/Extensions/Steamworks/implement.h" // The implement.h file is responsible for implementing extension_steamworks struct.
+
 #include <chrono> // std::chrono::microseconds
 #include <thread> // sleep_for
 
 namespace enigma {
 
+namespace extension_cast {
+extension_steamworks* as_extension_steamworks(object_basic*);
+}
+
+}  // namespace enigma
+
+namespace enigma {
+
+std::queue<std::map<std::string, variant>> posted_async_events;
+
+int extension_steamworks_mutex {1}; // Must be initialized to 1.
+
 std::vector<std::function<void()> > extension_update_hooks;
 
 bool game_isending = false;
@@ -166,7 +183,40 @@ int updateTimer() {
   return 0;
 }
 
+void wait(int* mutex) {
+  while (*mutex <= 0);
+  (*mutex)--;
+}
+
+void signal(int* mutex) {
+  (*mutex)++;
+}
+
+void fireEventsFromQueue(int* mutex) {
+  // wait(mutex);
+  while (!posted_async_events.empty()) {
+    enigma_user::ds_map_clear(enigma_user::async_load);
+
+    std::map<std::string, variant> event = posted_async_events.front();
+
+    posted_async_events.pop();
+
+    for (auto& [key, value] : event) {
+      enigma_user::ds_map_add(enigma_user::async_load, key, value);
+    }
+
+    instance_event_iterator = &dummy_event_iterator;
+    for (iterator it = instance_list_first(); it; ++it) {
+      object_basic* const inst = ((object_basic*)*it);
+      extension_steamworks* const inst_steamworks = extension_cast::as_extension_steamworks(inst);
+      inst_steamworks->myevent_steam();
+    }
+  }
+}
+
 int enigma_main(int argc, char** argv) {
+  enigma_user::async_load = enigma_user::ds_map_create();
+
   // Initialize directory globals
   initialize_directory_globals();
 
@@ -201,6 +251,8 @@ int enigma_main(int argc, char** argv) {
     for (auto update_hook : extension_update_hooks)
       update_hook();
 
+    fireEventsFromQueue(&extension_steamworks_mutex);
+
     ENIGMA_events();
     handleInput();
   }
@@ -215,6 +267,8 @@ int enigma_main(int argc, char** argv) {
 
 namespace enigma_user {
 
+int async_load;
+
 const int os_browser = browser_not_a_browser;
 std::string working_directory = "";
 std::string program_directory = "";

ENIGMAsystem/SHELL/Platforms/General/PFmain.h

@@ -20,6 +20,10 @@
 #define ENIGMA_PLATFORM_MAIN
 
 #include <string>
+#include <queue>
+#include <map>
+
+#include "Universal_System/var4.h"
 
 namespace enigma {
   extern bool game_isending;
@@ -32,6 +36,16 @@ namespace enigma {
   extern unsigned long current_time_mcs;
   extern bool game_window_focused;
 
+  // This queue will contain any event that will be fired inside the main loop.
+  extern std::queue<std::map<std::string, variant>> posted_async_events;
+
+  // The following semaphore code is for the new Async system to protect the posted_async_events queue
+  // from reading and writing at the same time. Steamworks extension writes to the queue.
+  // mutex to protect the async queue from race conditions when the Steamworks extension is writing into it.
+  extern int extension_steamworks_mutex;
+  void wait(int* mutex);
+  void signal(int* mutex);
+
   int enigma_main(int argc, char** argv);
   int game_ending();
   void Sleep(int ms);
@@ -58,6 +72,9 @@ extern double fps;
 extern unsigned long delta_time;
 extern unsigned long current_time;
 
+// When firing any event inside posted_async_events queue, this variable will contain the data that will be sent to the game.
+extern int async_load;
+
 void sleep(int ms);
 unsigned long get_timer(); // number of microseconds since the game started
 void game_end();

ENIGMAsystem/SHELL/Universal_System/Extensions/Steamworks/.gitignore

@@ -0,0 +1,27 @@
+############################################################################
+# Copyright (C) 2023-2024 Saif Kandil
+#
+# This file is a part of the ENIGMA Development Environment.
+#
+# ENIGMA is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, version 3 of the license or any later version.
+#
+# This application and its source code is distributed AS-IS, WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this code. If not, see <http://www.gnu.org/licenses/>
+############################################################################
+
+/.vs/*
+/.vscode/*
+
+# gb stands for Global Backup and it shouldn't be committed to git
+# gb is auto-generated by the example game
+/*.gb*/*
+
+# This is only temporary, it will be removed once the Midterm review is done.
+/example/*

ENIGMAsystem/SHELL/Universal_System/Extensions/Steamworks/About.ey

@@ -0,0 +1,15 @@
+%e-yaml
+---
+
+Name: Steamworks
+Identifier: Steamworks
+Author: Saif Kandil (https://k0t0z.github.io)
+Description: Steamworks is a set of tools and services that help game developers and publishers build their games and get the most out of distributing on Steam.
+Default: false
+Icon: steam.svg
+
+Depends:
+	Extensions: DataStructures
+Dependencies: None
+Implement: extension_steamworks
+Init: extension_steamworks_init

ENIGMAsystem/SHELL/Universal_System/Extensions/Steamworks/CMakeLists.txt

@@ -0,0 +1,52 @@
+############################################################################
+# Copyright (C) 2023-2024 Saif Kandil
+#
+# This file is a part of the ENIGMA Development Environment.
+#
+# ENIGMA is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, version 3 of the license or any later version.
+#
+# This application and its source code is distributed AS-IS, WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this code. If not, see <http://www.gnu.org/licenses/>
+############################################################################
+
+############################################################################
+# Note that this file isn't tested yet as ENIGMA's engine still works with
+# the old build system.
+############################################################################
+
+cmake_minimum_required(VERSION 3.5)
+
+project(steamworks VERSION 0.1 LANGUAGES CXX)
+
+set(CMAKE_INCLUDE_CURRENT_DIR ON)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+
+set(PROJECT_SOURCES 
+    main.cpp
+)
+
+add_library(steamapi STATIC IMPORTED GLOBAL 
+    redistributable_bin/steam_api.lib
+)
+
+set_property(TARGET steamapi APPEND PROPERTY IMPORTED_CONFIGURATIONS DEBUG)
+set_target_properties(steamapi PROPERTIES
+        IMPORTED_LINK_INTERFACE_LANGUAGES_DEBUG "CXX"
+        IMPORTED_LOCATION_DEBUG "${CMAKE_SOURCE_DIR}/redistributable_bin/steam_api.lib")
+
+add_executable(steamworks 
+    ${PROJECT_SOURCES}
+)
+
+target_link_libraries(steamworks 
+    steamapi
+)

ENIGMAsystem/SHELL/Universal_System/Extensions/Steamworks/Makefile

@@ -0,0 +1,44 @@
+############################################################################
+# Copyright (C) 2023-2024 Saif Kandil
+#
+# This file is a part of the ENIGMA Development Environment.
+#
+# ENIGMA is free software: you can redistribute it and/or modify it under the
+# terms of the GNU General Public License as published by the Free Software
+# Foundation, version 3 of the license or any later version.
+#
+# This application and its source code is distributed AS-IS, WITHOUT ANY
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+# FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
+# details.
+#
+# You should have received a copy of the GNU General Public License along
+# with this code. If not, see <http://www.gnu.org/licenses/>
+############################################################################
+
+SOURCES += $(wildcard Universal_System/Extensions/Steamworks/*.cpp) \
+				$(wildcard Universal_System/Extensions/Steamworks/game_client/*.cpp)
+
+# defining directory of steam header files
+override CXXFLAGS += -I$(ENIGMA_ROOT)/ENIGMAsystem/SHELL/Universal_System/Extensions/Steamworks/game_client/Steamv157/sdk/public/
+
+ifeq ($(TARGET-PLATFORM), Windows)
+
+    # defining directory of 64-bit lib file
+    override LDFLAGS += -L$(ENIGMA_ROOT)/ENIGMAsystem/SHELL/Universal_System/Extensions/Steamworks/game_client/Steamv157/sdk/redistributable_bin/win64/
+
+    # check https://www3.ntu.edu.sg/home/ehchua/programming/cpp/gcc_make.html#:~:text=Static%20Library%20vs.%20Shared%20Library
+    # adding 64-bit lib file
+    # this is static linking (maybe)
+    override LDLIBS += -lsteam_api64
+
+else ifeq ($(TARGET-PLATFORM), Linux)
+
+    # defining directory of 64-bit lib file
+    override LDFLAGS += -L$(ENIGMA_ROOT)/ENIGMAsystem/SHELL/Universal_System/Extensions/Steamworks/game_client/Steamv157/sdk/redistributable_bin/linux64
+
+    # check https://www3.ntu.edu.sg/home/ehchua/programming/cpp/gcc_make.html#:~:text=Static%20Library%20vs.%20Shared%20Library
+    # adding 64-bit lib file
+    override LDLIBS += -lsteam_api
+
+endif