ScholaExamples v1.3.0

kurbeco · kurbeco · commit 26b5663580da · 2025-08-19T17:07:24.000+01:00
diff --git a/.gitmodules b/.gitmodules
@@ -1,4 +1,4 @@
 [submodule "Plugins/Schola"]
 	path = Plugins/Schola
-	url = ../Schola
+	url = ../Schola.git
 	branch = main
diff --git a/CITATION.cff b/CITATION.cff
@@ -33,5 +33,5 @@ keywords:
   - Unreal Engine 5
   - Python
 license: MIT
-version: '1.1'
-date-released: '2025-04-01'
+version: '1.3'
+date-released: '2025-08-01'
diff --git a/Plugins/Schola b/Plugins/Schola
@@ -1 +1 @@
-Subproject commit 4c5703af38a2e5bf597e05e2521e1dc0e0b62894
+Subproject commit d1b36c70f17ecd9c6815aeb076b25de2b8ba9e05
diff --git a/README.md b/README.md
@@ -6,7 +6,17 @@ This project contains Example Environments for Schola. These can be used as a re
 
 ### Install Unreal Engine
 
-Release 1.0 of this this project is designed for Unreal Engine 5.4 which is available for [Download](https://www.unrealengine.com/en-US/download) and is tested on 5.4.3 and 5.4.4. Release 1.1 supports Unreal Engine 5.5 (It is not compatible with Unreal Engine 5.4).
+As Schola examples is an Unreal Engine Project, you will need to first install Unreal Engine. Refer to the below table to identify the correct version of Unreal Engine for each version of Schola Examples. 
+
+>**Note**
+> Versions of Schola/ScholaExamples may be compatible with other Unreal Versions beyond the ones listed here, however these are the version(s) tested for each release.
+
+| Schola Examples Version | schola version | Unreal Version |
+| ----------------------- | -------------- | -------------- |
+| 1.3 | 1.3 | 5.5-5.6 |
+| 1.2 | 1.2 | 5.5 |
+| 1.1 | 1.1 | 5.5 |
+| 1.0 | 1.0 | 5.4 |
 
 ### Install Visual Studio
 
@@ -21,7 +31,7 @@ As Visual Studio is not supported on Linux, we recommend installing Visual Studi
 ### Install standalone Python package
 This installs the ScholaExamples environments as a standalone package
 ```bash
-pip install schola-examples
+pip install -e <path to ./python>
 ```
 
 ## Usage
diff --git a/ScholaExamples.uproject b/ScholaExamples.uproject
@@ -38,6 +38,10 @@
 		{
 			"Name": "NNERuntimeBasicCpu",
 			"Enabled": true
+		},
+		{
+			"Name": "FunctionalTestingEditor",
+			"Enabled": true
 		}
 	]
