-
-
Notifications
You must be signed in to change notification settings - Fork 21.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #79126 from bruvzg/SteamTime
Enable optional minimal SteamAPI integration for usage time tracking (editor only).
- Loading branch information
Showing
5 changed files
with
214 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| /**************************************************************************/ | ||
| /* steam_tracker.cpp */ | ||
| /**************************************************************************/ | ||
| /* This file is part of: */ | ||
| /* GODOT ENGINE */ | ||
| /* https://godotengine.org */ | ||
| /**************************************************************************/ | ||
| /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ | ||
| /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ | ||
| /* */ | ||
| /* Permission is hereby granted, free of charge, to any person obtaining */ | ||
| /* a copy of this software and associated documentation files (the */ | ||
| /* "Software"), to deal in the Software without restriction, including */ | ||
| /* without limitation the rights to use, copy, modify, merge, publish, */ | ||
| /* distribute, sublicense, and/or sell copies of the Software, and to */ | ||
| /* permit persons to whom the Software is furnished to do so, subject to */ | ||
| /* the following conditions: */ | ||
| /* */ | ||
| /* The above copyright notice and this permission notice shall be */ | ||
| /* included in all copies or substantial portions of the Software. */ | ||
| /* */ | ||
| /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ | ||
| /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ | ||
| /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */ | ||
| /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ | ||
| /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ | ||
| /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ | ||
| /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ | ||
| /**************************************************************************/ | ||
|
|
||
| #if defined(STEAMAPI_ENABLED) | ||
|
|
||
| #include "steam_tracker.h" | ||
|
|
||
| // https://partner.steamgames.com/doc/sdk/api#initialization_and_shutdown | ||
|
|
||
| SteamTracker::SteamTracker() { | ||
| String path; | ||
| if (OS::get_singleton()->has_feature("linuxbsd")) { | ||
| path = OS::get_singleton()->get_executable_path().get_base_dir().path_join("libsteam_api.so"); | ||
| if (!FileAccess::exists(path)) { | ||
| path = OS::get_singleton()->get_executable_path().get_base_dir().path_join("../lib").path_join("libsteam_api.so"); | ||
| if (!FileAccess::exists(path)) { | ||
| return; | ||
| } | ||
| } | ||
| } else if (OS::get_singleton()->has_feature("windows")) { | ||
| if (OS::get_singleton()->has_feature("64")) { | ||
| path = OS::get_singleton()->get_executable_path().get_base_dir().path_join("steam_api64.dll"); | ||
| } else { | ||
| path = OS::get_singleton()->get_executable_path().get_base_dir().path_join("steam_api.dll"); | ||
| } | ||
| if (!FileAccess::exists(path)) { | ||
| return; | ||
| } | ||
| } else if (OS::get_singleton()->has_feature("macos")) { | ||
| path = OS::get_singleton()->get_executable_path().get_base_dir().path_join("libsteam_api.dylib"); | ||
| if (!FileAccess::exists(path)) { | ||
| path = OS::get_singleton()->get_executable_path().get_base_dir().path_join("../Frameworks").path_join("libsteam_api.dylib"); | ||
| if (!FileAccess::exists(path)) { | ||
| return; | ||
| } | ||
| } | ||
| } else { | ||
| return; | ||
| } | ||
|
|
||
| Error err = OS::get_singleton()->open_dynamic_library(path, steam_library_handle); | ||
| if (err != OK) { | ||
| steam_library_handle = nullptr; | ||
| return; | ||
| } | ||
| print_verbose("Loaded SteamAPI library"); | ||
|
|
||
| void *symbol_handle = nullptr; | ||
| err = OS::get_singleton()->get_dynamic_library_symbol_handle(steam_library_handle, "SteamAPI_InitFlat", symbol_handle, true); // Try new API, 1.59+. | ||
| if (err != OK) { | ||
| err = OS::get_singleton()->get_dynamic_library_symbol_handle(steam_library_handle, "SteamAPI_Init", symbol_handle); // Try old API. | ||
| if (err != OK) { | ||
| return; | ||
| } | ||
| steam_init_function = (SteamAPI_InitFunction)symbol_handle; | ||
| } else { | ||
| steam_init_flat_function = (SteamAPI_InitFlatFunction)symbol_handle; | ||
| } | ||
|
|
||
| err = OS::get_singleton()->get_dynamic_library_symbol_handle(steam_library_handle, "SteamAPI_Shutdown", symbol_handle); | ||
| if (err != OK) { | ||
| return; | ||
| } | ||
| steam_shutdown_function = (SteamAPI_ShutdownFunction)symbol_handle; | ||
|
|
||
| if (steam_init_flat_function) { | ||
| char err_msg[1024] = {}; | ||
| steam_initalized = (steam_init_flat_function(&err_msg[0]) == SteamAPIInitResult_OK); | ||
| } else if (steam_init_function) { | ||
| steam_initalized = steam_init_function(); | ||
| } | ||
| } | ||
|
|
||
| SteamTracker::~SteamTracker() { | ||
| if (steam_shutdown_function && steam_initalized) { | ||
| steam_shutdown_function(); | ||
| } | ||
| if (steam_library_handle) { | ||
| OS::get_singleton()->close_dynamic_library(steam_library_handle); | ||
| } | ||
| } | ||
|
|
||
| #endif // STEAMAPI_ENABLED |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,74 @@ | ||
| /**************************************************************************/ | ||
| /* steam_tracker.h */ | ||
| /**************************************************************************/ | ||
| /* This file is part of: */ | ||
| /* GODOT ENGINE */ | ||
| /* https://godotengine.org */ | ||
| /**************************************************************************/ | ||
| /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */ | ||
| /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */ | ||
| /* */ | ||
| /* Permission is hereby granted, free of charge, to any person obtaining */ | ||
| /* a copy of this software and associated documentation files (the */ | ||
| /* "Software"), to deal in the Software without restriction, including */ | ||
| /* without limitation the rights to use, copy, modify, merge, publish, */ | ||
| /* distribute, sublicense, and/or sell copies of the Software, and to */ | ||
| /* permit persons to whom the Software is furnished to do so, subject to */ | ||
| /* the following conditions: */ | ||
| /* */ | ||
| /* The above copyright notice and this permission notice shall be */ | ||
| /* included in all copies or substantial portions of the Software. */ | ||
| /* */ | ||
| /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */ | ||
| /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */ | ||
| /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */ | ||
| /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */ | ||
| /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */ | ||
| /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */ | ||
| /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */ | ||
| /**************************************************************************/ | ||
|
|
||
| #ifndef STEAM_TRACKER_H | ||
| #define STEAM_TRACKER_H | ||
|
|
||
| #if defined(STEAMAPI_ENABLED) | ||
|
|
||
| #include "core/os/os.h" | ||
|
|
||
| // SteamTracker is used to load SteamAPI dynamic library and initialize | ||
| // the interface, this notifies Steam that Godot editor is running and | ||
| // allow tracking of the usage time of child instances of the engine | ||
| // (e.g., opened projects). | ||
| // | ||
| // Currently, SteamAPI is not used by the engine in any way, and is not | ||
| // exposed to the scripting APIs. | ||
|
|
||
| enum SteamAPIInitResult { | ||
| SteamAPIInitResult_OK = 0, | ||
| SteamAPIInitResult_FailedGeneric = 1, | ||
| SteamAPIInitResult_NoSteamClient = 2, | ||
| SteamAPIInitResult_VersionMismatch = 3, | ||
| }; | ||
|
|
||
| // https://partner.steamgames.com/doc/api/steam_api#SteamAPI_Init | ||
| typedef bool (*SteamAPI_InitFunction)(); | ||
| typedef SteamAPIInitResult (*SteamAPI_InitFlatFunction)(char *r_err_msg); | ||
|
|
||
| // https://partner.steamgames.com/doc/api/steam_api#SteamAPI_Shutdown | ||
| typedef void (*SteamAPI_ShutdownFunction)(); | ||
|
|
||
| class SteamTracker { | ||
| void *steam_library_handle = nullptr; | ||
| SteamAPI_InitFunction steam_init_function = nullptr; | ||
| SteamAPI_InitFlatFunction steam_init_flat_function = nullptr; | ||
| SteamAPI_ShutdownFunction steam_shutdown_function = nullptr; | ||
| bool steam_initalized = false; | ||
|
|
||
| public: | ||
| SteamTracker(); | ||
| ~SteamTracker(); | ||
| }; | ||
|
|
||
| #endif // STEAMAPI_ENABLED | ||
|
|
||
| #endif // STEAM_TRACKER_H |