UnrealOni

Subpages: ALS, Documentation, Tutorials, Unreal Object Classes, Visual scripting

Scope

UnrealOni does not only stand for the used engine but is also a pun for not being an actual game, it's a test.

It aims to explore the Unreal engine and answer the longstanding question whether Oni can be recreated.

Since the Unreal Engine can be fully modified by C++ the question is rather how much of Oni can be replicated by Blueprint scripting and what parts need real programming.

Learned knowledge will be documented in hope for being useful one day for a real project.

A blueprint project can be extended later by C++. For learning purposes blueprints are used.

It is clear that the combat system will be the most difficult to recreate. The project might focus on easier parts first.

This bottom-up approach will possibly make learning the engine and its possibilities somewhat easier. No need to kill the fun and jump to tasks out of reach.

Contributions

If you are also interested in Unreal you will be able to fork this project from Git, make changes and create a pull request.

Todo: Give Barnacle his own space? His files/project changes seem to lack general compatibility with vanilla installations of UE4.

For the improbable case that this test gets big, actual contributors could be added later avoiding the forking workflow.

Tools setup

• Create a Github account
• Install Visual Studio with Git, C++ for games, and Unreal Engine Installer selected (see "individual components" if necessary)

However, Git and Unreal Installer can also be installed separately from the internet.

• Install Git LFS
• Run Git Bash/CMD and enter git lfs install

Since files larger than 100 MB are rejected Large File Storage is needed to store those files on a separate server. It is meant to keep the actual Git repo small. (Separates code from big binary content.)

A git repos shouldn't get bigger than 1 GB.

https://www.youtube.com/watch?v=Hv_v3tPuNj4

• Git is a command line tool. For those who like GUIs install the Git Desktop as well.
• Setup Git Desktop with your Git account data.

Original project setup (reminder)

• Start Unreal Laucher
• From the library choose newest installed engine
• Unreal Project Browser > New Project > Third Person (With Starter Content)

Set root folder

Set name (actually also a folder, it's the repository)

• In opened Unreal Editor, hit Source Control at the top controls.

Select Git as Provider. Git path should be found automatically as well as the root of repo, user name, and email, activate Git LFS.

Initialize project with Git

Accept Settings

• Manually adding extension for Git LFS

Open Git bash

cd /[DriveLetter]/.../[repoName]/

git lfs track "*.[fileExtention]"

.gitattributes file will now include that extension

• Github Desktop

File > Add existing repository

Tools and project setup for contributors

• Have a Github account
• Install Git, Git LFS and Github Desktop
• Open Github Desktop

File > Clone Repository > URL

After download confirm LFS

the current project file is to be opened with UnrealEngine 4.22:

with Barnacle's changes:

https://github.com/Paradox-01/UnrealOni

Original:

change branch to OriginalParadox (local files will be changed)

Branch "OriginalParadox"

This is basically a blank project with:

• an UE4 pre-loading splash screen (a "title bar" ?)
• a Bink video test (unofficial AE video)
• OniGameInstance with logic for ai2_chump and dev console [Alt]+[#]
• Xenotron font
• Oni mouse cursor
• data table for Xenotron font styles and glow tex (test images for IPge)

You might have seen screenshots of this project suggesting other content. This was simply the latest test with different content.