UnrealOni: Difference between revisions

From OniGalore
Jump to navigation Jump to search
m (typo)
mNo edit summary
Line 1: Line 1:
==Scope==
==Scope==
This is not a game. It's a ''test'', if at all.
'''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.
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'''.


We will document learned knowledge in hope it might become useful one day for a ''real'' project.
We will document learned knowledge in hope it might become useful one day for a ''real'' project.
Line 14: Line 16:
If you are also interested in Unreal you will be able to fork this project from Git, make changes and create a pull request.
If you are also interested in Unreal you will be able to fork this project from Git, make changes and create a pull request.


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





Revision as of 18:14, 14 August 2019

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.

We will document learned knowledge in hope it might become useful one day for a real project.

Test data will be uploaded and linked to. While that data is created, we will try to port it to the always most up to date, stable Unreal engine version.

A blueprint project can be extended later by C++. For learning purposes we start with blueprints.


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.

For the improbable case that this test gets big, actual contributors can 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 we need the Large File Storage to store those files on a separate server. It is meant to keep the actual Git repo small.
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.


Project setup

  • 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
https://github.com/Paradox-01/UnrealOni.git
Right after download confirm LFS


Documentation

Oni2:UnrealOni/Documentation