Update installation instructions
This commit is contained in:
59
README.md
59
README.md
@@ -1,33 +1,48 @@
|
|||||||
|
|
||||||
These instructions are a work in progress. To build the integration project:
|
LINUX INSTRUCTIONS:
|
||||||
|
|
||||||
Install Unreal Engine from source, in $HOME/UnrealEngine
|
Install important Software
|
||||||
|
- install visual studio code. Usually: apt-get install code
|
||||||
|
- install dotnet6. Usually: apt-get install dotnet6
|
||||||
|
|
||||||
Install an IDE
|
Git Clone the Unreal Engine source code:
|
||||||
- On Windows, install visual studio 2020
|
- The repository is at https://github.com/EpicGames/UnrealEngine.git
|
||||||
- On Linux, install visual studio code (aka 'vscode')
|
- Cloning the repository requires creating an account and a password and
|
||||||
|
some other fiddly credential management stuff I don't remember how to do.
|
||||||
|
- Clone it into your home directory, $HOME/UnrealEngine
|
||||||
|
|
||||||
Git clone the integration repository in $HOME/integration
|
Compile the Unreal Engine, version 5.3.1
|
||||||
|
- Change directory to $HOME/UnrealEngine
|
||||||
|
- git checkout 5.3.1-release
|
||||||
|
- Run Setup.sh
|
||||||
|
- Run GenerateProjectFiles.sh
|
||||||
|
- make
|
||||||
|
|
||||||
Run 'make-makefiles.py' to create all the build files and project files.
|
Clone the Integration Repository
|
||||||
|
- The repository is at https://gnaut.com/jyelon/integration.git
|
||||||
|
- Clone it into your home directory, $HOME/integration
|
||||||
|
|
||||||
You can now launch the IDE.
|
Compile Integration
|
||||||
- In linux, the command is 'code Integration.code-workspace'
|
- Change directory to $HOME/integration
|
||||||
|
- Create Makefile and other useful project files: python3 make-makefiles.py
|
||||||
|
- make
|
||||||
|
|
||||||
If the IDE is vscode, the IDE will tell you that some plugins
|
Launch Integration in the Debugger
|
||||||
are recommended. The recommendations are good: install them.
|
- Change directory to $HOME/integration
|
||||||
|
- Start the IDE: code Integration.code-workspace
|
||||||
|
- Wait until a popup appears about 'recommended extensions'
|
||||||
|
- Install the recommended extensions (only have to do this once)
|
||||||
|
- Click 'Run/Start Debugging'
|
||||||
|
- Is is preconfigured to launch and debug the unreal editor with the integration code.
|
||||||
|
|
||||||
|
To edit and recompile, from inside the IDE:
|
||||||
|
- Edit some source files
|
||||||
|
- Click 'Terminal/Run Task...'
|
||||||
|
- If you edited the code in 'Source': Click 'IntegrationEditor Linux DebugGame Build'
|
||||||
|
- If you edited the code in 'Luprex': Click 'build luprex'
|
||||||
|
- You can optionally recompile from the command line by typing 'make' again.
|
||||||
|
- After recompiling in the IDE, you can go straight back to debugging.
|
||||||
|
|
||||||
In vscode, to build luprex:
|
|
||||||
- Click 'Terminal' menu
|
|
||||||
- Click 'Run Task...'
|
|
||||||
- Click 'Build Luprex'
|
|
||||||
|
|
||||||
In vscode, to build the game:
|
|
||||||
- Click 'Terminal' menu
|
|
||||||
- Click 'Run Task...'
|
|
||||||
- Click 'IntegrationEditor Linux DebugGame Build'
|
|
||||||
|
|
||||||
To build from the command line, type 'make luprex' or 'make game'.
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user