ShippedMedium

Document Seminole UE 5.8 architecture (ARCHITECTURE.md + 8 ADRs) and scaffold C++ project, Git LFS and .gitignore

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

The diff delivers every scoped item: a thorough ARCHITECTURE.md covering all 15 topics, 8 well-structured ADRs with an index, a standard UE 5.8 C++ project skeleton, LFS rules, Unreal ignores and a README section. The existing Babylon.js prototype was correctly preserved and integrated around. Every acceptance criterion is met on inspection. Remaining items are minor: the PNG-through-LFS interaction with the existing prototype and Pages deploy, a possibly dangling ASSETS_LICENSES.md reference, slightly more than minimal engine config, and unverified UE compilation, which the spec allows.

Acceptance criteria · 11 of 11 met
  • YESdocs/ARCHITECTURE.md has a heading for every Scope 1 topic, the full AI state flow string, an Intended plugins list and a Deferred / Out of scope listdocs/ARCHITECTURE.md has ## headings for all 15 topics, the exact state flow string in a code block, a '### Intended plugins' table of the 5 plugins stating each is enabled by the later ticket, and a '## Deferred / Out of scope' section.
  • YESdocs/adr/ contains at least 8 ADR files with Context, Decision and Consequences headings covering the 8 decisionsdocs/adr/0001–0008 each have ## Context / ## Decision / ## Consequences and map one-to-one to the listed decisions, and docs/adr/README.md indexes them.
  • YESSeminole.uproject parses as JSON with FileVersion 3 and EngineAssociation "5.8"Seminole.uproject is well-formed JSON with "FileVersion": 3 and "EngineAssociation": "5.8".
  • YESSeminole.uproject lists exactly one module Seminole (Runtime) and enables no pluginsThere is a single Modules entry with Name Seminole, Type Runtime and LoadingPhase Default, and "Plugins": [] is empty.
  • YESTarget.cs, Build.cs, Seminole.h and Seminole.cpp exist and follow standard UE5 game-module boilerplateThe Game and Editor targets use BuildSettingsVersion.Latest and EngineIncludeOrderVersion.Latest, Build.cs uses UseExplicitOrSharedPCHs with the 5 listed deps, and Seminole.cpp calls IMPLEMENT_PRIMARY_GAME_MODULE(FDefaultGameModuleImpl, Seminole, "Seminole").
  • YESEvery listed Source and Content subfolder exists and contains a tracked fileThere are 11 Source/Seminole/<System>/README.md stubs, each stating its purpose, and 9 Content/<Folder>/.gitkeep files, plus Plugins/.gitkeep.
  • YES.gitattributes contains an LFS rule for each listed extensionThe new .gitattributes has `filter=lfs diff=lfs merge=lfs -text` lines for all 11 extensions.
  • YES.gitignore excludes Binaries/, Intermediate/, Saved/ and DerivedDataCache/These entries are appended to the existing .gitignore along with IDE ignores, without ignoring Content/ or Config/.
  • YESNo C++ classes exist beyond the module stubThe only C++ files are Seminole.h, which includes CoreMinimal, and Seminole.cpp, which contains the module macro.
  • YESNo .uasset or .umap files are addedThe diff file list contains no .uasset or .umap files, and DefaultEngine.ini sets no maps.
  • YESNo pre-existing file is deletedThe diff shows only new files plus appends to README.md and .gitignore, with existing lines retained.
Concerns
  • The `*.png` LFS rule (required by the spec) also covers the existing browser prototype. If prototype PNGs are added later, the GitHub Pages workflow will deploy LFS pointer files unless its checkout enables `lfs: true`. Already-committed `docs/screenshots/*.png` may also show as modified for contributors who run `git lfs install`. The builder flagged this; a maintainer should decide on migration and workflow changes.
  • ADR 0008 says to see `ASSETS_LICENSES.md` "for the current limits" on LFS size and quota. The diff cannot confirm that file actually documents such limits; if it does not, this is a dangling reference.
  • `Config/DefaultEngine.ini` adds renderer and hardware-targeting defaults (Lumen GI and reflections, virtual shadows, mesh distance fields) beyond the "minimal valid" config the spec asked for. This is harmless but is an unrequested project-level choice.
  • The ARCHITECTURE large-population roadmap inserts a "cheap distance tiers" step between StateTree actors and MassEntity, slightly elaborating the spec's two-step assumption. It is reasonable, but it is an addition.
  • UE compilation is unverified, as the spec allows, and CI build and deploy were skipped. The C++ and C# boilerplate looks standard, but a maintainer should build `SeminoleEditor` once with UE 5.8.

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.15, counted as builder cost.

Motivation

Establish Seminole's technical foundation so later community-funded features have a consistent place to land. The stack is fixed:

  • Unreal Engine 5.8, desktop first, distributed on Steam.
  • C++ for core systems; Blueprint and data assets for content.
  • StateTree, AI Perception and NavMesh for the infected.
  • Noise as a single shared gameplay event.
  • World Partition and PCG for the world.
  • Listen server for 1–4 player co-op.
  • Host-owned save game for persistence.
  • UMG/CommonUI for UI; MetaSounds for audio.
  • Git with Git LFS for source control.

This build records those decisions and creates the repository skeleton. It does not implement gameplay.

Scope

1. docs/ARCHITECTURE.md

