Skip to content

skrebs1986/unreal_project

Repository files navigation

Farming Simulator - UE5 Project Setup

๐ŸŽฎ Farming Simulation Game | Unreal Engine 5 | PC


๐Ÿ“‹ Quick Status

Current Phase: Phase 2 - Prototype & Core Systems (Week 5)

โœ… Completed

  • Phase 1 Pre-Production (All design documents)
  • Project planning and architecture
  • C++ class headers
  • Git repository setup

โณ In Progress

  • UE5 Project Setup โ† YOU ARE HERE

๐Ÿš€ START HERE

Choose your IDE:

Option A: JetBrains Rider (Recommended โญ)

๐Ÿ‘‰ Follow: SETUP_INSTRUCTIONS_RIDER.md ๐Ÿ‘ˆ

  • Faster, better IntelliSense
  • Native Unreal Engine support
  • Modern IDE experience

Option B: Visual Studio 2022

๐Ÿ‘‰ Follow: SETUP_INSTRUCTIONS.md ๐Ÿ‘ˆ

  • Free and fully featured
  • Official Microsoft tooling
  • Good UE5 integration

Both guides walk you through:

  1. Installing your chosen IDE
  2. Installing Unreal Engine 5.4
  3. Creating the UE5 project
  4. Setting up Git LFS
  5. Building and running the project

Estimated Time: 2-3 hours (mostly downloads)


๐Ÿ“š Documentation

All project documentation is in the /Documentation/ folder:

Essential Reading

  1. SETUP_INSTRUCTIONS.md - Setup guide (START HERE!)
  2. Documentation/README.md - Documentation overview
  3. Documentation/Phase2_SetupGuide.md - Detailed development guide
  4. FarmingSimulator_ProjectPlan.md - Project timeline

Design Documents (Phase 1)

Development Documents (Phase 2)


๐Ÿ› ๏ธ Requirements

Software Needed

  • Unreal Engine 5.4+ (via Epic Games Launcher)
  • IDE - Choose one:
    • JetBrains Rider (recommended) - $149/year or free student license
    • Visual Studio 2022 Community (free)
  • Windows Build Tools (required even with Rider)
  • Git with Git LFS
  • Windows 10/11 64-bit

Hardware Minimum

  • CPU: Intel Core i7-8700 / AMD Ryzen 7 2700X
  • RAM: 16 GB
  • GPU: NVIDIA GTX 1660 / AMD RX 5600 XT
  • Storage: 100 GB SSD

Hardware Recommended

  • CPU: Intel Core i9-12900K / AMD Ryzen 9 5900X
  • RAM: 32 GB
  • GPU: NVIDIA RTX 3070 / AMD RX 6800
  • Storage: 250 GB NVMe SSD

๐Ÿ“ Project Structure

FarmingSimulator/           (will be created by UE5)
โ”œโ”€โ”€ Content/                (Unreal assets)
โ”œโ”€โ”€ Source/                 (C++ source code)
โ”‚   โ””โ”€โ”€ FarmingSimulator/
โ”‚       โ”œโ”€โ”€ Public/         (C++ headers - already created!)
โ”‚       โ”‚   โ”œโ”€โ”€ Core/
โ”‚       โ”‚   โ”œโ”€โ”€ Characters/
โ”‚       โ”‚   โ”œโ”€โ”€ Systems/
โ”‚       โ”‚   โ”œโ”€โ”€ Crops/
โ”‚       โ”‚   โ””โ”€โ”€ Data/
โ”‚       โ””โ”€โ”€ Private/        (C++ implementations - to be created)
โ”œโ”€โ”€ Documentation/          (All project docs)
โ”œโ”€โ”€ Config/                 (UE5 config files)
โ”œโ”€โ”€ Saved/                  (Generated files, not in git)
โ”œโ”€โ”€ Intermediate/           (Build files, not in git)
โ””โ”€โ”€ Binaries/               (Compiled binaries, not in git)

๐ŸŽฏ Setup Checklist

Use this to track your progress:

Installation Phase

  • Choose IDE:
    • Option A: JetBrains Rider + VS Build Tools
    • Option B: Visual Studio 2022 Community (full IDE)
  • Install Windows Build Tools or Visual Studio
    • Game development with C++ workload (or MSVC build tools)
    • Windows 10/11 SDK
  • Install Epic Games Launcher
  • Install Unreal Engine 5.4
  • Install Git
  • Install Git LFS

Project Creation Phase

  • Launch Unreal Engine 5.4
  • Create new C++ project (Third Person template)
  • Project name: FarmingSimulator
  • Location: C:\projects\
  • Wait for project generation

Integration Phase

  • Copy Documentation folder to UE5 project
  • Copy C++ headers to Source folder
  • Copy .gitignore and .gitattributes
  • Initialize Git in UE5 project folder
  • Configure Git LFS

Build Phase

  • Open FarmingSimulator.sln in your IDE (Rider or VS)
  • Build solution (Ctrl+Shift+B or F6)
  • Launch editor (F5 or Shift+F10 in Rider)
  • Verify project opens successfully

Ready to Develop! ๐ŸŽ‰

  • Read Phase2_SetupGuide.md
  • Start Week 5 tasks

๐Ÿ†˜ Common Issues

"Module could not be loaded"

Fix: Rebuild the solution in your IDE (Ctrl+Shift+B)

"Build tools not found" (Rider users)

Fix: Install Visual Studio Build Tools (see SETUP_INSTRUCTIONS_RIDER.md Step 2)

"Cannot compile - compiler not found"

Fix: Install MSVC build tools via Visual Studio or VS Build Tools

Build errors

Fix: Make sure all files copied to correct locations

Git LFS not working

git lfs install
git lfs track "*.uasset"
git lfs track "*.umap"

๐Ÿ“ž Support

Having issues?


๐Ÿ—“๏ธ Project Timeline

Total Duration: 56 weeks (14 months) Current Week: Week 5 of 56 Current Phase: Phase 2 - Prototype & Core Systems (Weeks 5-12)

Upcoming Milestones

  • Week 6: Player controller functional
  • Week 7: Time/weather systems
  • Week 12: Playable prototype complete
  • Week 36: Alpha build
  • Week 56: Launch! ๐Ÿš€

๐Ÿ‘ฅ Team Info

Team Size: 20 people Budget: $2.7M - $3.4M Platform: PC (Windows), Future: PS5, Xbox Series X/S


Let's build an amazing farming simulator! ๐ŸŒพ๐Ÿšœ

Next Step: Read SETUP_INSTRUCTIONS.md

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages