ShippedMedium

Clean up Seminole UE 5.8 scaffold; add runtime-spawned test environment, placeholder character, launch scripts and Getting Started docs

Proposed by Jonathan Miller 1 month agoFunding opened 1 month agoFunded 1 month agoShipped 1 month ago
Acceptance · round 1
Shipped
CIPassed
Automated reviewPass with concerns

This is a thorough, well-documented static implementation: a GameMode plus test-environment actor that spawns a guarded floor, lights and PlayerStart; a legacy-input placeholder character; correct config; both launch scripts; an optional Python map generator; and complete Getting Started and VALIDATION docs that are honest about nothing being executed. The code looks idiomatic, but CI build was skipped and nothing has been compiled, so runtime correctness depends on the manual checklist. Some criteria (the uproject, pre-existing ignore/LFS lines, the cleanup removal list in a truncated PR description) cannot be confirmed from the visible diff.

Acceptance criteria · 9 of 12 met
  • UNCLEARSeminole.uproject parses as JSON, has one Runtime module Seminole, EngineAssociation 5.8, and no excluded pluginsThe uproject is not in the diff; the builder states it is unchanged with EngineAssociation 5.8, one Runtime/Default module and an empty Plugins list.
  • YESTarget.cs/Build.cs names match the files on disk; every #include resolves to a repo file or a Build.cs moduleSeminole.Build.cs now lists only Core/CoreUObject/Engine/InputCore, and all new includes (Engine/StaticMeshActor.h, GameFramework/SpringArmComponent.h, EngineUtils.h, etc.) live in Engine/CoreUObject or the repo; the Target files are unchanged and not shown.
  • YESASeminoleGameMode and ASeminolePlaceholderCharacter exist and C++ asset paths are only /Engine/BasicShapes/*Both classes are added; the only asset paths are /Engine/BasicShapes/Cylinder.Cylinder and /Engine/BasicShapes/Cube.Cube, loaded via FObjectFinder.
  • YESSpawn logic covers floor, directional light, sky light and PlayerStart, each guarded by an existence check`ASeminoleTestEnvironment::EnsureSceneBasics` guards each spawn with HasFloor/HasDirectionalLight/HasSkyLight/HasPlayerStart; lights are set Movable and the floor is 100x100x1 Cube with BlockAll collision.
  • YESDefaultEngine.ini sets GameDefaultMap, EditorStartupMap and GlobalDefaultGameMode to an engine map or a repo C++ classBoth maps are /Engine/Maps/Entry.Entry and the game mode is /Script/Seminole.SeminoleGameMode, which matches the new UCLASS.
  • YESDefaultInput.ini defines MoveForward/MoveRight/Turn/LookUp/Jump plus the legacy class overrides, and the character binds the same namesThe ini adds all mappings and sets PlayerInput/InputComponent; `SetupPlayerInputComponent` uses BindAxis/BindAction with identical names.
  • YEScreate_test_map.py exists and creates /Game/Maps/L_TestMap with the four elements; no .umap/.uasset committed`scripts/editor/create_test_map.py` creates or loads the level, adds the tagged floor, both lights and a PlayerStart, then saves; it has a full how-to header and no binary assets appear in the diff.
  • PARTIAL.gitignore and .gitattributes match section 1, with no tracked generated foldersThe diff adds Packaged/ to .gitignore and jpg/exr/mp3/ogg to the LFS rules; the remaining required entries are pre-existing and not visible in the diff.
  • YESBoth .bat scripts exist with no absolute engine paths and explicit errors; the run script exits non-zero when the exe is missingopen-project.bat resolves the root via %~dp0 and uses UE_ROOT or the file association with clear errors; run-latest-build.bat does `exit /b 1` with a message when Packaged\Windows\Seminole.exe is missing.
  • YESREADME Getting Started and docs/VALIDATION.md cover every listed itemREADME steps 1–8 plus Troubleshooting cover all required items; VALIDATION.md covers build, editor, PIE, package, exe and optional L_TestMap, and states none of the steps were executed.
  • PARTIALPR description states compile/launch/package were not run and lists removed filesThe summary states clearly that nothing was compiled, launched or packaged, but it is truncated before any removal list for Plugins/.gitkeep.
  • YESNo gameplay systems, online/Steam config or art assetsOnly bootstrap classes, config, scripts and docs are added; Enhanced Input is removed from Build.cs.
Concerns
  • Nothing was compiled or run: CI `build` was skipped and the agent had no engine, so the new C++ (deferred spawns, the line trace in `InitGame`, `ConstructorHelpers` use) is untested until someone works through `docs/VALIDATION.md`.
  • The builder summary is truncated, so I cannot confirm the PR description lists the cleanup removal (`Plugins/.gitkeep`, deleted in the diff) with a reason, as criterion 11 requires.
  • The spec names `Scripts/Editor/create_test_map.py`, but the file is at `scripts/editor/create_test_map.py`. This is harmless on Windows and consistent with `scripts/*.bat`, but it differs from the spec's casing.
  • `Seminole.uproject`, both Target.cs files and the pre-existing `.gitignore`/`.gitattributes` lines are not in the diff. Their compliance (EngineAssociation 5.8, plugin list, Binaries/Intermediate/Saved/DDC/.vs/.idea/*.sln ignores, uasset/umap/fbx/png/tga/wav/psd LFS rules) rests on the builder's claims and ARCHITECTURE.md text, not on visible evidence.
  • `HasFloor()` treats any `ECC_WorldStatic` hit along the vertical line through the origin as a floor. A map with, say, a small prop at the origin and no ground would skip the floor spawn. This is acceptable for bootstrap scaffolding but worth knowing.

BackersAccepted
1 accept · 0 rebuild · 0 not voted · quorum 1 of 1
MaintainerMerge

Accepted by the backers and merged by the maintainer.

Ballots · 1
AcceptJonathan Miller

Automated review cost $0.20, counted as builder cost.

Motivation

Ticket #21 produced ARCHITECTURE.md, the ADRs and a C++ scaffold. This ticket turns that scaffold into a clean UE 5.8 baseline. A Windows developer should be able to clone, open, build, run and package it without manual repair. It adds only the minimum needed to prove the project boots and adds no gameplay systems.

Environment constraint

The build agent has no Unreal Engine and no Windows, so it cannot compile, launch or package. All validation is static. Runtime verification is handed off to a manual checklist (docs/VALIDATION.md). The agent must not claim that compilation, launch or packaging succeeded.

Decisions (from proposer answers)

  • Engine: UE 5.8 is the definitive target. Align EngineAssociation, docs and config to 5.8 regardless of what existing files say.
  • Map: use both approaches.
    • (a) The game boots into an engine-provided map, and C++ spawns a floor, lighting and a PlayerStart at runtime when they are missing.
    • (b) An optional editor Python script generates /Game/Maps/L_TestMap locally.
    • The runtime fallback must work even if the script was never run.
  • Input: a C++ ACharacter subclass using legacy axis/action mappings in Config/DefaultInput.ini, bound in SetupPlayerInputComponent. No Enhanced Input in this ticket.

Scope

1. Repository cleanup

  • Audit the repo for placeholder, duplicate, stale or inconsistent scaffold files. Fix or remove only files that are clearly generated, redundant or broken. List each removal and its reason in the PR description.
  • Preserve ARCHITECTURE.md, the ADRs and other intentional docs. Update version references in them to 5.8 only where they contradict it.
  • Use consistent names everywhere: Seminole, SeminoleEditor, Source/Seminole.
  • .gitignore covers:
    • Binaries/, Intermediate/, Saved/, DerivedDataCache/, .vs/, .idea/
    • *.sln
    • the packaged output folder (assumption: Packaged/, documented in README)
  • .gitattributes routes these through Git LFS: *.uasset, *.umap, *.fbx, *.png, *.tga, *.jpg, *.wav, *.mp3, *.ogg, *.exr, *.psd.

2. Project validity

  • Seminole.uproject has "EngineAssociation": "5.8" and exactly one module: Seminole, Type Runtime, LoadingPhase Default.
  • Plugins:
    • Do not enable Steam, OnlineSubsystem*, StateTree, PCG, CommonUI or MetaSounds.
    • Explicitly disable EnhancedInput only if needed for legacy input to work. Assumption: leave it at the engine default and switch input classes via config instead (see section 4).
  • Seminole.Target.cs uses TargetType.Game and SeminoleEditor.Target.cs uses TargetType.Editor.
    • Both use BuildSettingsVersion.Latest and IncludeOrderVersion = EngineIncludeOrderVersion.Latest.
    • Both have ExtraModuleNames.Add("Seminole").
  • Seminole.Build.cs depends only on Core, CoreUObject, Engine and InputCore.
  • Seminole.cpp/Seminole.h contain IMPLEMENT_PRIMARY_GAME_MODULE(FDefaultGameModuleImpl, Seminole, "Seminole").

3. Minimal bootable shell (C++ only, no binary assets authored)

  • ASeminoleGameMode
    • Sets DefaultPawnClass = ASeminolePlaceholderCharacter::StaticClass().
    • At StartPlay/InitGame (before player spawn), ensures the world contains a floor, a directional light, a sky light and a PlayerStart. It spawns any missing piece itself or through a small ASeminoleTestEnvironment actor.
    • The floor is a StaticMeshActor/component using /Engine/BasicShapes/Cube or Plane, scaled to roughly 100m x 100m, with collision enabled.
    • Lights are spawned as movable.
    • The PlayerStart sits above the floor. Alternatively, override ChoosePlayerStart/FindPlayerStart to return the spawned one.
    • Nothing is spawned when the corresponding actor already exists. This keeps the generated L_TestMap from receiving duplicates.
  • ASeminolePlaceholderCharacter (an ACharacter) has:
    • the default capsule
    • a visible UStaticMeshComponent using /Engine/BasicShapes/Cylinder, loaded via ConstructorHelpers::FObjectFinder
    • a USpringArmComponent
    • a UCameraComponent
  • Controls:
    • MoveForward/MoveRight axes (W/S and D/A, scale ±1)
    • Turn/LookUp axes (MouseX, MouseY with -1 scale)
    • Jump action (SpaceBar)
    • All bound in SetupPlayerInputComponent via BindAxis/BindAction.
  • Scripts/Editor/create_test_map.py (optional to run):
    • Uses unreal editor Python APIs to create and save /Game/Maps/L_TestMap with a floor, a directional light, a sky light and a PlayerStart.
    • Header comments explain how to run it and how to repoint config at the map afterwards.
    • Requires the Python Editor Script Plugin, which is documented but not enabled by default. Assumption: the agent may instead enable PythonScriptPlugin in the uproject as editor-only if needed; note this choice in the PR.

4. Config

  • DefaultEngine.ini:
    • GameDefaultMap and EditorStartupMap point to an engine-provided map. Assumption: /Engine/Maps/Entry, or another map the agent can justify as shipped with the engine.
    • GlobalDefaultGameMode=/Script/Seminole.SeminoleGameMode.
  • DefaultInput.ini:
    • Contains the axis/action mappings.
    • Sets DefaultPlayerInputClass=/Script/Engine.PlayerInput and DefaultInputComponentClass=/Script/Engine.InputComponent, so legacy bindings work under UE5's Enhanced Input defaults.
  • DefaultGame.ini has a project name/ID section.
    • Packaging settings must ensure the engine map is cooked. Assumption: add it to +MapsToCook if required.
  • No config key references a nonexistent asset, map or class.

5. Scripts

  • scripts/open-project.bat:
    • If UE_ROOT is set and %UE_ROOT%\Engine\Binaries\Win64\UnrealEditor.exe exists, it launches that with the .uproject.
    • Otherwise it runs start "" Seminole.uproject (file association).
    • It resolves the repo root relative to the script location.
    • It prints a clear error if neither works.
  • scripts/run-latest-build.bat launches Packaged\Windows\Seminole.exe. If it is missing, it prints a clear error and exits with a non-zero code.
  • Neither script contains hardcoded absolute engine install paths.

6. Documentation

  • README Getting Started section:
    • UE 5.8 requirement
    • git lfs install
    • clone
    • Generate Visual Studio project files
    • open the .uproject
    • build Development Editor | Win64 in VS/Rider
    • Play/Standalone
    • Packaging (Platforms > Windows > Development, output to Packaged/)
    • launching Seminole.exe (or run-latest-build.bat)
    • optional create_test_map.py
    • Troubleshooting: missing modules/rebuild prompt, regenerating project files, LFS pointer files
  • docs/VALIDATION.md is a step-by-step manual checklist:
    • Build the editor target.
    • Open the editor and confirm the startup map loads with a floor and lighting.
    • In PIE, confirm WASD movement, mouse look and jump.
    • Package Win64 Development.
    • Run the exe and confirm the same scene loads.
    • (Optional) Run the Python script and boot L_TestMap.
    • It must state explicitly that none of these steps were executed by the implementer.

Acceptance criteria (statically verifiable)

  1. Seminole.uproject parses as JSON. It has one Runtime module Seminole, EngineAssociation "5.8", and none of the excluded plugins enabled.
  2. Target.cs and Build.cs names match the files on disk. Every #include in Source/ resolves to a repo file or an engine module listed in Build.cs.
  3. ASeminoleGameMode and ASeminolePlaceholderCharacter exist. All asset paths referenced in C++ are /Engine/BasicShapes/* built-ins.
  4. The GameMode's spawn logic covers the floor, directional light, sky light and PlayerStart, each guarded by an existence check.
  5. DefaultEngine.ini sets GameDefaultMap, EditorStartupMap and GlobalDefaultGameMode, and each resolves to an engine map or a C++ class in the repo.
  6. DefaultInput.ini defines MoveForward, MoveRight, Turn, LookUp and Jump, plus the legacy input class overrides. The character binds the same names.
  7. create_test_map.py exists and creates /Game/Maps/L_TestMap with the four elements. No .umap/.uasset is committed by the agent.
  8. .gitignore and .gitattributes match section 1, and git ls-files shows no tracked generated folders.
  9. Both .bat scripts exist with no absolute engine paths and with explicit error messages. The run script exits non-zero when the exe is missing.
  10. The README Getting Started section and docs/VALIDATION.md cover every listed item.
  11. The PR description states that compile, launch and package were not run, and lists the files removed during cleanup.
  12. The PR adds no gameplay systems, online/Steam config or art assets.

Out of scope

  • Zombie AI, noise attraction
  • Inventory, weapons, combat, health
  • Canoe and settlement systems
  • Multiplayer/Steam, save games
  • Enhanced Input
  • Final UI, controller, map, art, audio, animation, VFX
  • CI/CD, dedicated servers, browser builds

No comments yet.