README.md

SimFell

IMPORTANT: We currently do not offer a standalone version. There will be one in the future that you can use.

A DPS (Damage Per Second) simulator for the game Fellowship.

SimFell is a work-in-progress .NET 9.0 console application that simulates combat rotations, area-of-effect abilities, and more. It provides a flexible foundation for building and comparing DPS strategies.

Table of Contents

• SimFell
  • Table of Contents
  • Features
  • Project Structure
  • Prerequisites
  • Getting Started
  • Usage
  • Troubleshooting
  • Contributing
  • Contact
  • Credits
  • 😡 I hate SIMs

Features

Feature	Status
APL and Configuration Files	✅ Implemented
Talents, Stats, and Spells	✅ Implemented
Rime	✅ Implemented
Tariq - (Next Fest Example)	⚙️ Rough Draft
Gems, Legendaries, and Items	⚙️ Rough Draft
Rotation Opener, Multi-dotting	🚧 Not Started

Project Structure

SimFell/
├── SimFell.sln               # Solution file
├── SimFell/                  # Main project directory
│   ├── Configs/              # SimFell APL Configs
│   ├── Engine/               # Holds all the core Engine files. 
│   │   ├── Heroes/           # All of the Hero Class Files
│   ├── Logging/              # Logging configuration. 
│   ├── Reporting/            # Helpers for displaying the output.
│   ├── Sim/                  # All the core files to run the Sim.
│   ├── SimConifg/            # Parser for APL's and SimFell Config.
│   ├── Program.cs            # Entry point
│   └── SimFell.csproj        # Project file
├── simulation.log            # Sample run output log
├── README.md                 # This documentation
└── LICENSE                   # License information

Prerequisites

• .NET 9.0 SDK
• A .NET-compatible IDE or editor (Visual Studio, Rider, VS Code, etc.)

Tip

@Toonic: I recommend using Rider because it will setup everything for you.

Getting Started

1. Clone the repository:

   git clone https://github.com/your-username/SimFell.git
   cd SimFell

2. Build and run the project:

   • Using an IDE: Open SimFell.sln, set the SimFell project as the startup project, and run.

   • From the command line:

     # Restore dependencies and build
     dotnet restore
     dotnet build SimFell/SimFell.csproj
     
     # Run the simulator
     dotnet run --project SimFell/SimFell.csproj

Usage

Currently, SimFell runs as a command-line tool and outputs results to both the console and the simulation.log file in the root directory.

Example:

dotnet run --project SimFell/SimFell.csproj

Future releases will include a graphical interface and additional configuration options.

Troubleshooting

• Missing .NET runtime: Verify installation with dotnet --version; it should output 9.0.x.

• Build failures: Try cleaning and restoring with:

  dotnet clean
  dotnet restore

• No output or empty log: Ensure your Configs/ files (*.simfell) are correctly configured.

Contributing

Contributions are welcome! Please follow these steps:

1. Fork this repository.

2. Create a feature branch:

   git checkout -b feature/your-feature

3. Commit your changes:

   git commit -m "Add feature: ..."

4. Push to your branch:

   git push origin feature/your-feature

5. Open a Pull Request against main.

• Follow the existing C# coding conventions.
• Add unit tests for new features when applicable.

Contact

You can catch us on the FellowsGuide Discord!

Credits

• michaelsherwood — Progress bar and pretty-print ideas.
• EriiYenn — Initial Python project structure.

😡 I hate SIMs

Please see the following link.