FPS Display Mod

Features:

• []Displays the current FPS in real-time.

  []Customizable text color, font size, and font family.

  []Draggable FPS display window (optional).

  []Configurable settings via a FPSDisplay.cfg file.

  []Lightweight and easy to use.

  How It Works:

  1. Initialization: The mod initializes using the Awake method, where it loads configuration settings and sets up the GUI style.

  2. Positioning: The FPS display is dynamically positioned at the bottom-right corner of the screen, with a 20px margin from the edges.

  3. Rendering: The OnGUI method handles the rendering of the FPS display. The background color is set to black, and the FPS value is updated every frame.

  4. Customization: Users can modify the FPSDisplay.cfg file to change the text color, font size, font family, and enable/disable dragging.

  Configuration:

  The mod uses a configuration file (FPSDisplay.cfg) to store user preferences.

  TextColor = 0. 85,0. 75,0. 45,1

  FontSize = 28

  FontFamily = Arial

  AllowDrag = true

  Installation:

  1. Install the BepInEx framework for your game.

  2. Copy the FPSDisplayMod.dll file to the BepInEx/plugins folder.

  3. Launch the game to generate the FPSDisplay.cfg file.

  4. Modify the FPSDisplay.cfg file to customize the mod.

  Code Overview:

  The mod is implemented in C# and uses Unity's OnGUI method for rendering. Key methods include:

  • []Awake: Initializes the mod and loads configuration settings.

    []Start: Sets the initial position of the FPS display.

    []Update: Updates the FPS value every frame.

  • OnGUI: Renders the FPS display on the screen.

    Example Code:

    using BepInEx;

    using UnityEngine;

    public class FPSDisplay : BaseUnityPlugin

    private float deltaTime = 0. 0f;

    private bool showFPS = true;

    private Rect windowRect;

    private GUIStyle fpsStyle;

    void Awake()

    // Load configuration and set up GUI style

    void Start()

    // Set initial position of the FPS display

    void Update()

    // Update FPS value

    void OnGUI()

    // Render FPS display

    License:

    This mod is open-source and licensed under the MIT License. Feel free to modify and distribute it as needed.

    Support:

    For issues or suggestions, please contact the developer or submit a bug report on the mod's distribution platform.