> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/modrinth/code/llms.txt
> Use this file to discover all available pages before exploring further.

# Modrinth Documentation

> The open-source platform for discovering, installing, and hosting Minecraft mods, modpacks, and plugins

<div className="relative bg-gradient-to-br from-[#121826] via-[#17221f] to-[#0f1117] dark:from-[#121826] dark:via-[#17221f] dark:to-[#0f1117] py-20 overflow-hidden">
  <div className="absolute inset-0 bg-[radial-gradient(circle_at_50%_120%,rgba(4,172,92,0.1),transparent_50%)]" />

  <div className="max-w-6xl mx-auto px-6 relative z-10">
    <div className="text-center">
      <h1 className="text-5xl sm:text-6xl lg:text-7xl font-bold text-white mb-6">
        Welcome to Modrinth
      </h1>

      <p className="text-xl sm:text-2xl text-gray-300 dark:text-gray-300 max-w-3xl mx-auto mb-10">
        The open-source platform for discovering, installing, and hosting Minecraft content. Built by the community, for the community.
      </p>

      <div className="flex flex-wrap gap-4 justify-center">
        <a href="/quickstart" className="inline-flex items-center px-8 py-3.5 text-base font-semibold text-black bg-[#04ac5c] hover:bg-[#1fd56c] rounded-lg transition-colors">
          Get Started
        </a>

        <a href="/api/overview" className="inline-flex items-center px-8 py-3.5 text-base font-semibold text-white bg-white/10 hover:bg-white/20 border border-white/30 rounded-lg transition-colors">
          Explore API
        </a>
      </div>
    </div>
  </div>
</div>

<div className="mt-16 mb-16 max-w-5xl mx-auto px-6">
  ## Quick Start

  Get up and running with Modrinth in minutes.

  <Steps>
    <Step title="Create an account">
      Sign up at [modrinth.com](https://modrinth.com) to start discovering and managing your Minecraft content. You can use your email, GitHub, Discord, or other OAuth providers.
    </Step>

    <Step title="Browse or download the app">
      Explore thousands of mods, modpacks, and plugins on the web interface, or download the [Modrinth App](https://modrinth.com/app) for a complete launcher experience with instance management.
    </Step>

    <Step title="Install your first mod">
      Search for a mod or modpack, click the install button, and Modrinth handles the rest. The app automatically downloads dependencies and manages Minecraft versions for you.
    </Step>

    <Step title="Start playing">
      Launch your configured Minecraft instance directly from the Modrinth App, or manually install downloaded mods into your existing launcher.
    </Step>
  </Steps>
</div>

<div className="mt-16 mb-16 max-w-5xl mx-auto px-6">
  ## Explore by role

  <CardGroup cols={2}>
    <Card title="For Players" icon="gamepad" href="/players/installing-mods">
      Discover mods, create modpacks, and manage your Minecraft instances with the Modrinth App.
    </Card>

    <Card title="For Creators" icon="brush" href="/creators/creating-projects">
      Publish your mods, track analytics, collaborate with teams, and monetize your content.
    </Card>

    <Card title="For Developers" icon="code" href="/api/overview">
      Integrate with Modrinth's API to build tools, launchers, and custom workflows.
    </Card>

    <Card title="For Contributors" icon="users" href="/development/contributing">
      Help build Modrinth by contributing to the open-source codebase on GitHub.
    </Card>
  </CardGroup>
</div>

<div className="mt-16 mb-16 max-w-5xl mx-auto px-6">
  ## Platform features

  <CardGroup cols={3}>
    <Card title="Web Interface" icon="browser" href="/platform/web-interface">
      Browse, search, and manage projects from any device with the responsive web interface.
    </Card>

    <Card title="Desktop App" icon="desktop" href="/platform/desktop-app">
      A powerful cross-platform launcher with instance management and automatic dependency resolution.
    </Card>

    <Card title="Server Hosting" icon="server" href="/hosting/getting-started">
      Host Minecraft servers directly on Modrinth with automatic backups and WebSocket management.
    </Card>

    <Card title="RESTful API" icon="plug" href="/api/overview">
      Comprehensive REST API with OpenAPI documentation for integrations and custom tools.
    </Card>

    <Card title="Team Collaboration" icon="people-group" href="/creators/teams-and-permissions">
      Manage projects with your team using granular permissions and role-based access control.
    </Card>

    <Card title="Analytics & Monetization" icon="chart-line" href="/creators/analytics">
      Track downloads, views, and revenue with built-in analytics and creator monetization tools.
    </Card>
  </CardGroup>
</div>

<div className="mt-16 mb-16 max-w-5xl mx-auto px-6">
  ## API Reference

  Integrate Modrinth into your tools and workflows.

  <CardGroup cols={2}>
    <Card title="REST API" icon="webhook" href="/api/overview">
      Access projects, versions, users, and search with the Labrinth REST API (v2 and v3).
    </Card>

    <Card title="WebSocket API" icon="satellite-dish" href="/api/websocket">
      Real-time server management with WebSocket connections for logs, stats, and commands.
    </Card>

    <Card title="JavaScript Client" icon="js" href="/api/javascript-client">
      Official TypeScript/JavaScript client library for Nuxt, Tauri, and Node.js environments.
    </Card>

    <Card title="Rust Client" icon="rust" href="/api/rust-client">
      Theseus library for Minecraft launcher functionality and Modrinth API integration in Rust.
    </Card>
  </CardGroup>
</div>

<div className="mt-16 mb-16 max-w-5xl mx-auto px-6">
  ## Resources

  <CardGroup cols={2}>
    <Card title="GitHub Repository" icon="github" href="https://github.com/modrinth/code">
      View the source code, report issues, and contribute to the Modrinth monorepo.
    </Card>

    <Card title="Discord Community" icon="discord" href="https://discord.modrinth.com">
      Join thousands of users and developers in the Modrinth Discord server.
    </Card>

    <Card title="Support Center" icon="life-ring" href="https://support.modrinth.com">
      Get help with common issues and submit support tickets.
    </Card>

    <Card title="Contributing Guide" icon="hands-helping" href="/development/contributing">
      Learn how to contribute code, documentation, and translations to Modrinth.
    </Card>
  </CardGroup>
</div>

<div className="mt-20 mb-16 max-w-5xl mx-auto px-6">
  <div className="bg-gradient-to-r from-[#17221f] to-[#121826] dark:from-[#17221f] dark:to-[#121826] rounded-2xl border border-[#04ac5c]/30 p-8 sm:p-12 text-center">
    <h2 className="text-3xl sm:text-4xl font-bold text-white mb-4">
      Ready to get started?
    </h2>

    <p className="text-lg text-gray-300 dark:text-gray-300 max-w-2xl mx-auto mb-8">
      Whether you're a player looking for mods, a creator publishing content, or a developer building integrations, Modrinth has the tools you need.
    </p>

    <a href="/quickstart" className="inline-flex items-center px-8 py-3.5 text-base font-semibold text-black bg-[#04ac5c] hover:bg-[#1fd56c] rounded-lg transition-colors">
      Get Started Now
    </a>
  </div>
</div>