{"id":17721816,"url":"https://github.com/sinbad/stevesuehelpers","last_synced_at":"2025-04-04T21:08:33.652Z","repository":{"id":43399806,"uuid":"295467777","full_name":"sinbad/StevesUEHelpers","owner":"sinbad","description":"A plugin adding a bunch of common helper functionality that I use in my UE projects","archived":false,"fork":false,"pushed_at":"2024-10-23T14:00:34.000Z","size":8135,"stargazers_count":181,"open_issues_count":1,"forks_count":21,"subscribers_count":6,"default_branch":"master","last_synced_at":"2024-10-23T15:32:31.340Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/sinbad.png","metadata":{"files":{"readme":"ReadMe.md","changelog":null,"contributing":null,"funding":null,"license":"License.txt","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":"2020-09-14T16:02:05.000Z","updated_at":"2024-10-23T14:00:38.000Z","dependencies_parsed_at":"2023-02-08T12:46:11.428Z","dependency_job_id":"ae536731-00fd-4325-9bed-9c1209b20e85","html_url":"https://github.com/sinbad/StevesUEHelpers","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/sinbad%2FStevesUEHelpers","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinbad%2FStevesUEHelpers/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinbad%2FStevesUEHelpers/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sinbad%2FStevesUEHelpers/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sinbad","download_url":"https://codeload.github.com/sinbad/StevesUEHelpers/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247249526,"owners_count":20908212,"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":[],"created_at":"2024-10-25T15:36:20.796Z","updated_at":"2025-04-04T21:08:33.626Z","avatar_url":"https://github.com/sinbad.png","language":"C++","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Steve's UE Helper Plugin Library\n\n## Introduction\n\nThis is a helper plugin library for [Unreal Engine](https://www.unrealengine.com) (version 4.26+ / 5.0+)\nwhich makes a bunch of things better:\n\n* [New Widgets](doc/Widgets.md)\n  * Focusable buttons, menu stacks, control prompts and more\n* [Input events](doc/Input.md)\n  * Reliable notification when the player changes input method\n* [Debug visualisation](https://www.stevestreeting.com/2021/09/14/ue4-editor-visualisation-helper/)\n* [Better DataTable Row References](https://www.stevestreeting.com/2023/10/06/a-better-unreal-datatable-row-picker/)\n* [Light Flicker](doc/LightFlicker.md)\n* [Easing Functions](Source/StevesUEHelpers/Public/StevesEasings.h)\n* [Replicated Physics Actor](Source/StevesUEHelpers/Public/StevesReplicatedPhysicsActor.h)\n* [Actor Pooling System](Source/StevesUEHelpers/Public/StevesPooledActorSystem.h)\n* Halton Sequence based random stream\n\n## Examples\n\nThis project contains the master documentation for this library, but if you want\nto see examples of its use, see the [Steve's UE Examples](https://github.com/sinbad/StevesUEExamples) project.\n\n\n## Installing this plugin\n\n### Cloning\n\nThe best way is to clone this repository as a submodule; that way you can contribute\npull requests if you want. The project should be placed in your project's Plugins folder.\n\n```\n\u003e cd YourProject\n\u003e git submodule add https://github.com/sinbad/StevesUEHelpers Plugins/StevesUEHelpers\n\u003e git add ../.gitmodules\n\u003e git commit\n```\n\nAlternatively you can download the ZIP of this repo and place it in \n`YourProject/Plugins/StevesUEHelpers`.\n\n### Referencing in C++\n\nEdit YourProject.Build.cs and do something similar to this:\n\n```csharp\n\nusing System.IO;\nusing UnrealBuildTool;\n\npublic class YourProject : ModuleRules\n{\n\tprivate string PluginsPath\n\t{\n\t\tget { return Path.GetFullPath( Path.Combine( ModuleDirectory, \"../../Plugins/\" ) ); }\n\t}\n\n\tpublic YourProject(ReadOnlyTargetRules Target) : base(Target)\n\t{\n        // Your existing rules\n        // ...\n\n\n\t\tAddStevesUEHelpers();\n\t}\n\n\tprotected void AddStevesUEHelpers() {\n\t\t// Linker\n\t\tPrivateDependencyModuleNames.AddRange(new string[] { \"StevesUEHelpers\" });\n\t\t// Headers\n\t\tPublicIncludePaths.Add(Path.Combine( PluginsPath, \"StevesUEHelpers\", \"Source\", \"StevesUEHelpers\", \"Public\"));\n\t}\n\n```\n\nIt's also worth adding `StevesUEHelpers` to your own .uproject as a plugin reference:\n\n```\n\"Plugins\": [\n\t\t...\n\t\t{\n\t\t\t\"Name\": \"StevesUEHelpers\",\n\t\t\t\"Enabled\": true\n\t\t},\n\t\t...\n\n```\n\nAfter adding this you should right-click your .uproject file and \"Generate Visual\nStudio Project Files\". \n\nYou can use most of the features without doing anything else, but certain features\nrequire some additional setup, see below.\n\n### Configure Custom GameViewportClient\n\nThis library contains a new `UGameViewportClient` subclass called `UStevesGameViewportClientBase`,\nwhich is used to suppress the mouse cursor in menus then using a gamepad.\n\nUnfortunately UE4's Slate overrides the mouse pointer visibility sometimes, so\nthis fixes that.\n\nTo use it, simply:\n\n1. Open Project Settings\n1. Go to Engine \u003e General Settings\n1. Change Game Viewport Client Class to StevesGameViewportClientBase\n\n### Configure UiTheme\n\nSome features require you to configure some theme information for the UI, which \nis discussed in more detail in the [UiTheme section](./doc/UiTheme.md).\n\n## Game instance subsystem\n\nIn order to track stateful things like the current input mode for each player, \nthere is a custom `GameInstanceSubsystem` called `StevesGameSubsystem`, which \nyou can tap into anywhere in Blueprints by searching for it:\n\n![Game Instance Subsystem](./Resources/gameinstance.png)\n\nOnce you have access to this you can do things like get the latest input device used:\n\n![Game Instance Subsystem](./Resources/lastinput.png)\n\nFor more details, see the [Input section](doc/Input.md).\n\n# License\n\nThe MIT License (MIT)\nCopyright © 2020 Steve Streeting\n\nPermission 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:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE 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.\n\n# 3rd Party Licenses\n\nPortions of this software include code from 3rd parties:\n\nMath routines from David Eberly, Geometric Tools, Redmond WA 98052\nCopyright (c) 1998-2021\nDistributed under the Boost Software License, Version 1.0.\n\nBoost Software License - Version 1.0 - August 17th, 2003\n\nPermission is hereby granted, free of charge, to any person or organization\nobtaining a copy of the software and accompanying documentation covered by\nthis license (the \"Software\") to use, reproduce, display, distribute,\nexecute, and transmit the Software, and to prepare derivative works of the\nSoftware, and to permit third-parties to whom the Software is furnished to\ndo so, all subject to the following:\n\nThe copyright notices in the Software and this entire statement, including\nthe above license grant, this restriction and the following disclaimer,\nmust be included in all copies of the Software, in whole or in part, and\nall derivative works of the Software, unless such copies or derivative\nworks are solely in the form of machine-executable object code generated by\na source language processor.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT\nSHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE\nFOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,\nARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER\nDEALINGS IN THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsinbad%2Fstevesuehelpers","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsinbad%2Fstevesuehelpers","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsinbad%2Fstevesuehelpers/lists"}