Skip to content

merge master back into 5.1 (did this backwards) #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Mar 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@ Saved/
Config/DefaultEditorUserSettings.ini
.vsconfig
Config/DefaultInput.ini
.obsidian/
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
# ToolExample - ScottKirvan/ToolExample fork
# [ToolExample - ScottKirvan/ToolExample fork](https://github.com/ScottKirvan/ToolExample)
This project contains UX/UI C++ examples for adding tools and UI elements to the [Unreal Engine](https://github.com/epicgames) editor - which means, these are editor tools for the artist, and not an example of how to write the runtime game code that a player would interact with.

This project contains UX/UI example code for [Unreal Engine](https://github.com/epicgames) engine developers.
If you're looking for an example to show how to add an item to the existing menu, or a new edit mode, or how to create a dockable window, this is a really thorough, [step-by-step example](https://lxjk.github.io/2019/10/01/How-to-Make-Tools-in-U-E.html) that starts from an empty code project, immediately jumps into the base modules needed, and then clearly and easily walks through the steps to code up various UI elements, hooking them to functionality as you go.

The example covers the following:
- adding modules
Expand All @@ -19,15 +20,17 @@ The example covers the following:
- custom project settings/preferences
- additional tricks and tips

The original project and step-by-step documentation can be found here: [How to Make Tools in UE4](https://lxjk.github.io/2019/10/01/How-to-Make-Tools-in-U-E.html)
I've included a plain-text version of that article in the project in case anything happend to that url in the future.
The origial project will build for 4.23 but not [4.17](https://github.com/lxjk/ToolExample/issues/2).
I couldn't build for 4.25 or 4.26, so I created this fork to go through the process
of updating the codebase to 4.26.
This repo is an updated fork of [Eric Zhang's](https://github.com/lxjk) original [UE4 project](https://github.com/lxjk/ToolExample). The excellent step-by-step documentation can be found here: [How to Make Tools in UE4](https://lxjk.github.io/2019/10/01/How-to-Make-Tools-in-U-E.html) I've included a stripped down version of that tutorial in this repo in case anything happens to that URL in the future.

This tutorial has become the most valuable one I've run across in my Unreal C++ journey. It got me started in an area of programming in Unreal that I found pretty impenetrable at first, and it has continued to be a reference point that I return to frequently whenever I'm thinking I want some new functionality (or just some easier-to-get-at functionality) inside Unreal. My deepest gratitude to Eric for his contribution here.

## Branches
- master
- current development branch - this will likely have the most recent code
- 5.1
- UE 5.1 Compatible
- There was some header changes, a new module dependency, and class FEditorStyle was deprecated and replaced with FAppStyle.
- I tested this very briefly, but it all seems to be working in UE5!
- 4.26
- UE 4.26 Compatible.
- Example Editor Mode is working in this version, so I'm not going to bother trying to figure out what broke in 4.25. If anyone takes this on as a project, please toss up a Pull Request.
Expand All @@ -36,7 +39,7 @@ of updating the codebase to 4.26.
- UE 4.25 Compatible.
- builds and runs, but the Example Editor Mode isn't working. It shows up in the Modes list, but the UI never gets built when selected. I didn't see any errors or warnings anywhere.
- NOTE: The editor mode issue works in 4.26 without any code changes.
- as it stands, this source is identical to th 4.24 branch
- as it stands, this source is identical to the 4.24 branch
- 4.24
- UE 4.24 Compatible.
- updates build.cs to V2 target.
Expand Down