Merge branches 'main' and 'main' of ssh://luckyrobots.com:2222/luckyrobots/luckyworld

.gitea/workflows/unreal-build.yml

@@ -4,8 +4,6 @@ on:
   workflow_dispatch:
   push:
     branches: [ main, develop ]
-  pull_request:
-    branches: [ main, develop ]
 
 jobs:
   # windows-build:

README.md

@@ -1,3 +1,20 @@
 # luckyworld
 
 this is our unreal repository with our complete source code...
+
+steps to pull the source code down and compile
+
+* (Don't download the .zip file. It's best to use the CLI or a visual tool so LFS can install the proper libraries)
+* git clone https://luckyrobots.com/luckyrobots/luckyworld.git
+* cd luckyworld
+* install git lfs
+    * brew install git-lfs (macOS)
+    * sudo yum install git-lfs (linux)
+    * choco install git (windows) or via https://git-scm.com/download/win 
+        * select option to install git-lfs
+* git lfs pull (just in case)
+* right click .uproject file.
+* Generate Visual Studio Project Files (windows)
+    * Open the generated .sln file with your IDE (i.e. Visual Studio or Rider)
+* (The project starts in 5.5 binary version so if you're using source you will need to right click the .uproject and switch your engine version)
+* Debug 'luckyrobots'