Work on documentation for build.py, also add checkout step.
This commit is contained in:
43
README.md
43
README.md
@@ -1,50 +1,9 @@
|
||||
|
||||
LINUX INSTRUCTIONS:
|
||||
|
||||
Warnings:
|
||||
- Do NOT follow the installation instructions for Unreal!
|
||||
- Follow these instructions instead.
|
||||
All the important instructions are in 'build.py'
|
||||
|
||||
Install important Software
|
||||
- install git-lfs support. Usually: apt-get install git-lfs
|
||||
- install visual studio code. Usually: apt-get install code
|
||||
- install dotnet6. Usually: apt-get install dotnet6
|
||||
- install clangd-15. Usually: apt-get install clangd-15
|
||||
- install jq. On Linux, this is usually already installed.
|
||||
- install python3. On Linux, this is usually already installed.
|
||||
|
||||
Git Clone the UnrealEngine repository:
|
||||
- The repository is at https://github.com/EpicGames/UnrealEngine.git
|
||||
- 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
|
||||
- Check out the correct version: git checkout 5.3.1-release
|
||||
|
||||
Git Clone the integration Repository
|
||||
- The repository is at https://www.gnaut.com/team/integration.git
|
||||
- Clone it into your home directory, $HOME/integration
|
||||
|
||||
Apply patches and build everything:
|
||||
- Change directory to $HOME/integration
|
||||
- python3 build-everything.py
|
||||
|
||||
Launch Integration in the Debugger
|
||||
- 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'
|
||||
- Alternately, you can recompile from the command line by typing 'make' again.
|
||||
- After recompiling in the IDE, you can go straight back to debugging.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user