Skip to content

Gwergilius/Enclave-Terminal-Breach

Repository files navigation

Enclave Terminal Breach

English | Magyar

Version (RAVEN) License-MIT-badge .NET-badge
Quality Gate Status Coverage

Multi-platform Fallout terminal hacking assistant - Complete evolution from SPARROW prototype to ECHELON deployment.

In-universe: Enclave-developed breach tool for RobCo Unified Operating System terminals. See Project History for complete ECHELON backstory.

🎮 What is this?

A terminal hacking assistant application that helps solve the terminal hacking mini-game in Bethesda's Fallout games (Fallout 3, Fallout: New Vegas, Fallout 4, and Fallout 76).

Important: This is NOT a recreation of the minigame itself. This is an external helper tool that analyzes password patterns and suggests optimal guesses.

🚀 Project Status

Current Phase: 📝 Documentation & Planning

Component Status
Documentation 🚧 In Progress
Architecture 🚧 In Progress
SPARROW (DOS PoC) 🚧 In Progress
RAVEN (Console) 📋 Planned
GHOST (Web/Blazor) 📋 Planned
ECHELON (MAUI Mobile) 📋 Planned

📚 Project Evolution

This repository documents the complete development evolution:

  1. Excel Prototype (Pre-SPARROW) - Research phase using VBA macros
  2. SPARROW - DOS 3.11 proof of concept (stdin/stdout)
  3. RAVEN - Console application with screen positioning
  4. GHOST - Web/SIGNET deployment (Blazor PWA)
  5. ECHELON - Mobile Pip-Boy version (MAUI)

Each phase represents a significant architectural milestone, culminating in the final ECHELON v2.1.7 deployment.

🏗️ Technology Stack

  • .NET 10.0 - Primary framework
  • C# 12.0 - Programming language
  • MAUI - Cross-platform mobile UI
  • Blazor - Progressive Web App
  • xUnit - Unit testing
  • ReqNRoll - Integration/E2E testing
  • Playwright - UI testing

📖 Documentation

📁 Source code

Folder structure is described in the src/README (platforms: dotnet, excel-prototype; future: python, typescript). The .NET solution lives under src/dotnet/. Open the solution from src/dotnet/Enclave.Echelon.slnx and run the build from src/dotnet/:

cd src/dotnet
dotnet build Enclave.Echelon.slnx

For code coverage and quality (SonarCloud), see tools/coverage/README. The coverage badge is provided by SonarCloud (free for public repos); set the SONAR_TOKEN secret after adding the project on SonarCloud.

🔄 CI / Pipeline

GitHub Actions (.github/workflows/ci.yml):

  • Push (any branch): build, unit tests, and coverage run; failures do not block (you can push half-finished work and still see results). On main, GitVersion outputs the version when tests pass.
  • Pull request (to main/master): build, unit tests, and coverage are blocking; the run fails if build/test fails or if line coverage is below 80% or branch coverage below 95%.

Version from commit / PR message

Version bumps are driven by commit messages on feature branches and by PR title/description when merged. Configured in GitVersion.yml. Direct commits to main are not allowed (except e.g. Changelog updates).

Context Default Trigger Example
Commit (on a feature branch) Build number only (0.1.0+5+6) patch(scope): in subject patch(fix): correct validation → patch bump
PR merge (Squash and merge) Minor (new feature) Subject starts with feat: or feat(scope): feat: add Password model → minor
PR merge Major (breaking) Subject contains breaking-change: or BREAKING CHANGE: breaking-change: remove API → major
PR merge Patch (fix only) Subject starts with patch: or patch(scope): patch: fix typo → patch

Use Squash and merge for PRs so the PR title becomes the merge commit message and GitVersion can apply the rules above.

🤝 Contributing

This is a personal portfolio project, but feedback and suggestions are welcome! See coding standards in .cursor/rules/ for contribution guidelines.

📜 License

This project is licensed under the MIT License - see the LICENSE file for details.

🎯 Acknowledgments

About the Developer

Gwergilius (Gergely Tóth)
Cross-platform .NET developer with a passion for Fallout lore and software architecture.

This project demonstrates:

  • Cross-platform development (Console, Blazor, MAUI)
  • MVVM architecture
  • Lore-driven design (fiction follows function)
  • PHOSPHOR abstraction layer (inspired by fictional technology)

"I found Dr. Krane's notes in a Vault-Tec storage facility. Turns out PHOSPHOR wasn't just fiction - it was good software architecture. So I built it."

Contact


Disclaimer: This is a fan project and is not affiliated with Bethesda Softworks or Bethesda Game Studios.

About

Multi-platform Fallout terminal hacking assistant - From SPARROW prototype to ECHELON deployment

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors