Where to Find RenodX Documentation: A Complete Guide to the clshortfuse/renodx Repository

RenodX documentation is distributed across the top-level README.md, specialized guides in the docs/ directory, the web interface README at src/web/README.md, and inline code comments within Reshade effect files in src/reshadefx/.

The clshortfuse/renodx repository provides a comprehensive HDR modding framework for PC games, and its renodx documentation is strategically organized across multiple markdown files and source directories rather than centralized in a single location. Understanding this distributed structure helps developers quickly locate implementation details, API references, and contribution guidelines.

Core Documentation Files

The primary renodx documentation consists of four critical markdown files that cover project setup, modding workflows, and contribution standards.

Project Overview in README.md

The repository root contains README.md, which serves as the entry point for all users. This file provides high-level project descriptions, step-by-step build instructions from source, and basic usage guidance for end users installing the HDR modding framework. It also links to the specialized documentation sections for advanced use cases.

Modding Control Panel Guide (docs/DEVKIT_MCP.md)

For developers creating custom HDR modifications, docs/DEVKIT_MCP.md contains the authoritative reference for the Modding Control Panel (MCP). This document explains the MCP architecture, integration patterns for custom mods, and how the framework manages swapchain modifications. According to the clshortfuse/renodx source code, this file defines the standard interface for registering pre-render callbacks and shader replacements.

Contribution Guidelines (docs/CONTRIBUTING.md)

The docs/CONTRIBUTING.md file specifies the development environment setup requirements, coding standards enforced by automated linters, and the precise workflow for submitting pull requests. This documentation ensures consistent code quality across the C++ core and HLSL shader components.

Web Interface Documentation

Built-in Web UI (src/web/README.md)

Located at src/web/README.md, this documentation describes the integrated web server that serves the renodx documentation site locally. It details static asset management, configuration options for the WebServer class, and procedures for hosting the documentation interface on custom ports. This approach allows developers to browse renodx documentation offline after cloning the repository.

You can serve the documentation locally using the renodx::WebServer class implemented in the core library:

// Initialize RenodX’s web UI (requires the "src/web" assets to be placed beside the executable)
#include "renodx/web_server.hpp"

int main()
{
    // Serve the static web content on localhost:8080
    renodx::WebServer server;
    server.start(8080, "src/web/static");

    // Open the default browser to the documentation page
    system("start http://localhost:8080");  // Windows example
    return 0;
}

Shader Implementation References

Reshade Effect Sources in src/reshadefx/

Beyond markdown guides, the src/reshadefx/ directory contains executable documentation in the form of Reshade effect files. The ShortFuseRenoDRT.fx file serves as the primary reference implementation for HDR tonemapping algorithms, color space transformations, and other visual effects. These .fx files contain extensive inline comments that explain the mathematical operations and rendering techniques used by the framework.

Programmatic Integration Examples

MCP Swapchain Modifications

To understand the Modding Control Panel API, developers can reference the swapchain modification patterns detailed in docs/DEVKIT_MCP.md. The renodx::SwapchainV1 class provides the interface for injecting custom render logic:

// Example addon that registers a simple swap‑chain patch via the MCP
#include "renodx/mods/swapchain_v1.hpp"

void RegisterSwapchainPatch(renodx::SwapchainV1& swapchain)
{
    swapchain.add_pre_render_callback([]() {
        // Insert custom shader or modify render targets here
    });
}

This pattern demonstrates how to register add_pre_render_callback() functions that execute before the frame presentation, enabling real-time HDR adjustments and shader replacements.

Summary

• README.md provides the entry point for project overview and basic build instructions.
• docs/DEVKIT_MCP.md contains the Modding Control Panel integration guide for custom mod developers.
• docs/CONTRIBUTING.md specifies development setup requirements and contribution workflows.
• src/web/README.md documents the built-in web server for local documentation hosting.
• src/reshadefx/ShortFuseRenoDRT.fx serves as executable reference documentation for HDR shader implementations.
• The renodx::WebServer::start() method enables offline documentation browsing via localhost.
• The renodx::SwapchainV1::add_pre_render_callback() API is documented in the MCP developer kit.

Frequently Asked Questions

Where is the main renodx documentation entry point located?

The primary entry point is the README.md file at the repository root, which provides project descriptions, installation steps, and links to specialized guides. For web-based browsing, the src/web/README.md describes how to serve the documentation interface locally on localhost.

How do I set up the renodx development environment?

Follow the instructions in docs/CONTRIBUTING.md, which details the compiler requirements, dependency installation, and coding standards necessary for building the clshortfuse/renodx project from source. This file also specifies the pull request workflow required for submitting modifications to the HDR modding framework.

Can I view renodx documentation without an internet connection?

Yes. Clone the repository and use the src/web/static assets with the renodx::WebServer class. By calling server.start(8080, "src/web/static") as shown in the WebServer implementation, you can host the complete documentation site on your local machine at localhost:8080.

What programming references are available for HDR shader development?

The src/reshadefx/ShortFuseRenoDRT.fx file contains the reference implementation for HDR tonemapping and color grading techniques. This Reshade effect file includes inline documentation explaining the mathematical operations, making it the definitive technical resource for developers extending renodx with custom visual effects.

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}