A concise document with one section per topic:

  • Engine and programming model.
  • AI, including the state flow Idle -> Wander -> Hear Noise -> Investigate -> Detect Player -> Chase -> Attack -> Lose Player -> Search -> Wander.
  • Noise event system.
  • Large-population roadmap.
  • World.
  • Multiplayer/Steam.
  • Persistence.
  • Gameplay components.
  • UI.
  • Audio.
  • Art pipeline.
  • Source control.
  • Browser strategy.
  • Vertical slice contents and target loop.
  • Deferred / Out of scope.

The doc must also include an "Intended plugins" list: StateTree, CommonUI, PCG, MetaSounds, OnlineSubsystemSteam. State that each plugin is enabled in the later ticket that needs it.

Assumptions:

  • The original proposal text is not in the repo. Derive content from this spec's stack list and the game description.
  • The large-population roadmap is: StateTree actors first, with MassEntity as an optional later step.
  • The vertical slice is: one swamp map, canoe travel, a day scavenge phase and a night defense phase, and co-op.
  • Keep each section short; do not invent detailed numbers.

2. docs/adr/

Create one ADR per decision, using Context / Decision / Consequences headings and numbered filenames (e.g. 0001-unreal-engine-5.md):

  1. UE5.
  2. C++ + Blueprint hybrid.
  3. StateTree AI without MassEntity at first.
  4. Noise event system.
  5. Listen server + Steam.
  6. Host-owned save game.
  7. No Gameplay Ability System by default.
  8. Git LFS before Perforce.

Also add docs/adr/README.md as an index.

3. UE project skeleton

Treat the repository as greenfield. If any existing files are found, preserve them and integrate around them. Never overwrite or delete existing work; for README, .gitignore and .gitattributes, append or merge.

  • Seminole.uproject:
    • FileVersion 3.
    • EngineAssociation "5.8".
    • One module Seminole with Type Runtime and LoadingPhase Default.
    • No Plugins entries enabled.
  • Source/Seminole.Target.cs (Game) and Source/SeminoleEditor.Target.cs (Editor).
    • Use BuildSettingsVersion.Latest and EngineIncludeOrderVersion.Latest (assumption: this avoids version-specific enums).
  • Source/Seminole/Seminole.Build.cs:
    • PCHUsage set to UseExplicitOrSharedPCHs.
    • Dependencies: Core, CoreUObject, Engine, InputCore, EnhancedInput (assumption: EnhancedInput is built in and does not require a plugin entry).
  • Source/Seminole/Seminole.h and Seminole.cpp, using IMPLEMENT_PRIMARY_GAME_MODULE(FDefaultGameModuleImpl, Seminole, "Seminole").
  • Source/Seminole/ subfolders, each containing a README.md stub that states the folder's purpose: AI, Characters, Combat, Community, Inventory, Interaction, Multiplayer, Persistence, Survival, Vehicles, World.
  • Content/ subfolders, each with a .gitkeep: AI, Characters, Environments, Items, Maps, Missions, Weapons, UI, Audio.
  • Minimal valid Config/ files:
    • DefaultEngine.ini: no map references to non-existent assets.
    • DefaultGame.ini: ProjectName set to Seminole.
    • DefaultInput.ini: Enhanced Input default classes.
  • Plugins/.gitkeep.

4. .gitattributes

Route these extensions through LFS with filter=lfs diff=lfs merge=lfs -text: *.uasset, *.umap, *.fbx, *.wav, *.png, *.tga, *.psd, *.blend, *.spp, *.sbs, *.sbsar.

5. .gitignore

Standard Unreal ignores: Binaries/, Intermediate/, Saved/, DerivedDataCache/, .vs/, .idea/, *.sln, *.suo, *.VC.db, and similar. Do not ignore Content/ or Config/.

6. README

Add a section that:

  • links to docs/ARCHITECTURE.md and docs/adr/;
  • states UE 5.8;
  • gives the Git LFS setup step (git lfs install before cloning or pulling).

Acceptance criteria

  • docs/ARCHITECTURE.md has a heading for every topic in Scope 1, including the full AI state flow string, an Intended plugins list and a Deferred / Out of scope list.
  • docs/adr/ contains at least 8 ADR files, each with Context, Decision and Consequences headings, covering the 8 listed decisions.
  • Seminole.uproject parses as JSON (python -m json.tool) and has FileVersion 3 and EngineAssociation "5.8".
  • Seminole.uproject lists exactly one module Seminole with Type Runtime and enables no plugins.
  • The Target.cs, Build.cs, Seminole.h and Seminole.cpp files exist and follow standard UE5 game-module boilerplate. Compilation is not verified because Unreal Engine is unavailable in the sandbox.
  • Every listed Source and Content subfolder exists and contains a tracked file.
  • .gitattributes contains an LFS rule for each listed extension.
  • .gitignore excludes Binaries/, Intermediate/, Saved/ and DerivedDataCache/.
  • No C++ classes exist beyond the module stub.
  • No .uasset or .umap files are added.
  • No pre-existing file is deleted.

Out of scope

  • Any gameplay system: AI, noise, health, inventory, weapons, canoe, persistence, networking.
  • .uasset or .umap content.
  • Enabling or configuring plugins.
  • Steam AppID or Steamworks config.
  • CI pipelines.
  • Dedicated servers, MMO-style worlds, backend orchestration.
  • Browser-first or mobile builds, console ports.
  • Mandatory MassEntity, full GAS adoption.
  • Final art direction or content.

No comments yet.