{"id":20367819,"url":"https://github.com/flaxengine/onlineplatformsteam","last_synced_at":"2025-09-07T16:39:47.854Z","repository":{"id":105040040,"uuid":"453466339","full_name":"FlaxEngine/OnlinePlatformSteam","owner":"FlaxEngine","description":"Online platform implementation of Steam for games made with Flax Engine","archived":false,"fork":false,"pushed_at":"2025-03-25T12:34:37.000Z","size":716,"stargazers_count":17,"open_issues_count":1,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-25T13:40:21.523Z","etag":null,"topics":["flax","flax-engine","gamedev","steam"],"latest_commit_sha":null,"homepage":"","language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FlaxEngine.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-01-29T17:21:44.000Z","updated_at":"2025-03-12T07:56:40.000Z","dependencies_parsed_at":"2024-11-15T00:34:57.817Z","dependency_job_id":"17fce95f-c24d-4ae0-892f-3f281f38b4b5","html_url":"https://github.com/FlaxEngine/OnlinePlatformSteam","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlaxEngine%2FOnlinePlatformSteam","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlaxEngine%2FOnlinePlatformSteam/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlaxEngine%2FOnlinePlatformSteam/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FlaxEngine%2FOnlinePlatformSteam/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FlaxEngine","download_url":"https://codeload.github.com/FlaxEngine/OnlinePlatformSteam/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248524854,"owners_count":21118615,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["flax","flax-engine","gamedev","steam"],"created_at":"2024-11-15T00:34:51.966Z","updated_at":"2025-04-12T05:36:44.630Z","avatar_url":"https://github.com/FlaxEngine.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Steam for Flax Engine\n\nThis repository contains a plugin project for [Flax Engine](https://flaxengine.com/) games with [Steam](https://partner.steamgames.com/) online platform implementation that covers: user profile, friends list, online presence, achevements, cloud savegames and more.\n\nMinimum supported Flax version: `1.3`.\n\n## Installation\n\n1. Clone repo into `\u003cgame-project\u003e\\Plugins\\OnlinePlatformSteam`\n\n2. Add reference to *OnlinePlatformSteam* project in your game by modyfying `\u003cgame-project\u003e.flaxproj` as follows:\n\n```\n...\n\"References\": [\n    {\n        \"Name\": \"$(EnginePath)/Flax.flaxproj\"\n    },\n    {\n        \"Name\": \"$(ProjectPath)/Plugins/OnlinePlatformSteam/OnlinePlatformSteam.flaxproj\"\n    }\n]\n```\n\n3. Add reference to Steam plugin module in you game code module by modyfying `Source/Game/Game.Build.cs` as follows (or any other game modules using Online):\n\n```cs\n/// \u003cinheritdoc /\u003e\npublic override void Setup(BuildOptions options)\n{\n    base.Setup(options);\n\n    ...\n\n    switch (options.Platform.Target)\n    {\n    case TargetPlatform.Windows:\n    case TargetPlatform.Linux:\n    case TargetPlatform.Mac:\n        options.PublicDependencies.Add(\"OnlinePlatformSteam\");\n        break;\n    }\n}\n```\n\nThis will add reference to `OnlinePlatformSteam` module on Windows/Linux/Mac platforms that are supported by Steam.\n\n4. Setup settings\n\nSteam plugin automatically creates `steam_appid.txt` file with Steam AppId (for both Editor and cooked Game). You can add own settings in *Content* window by using *right-click*, then **New -\u003e Settings**, specify name, select **SteamSettings** type and confirm.\n\n5. Test it out!\n\nFinally you can use Steam as online platform in your game:\n\n```cs\n// C#\nusing FlaxEngine.Online;\nusing FlaxEngine.Online.Steam;\n\nvar platform = new OnlinePlatformSteam();\nOnline.Initialize(platform);\n```\n\n```cpp\n// C++\n#include \"Engine/Online/Online.h\"\n#include \"OnlinePlatformSteam/OnlinePlatformSteam.h\"\n\nauto platform = New\u003cOnlinePlatformSteam\u003e();\nOnline::Initialize(platform);\n```\n\nThen use [Online](https://docs.flaxengine.com/manual/networking/online/index.html) system to access online platform (user profile, friends, achievements, cloud saves, etc.).\n\n## License\n\nThis plugin ais released under **MIT License**.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflaxengine%2Fonlineplatformsteam","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflaxengine%2Fonlineplatformsteam","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflaxengine%2Fonlineplatformsteam/lists"}