-}
+}
diff --git a/Source/ScholaExamples.Target.cs b/Source/ScholaExamples.Target.cs
@@ -9,7 +9,16 @@ public ScholaExamplesTarget(TargetInfo Target) : base(Target)
 	{
 		Type = TargetType.Game;
 		DefaultBuildSettings = BuildSettingsVersion.V5;
-		IncludeOrderVersion = EngineIncludeOrderVersion.Unreal5_5;
+		
+		if (Target.Version.MajorVersion == 5 && Target.Version.MinorVersion >= 6)
+		{
+			IncludeOrderVersion = EngineIncludeOrderVersion.Latest;
+		}
+		else
+		{
+			IncludeOrderVersion = EngineIncludeOrderVersion.Unreal5_5;
+		}
+
 		ExtraModuleNames.Add("ScholaExamples");
 		ExtraModuleNames.Add("RaceTrack");
 
diff --git a/Source/ScholaExamplesEditor.Target.cs b/Source/ScholaExamplesEditor.Target.cs
@@ -5,13 +5,21 @@
 
 public class ScholaExamplesEditorTarget : TargetRules
 {
-	public ScholaExamplesEditorTarget( TargetInfo Target) : base(Target)
-	{
-		Type = TargetType.Editor;
-		DefaultBuildSettings = BuildSettingsVersion.V5;
-		IncludeOrderVersion = EngineIncludeOrderVersion.Unreal5_5;
-		ExtraModuleNames.Add("ScholaExamples");
-		ExtraModuleNames.Add("RaceTrack");
-
+    public ScholaExamplesEditorTarget( TargetInfo Target) : base(Target)
+    {
+        Type = TargetType.Editor;
+        DefaultBuildSettings = BuildSettingsVersion.V5;
+        
+        if (Target.Version.MajorVersion == 5 && Target.Version.MinorVersion >= 6)
+        {
+            IncludeOrderVersion = EngineIncludeOrderVersion.Latest;
+        }
+        else
+        {
+            IncludeOrderVersion = EngineIncludeOrderVersion.Unreal5_5;
+        }
+        
+        ExtraModuleNames.Add("ScholaExamples");
+        ExtraModuleNames.Add("RaceTrack");
     }
 }
diff --git a/pytest.ini b/pytest.ini
@@ -16,5 +16,5 @@ norecursedirs =
     __pycache__
 testpaths = 
     python/tests
+    Plugins/Schola/Test/conftest.py
 engine_path = C:/Program Files/Epic Games/UE_5.5
-clean_build = false
diff --git a/python/tests/Maps/Examples/sb3.py b/python/tests/Maps/Examples/sb3.py
@@ -40,6 +40,7 @@ def test_num_environment_copies(self, env):
         assert env.num_envs == self.example.total_num_agents, f"Incorrect Number of Sub-Environments. Expected:{self.example.total_num_agents} Got:{env.num_envs}"
 
 
+@pytest.mark.serial
 class AbstractTestSB3Example:
     example : UnrealExample = None
 
@@ -78,4 +79,4 @@ def test_script_runs_on_example(self, built_game_path):
 
 
 class AbstractTestIncompatibleSB3Example:
-    example = None
+    example = None
diff --git a/python/tests/conftest.py b/python/tests/conftest.py
@@ -6,7 +6,7 @@
 from .Maps.Examples import ALL_EXAMPLES
 from .Maps.Tests import ALL_TEST_LEVELS
 from pathlib import Path
-from schola.core.unreal_connections import StandaloneUnrealConnection, UnrealConnection
+from schola.core.unreal_connections import StandaloneUnrealConnection, UnrealEditorConnection
 import shutil
 from subprocess import CompletedProcess
 
@@ -21,6 +21,7 @@ def pytest_addoption(parser):
 
 def pytest_configure(config):
     config.addinivalue_line("markers", "buildtest: mark test as validating some build property")
+    config.addinivalue_line("markers", "serial: mark test to force run serially")
 
 def pytest_collection_modifyitems(config, items):
     if config.getoption("--use-existing-build") is None:
@@ -43,7 +44,7 @@ def all_test_levels():
 def make_unreal_connection(built_game_path):
     connections = []
     
-    def factory(example) -> UnrealConnection:
+    def factory(example) -> UnrealEditorConnection:
         connection = StandaloneUnrealConnection("localhost", built_game_path, headless_mode=True, map=example.path, display_logs=False, disable_script=True)
         connections.append(connection)
         return connection
diff --git a/python/tests/test_core.py b/python/tests/test_core.py
@@ -1,11 +1,11 @@
-# Copyright (c) 2024 Advanced Micro Devices, Inc. All Rights Reserved.
+# Copyright (c) 2024-2025 Advanced Micro Devices, Inc. All Rights Reserved.
 
 from schola.core.env import ScholaEnv
-from schola.core.unreal_connections import UnrealConnection, StandaloneUnrealConnection
+from schola.core.unreal_connections import UnrealEditorConnection, StandaloneUnrealConnection
 import pytest
 import grpc
 
-class MockUnrealConnection(UnrealConnection):
+class MockUnrealConnection(UnrealEditorConnection):
     
     def __init__(self):
         super().__init__("localhost",8000)
diff --git a/python/tests/test_gym.py b/python/tests/test_gym.py
@@ -27,6 +27,7 @@ def factory():
 
 # test with 1,3, and 5 environments
 @pytest.mark.parametrize("n_envs", [1,3,5], ids=lambda x: f"n_envs={x}")
+@pytest.mark.serial
 def test_train_basic(built_game_path, env_factory, n_envs):
 
     vec_env = make_vec_env(env_factory, n_envs=n_envs, seed=0)
diff --git a/python/tests/test_rllib.py b/python/tests/test_rllib.py
@@ -12,34 +12,44 @@
 
 
 @pytest.mark.skip(reason="Takes too long")
-def test_train_basic(built_game_path,):
-    args = RLlibScriptArgs(enable_checkpoints=False, 
-                    launch_unreal=True,
-                    unreal_path=built_game_path,
-                    headless=True,
-                    port=None,
-                    disable_script=True,
-                    timesteps=30000,
-                    map="/Game/Examples/Basic/Maps/BasicTrain")
+def test_train_basic(
+    built_game_path,
+):
+    args = RLlibScriptArgs(
+        enable_checkpoints=False,
+        launch_unreal=True,
+        unreal_path=built_game_path,
+        headless=True,
+        port=None,
+        disable_script=True,
+        timesteps=30000,
+        map="/Game/Examples/Basic/Maps/BasicTrain",
+    )
     print("======= TRAINING OUTPUT =======")
     results = main(args)
     print("======= Results =======")
-    #only one trial for now
+    # only one trial for now
     max_reward = list(results.results.values())[0]["episode_reward_max"]
-    assert max_reward >= 0.05, "Agent Does not path directly to either reward on any episode(Reward < 0.06)."
-    assert max_reward >= 0.95, "Agent Does not path directly to the large reward on any episode(Reward < 0.96)."
-    
+    assert (
+        max_reward >= 0.05
+    ), "Agent Does not path directly to either reward on any episode(Reward < 0.06)."
+    assert (
+        max_reward >= 0.95
+    ), "Agent Does not path directly to the large reward on any episode(Reward < 0.96)."
+
 
 @pytest.mark.skip("Takes too long")
 @pytest.mark.parametrize("example", ALL_EXAMPLES, ids=lambda x: x.id)
-def test_script_runs_on_example(built_game_path,example):
-    args = RLlibScriptArgs(enable_checkpoints=False, 
-                    launch_unreal=True,
-                    unreal_path=built_game_path,
-                    headless=True,
-                    port=None,
-                    disable_script=True,
-                    fps=200,
-                    timesteps=3000,
-                    map=example.path)
+def test_script_runs_on_example(built_game_path, example):
+    args = RLlibScriptArgs(
+        enable_checkpoints=False,
+        launch_unreal=True,
+        unreal_path=built_game_path,
+        headless=True,
+        port=None,
+        disable_script=True,
+        fps=200,
+        timesteps=3000,
+        map=example.path,
+    )
     main(args)

Original file line number	Diff line number	Diff line change
`@@ -38,6 +38,10 @@`
`38`	`38`	`{`
`39`	`39`	`"Name": "NNERuntimeBasicCpu",`
`40`	`40`	`"Enabled": true`
	`41`	`+ },`
	`42`	`+ {`
	`43`	`+ "Name": "FunctionalTestingEditor",`
	`44`	`+ "Enabled": true`
`41`	`45`	`}`
`42`	`46`	`]`
`43`		`-}`
	`47`	`+}`