This repository has been archived on 2026-05-24. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
AgrarianGameArchive/Docs/TemplateVariantDecision.md
T

64 lines
2.5 KiB
Markdown

# Unreal Template Variant Decision
Version `0.01` decision: remove unused Unreal starter variants from the
long-term Agrarian project, but do the actual source/content cleanup as the
next focused cleanup item instead of mixing it with this decision record.
## Decision
Agrarian should not keep the unused starter gameplay variants as normal project
surface area.
Remove or quarantine:
- `Variant_Combat`
- `Variant_Platforming`
- `Variant_SideScrolling`
- Their maps, external actors, input assets, UI assets, VFX, and prototype
content when no Agrarian-specific map depends on them.
Keep temporarily:
- `ThirdPerson` base character/input assets needed by the current player
Blueprint and early automation until Agrarian-specific player assets and the
MVP character selection flow replace them.
- Shared mannequin/animation content only where current Agrarian assets still
reference it.
## Why
The extra starter variants increase compile time, plugin dependencies, content
noise, and risk during packaging. They also make the project look like a
generic Unreal template instead of an Agrarian-specific survival game.
The current compiled variant source still pulls in `StateTree` and
`GameplayStateTree` through Combat and SideScrolling template AI code. Once the
unused variants are removed, those plugin dependencies should be rechecked and
removed if no Agrarian-specific AI code needs them.
## Cleanup Rules
Perform the cleanup in the editor-aware content organization pass:
1. Create a backup or ensure the current project backup timer has a fresh
snapshot before deleting content.
2. Remove unused variant C++ folders and include paths.
3. Remove matching content folders and external actor/object data.
4. Remove `StateTreeModule` and `GameplayStateTreeModule` if no remaining code
needs them.
5. Disable `StateTree` and `GameplayStateTree` in `AgrarianGame.uproject` if no
remaining content needs them.
6. Keep the current `ThirdPerson` character path until the MVP landing page and
male/female character selection flow are implemented.
7. Build `AgrarianGameEditor`.
8. Open the Ground Zero map and run map check.
9. Run the existing automation smoke checks that cover interaction, resources,
wildlife, and Ground Zero placement.
## Current State
Decision is complete. Cleanup is intentionally deferred to the next roadmap
item, `Organize Content/Agrarian/ folders and move starter/prototype assets into
clearly named locations`, so deletions and redirects can be validated in one
focused pass.