> For the complete documentation index, see [llms.txt](https://docs.gmitch215.dev/socketmc/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gmitch215.dev/socketmc/home.md).

# Home

This is the detailed wiki page for SocketMC. For the basics, see the [GitHub](https://github.com/gmitch215/SocketMC/wiki) Page.

## 📥 Installation

[![GitHub branch checks state](https://github.com/gmitch215/SocketMC/actions/workflows/build.yml/badge.svg)](https://github.com/gmitch215/SocketMC/actions/workflows/build.yml) [![GitHub](https://img.shields.io/github/license/gmitch215/SocketMC)](https://github.com/gmitch215/SocketMC?tab=GPL-3.0-1-ov-file#readme) [![GitHub issues](https://img.shields.io/github/issues/gmitch215/SocketMC)](https://github.com/gmitch215/SocketMC/issues)

### Prerequisites

All players on your server must have the SocketMC mod installed. You can download them from the following locations:

* [Modrinth](https://modrinth.com/mod/socketmc)
* [Jenkins CI](https://ci.codemc.io/job/gmitch215/job/SocketMC/)
* [GitHub Releases](https://github.com/gmitch215/SocketMC/releases/latest)
* [GitHub Actions](https://github.com/gmitch215/SocketMC/actions/workflows/build.yml)

#### In your Plugin

![GitHub release (latest by date)](https://img.shields.io/github/v/release/gmitch215/SocketMC) [![Static Badge](https://img.shields.io/badge/documentation-javadoc-yellow)](https://socketmc.gmitch215.xyz/) [![Static Badge](https://img.shields.io/badge/wiki-github-dgreen)](https://github.com/gmitch215/SocketMC/wiki) [![Static Badge](https://img.shields.io/badge/detailed_wiki-gitbook-dgreen)](https://docs.gmitch215.xyz/socketmc/)

<details>

<summary>Maven</summary>

```xml
<project>
    
    <!-- Import CodeMC Repo -->
    
    <repositories>
        <repository>
            <id>codemc-releases</id>
            <url>https://repo.codemc.io/repository/maven-releases/</url>
        </repository>
    </repositories>
    
    <dependencies>
        <!-- Include Core Module -->
        <dependency>
          <groupId>me.gamercoder215.socketmc</groupId>
          <artifactId>socketmc-core</artifactId>
          <version>[VERSION]</version>
        </dependency>
        <dependency>
            <groupId>me.gamercoder215.socketmc</groupId>
            <artifactId>socketmc-spigot</artifactId>
            <version>[VERSION]</version>
        </dependency>
        
        <!-- Alternatively, use the Paper Build -->
        <dependency>
            <groupId>me.gamercoder215.socketmc</groupId>
            <artifactId>socketmc-paper</artifactId>
            <version>[VERSION]</version>
        </dependency>
    </dependencies>
    
</project>
```

</details>

<details>

<summary>Gradle (Groovy)</summary>

```gradle
repositories {
    maven { url 'https://repo.codemc.io/repository/maven-releases/' }
}

dependencies {
    // Include Core Module
    implementation 'me.gamercoder215.socketmc:socketmc-core:[VERSION]'
    implementation 'me.gamercoder215.socketmc:socketmc-spigot:[VERSION]'
    
    // Alternatively, use the Paper Build
    implementation 'me.gamercoder215.socketmc:socketmc-paper:[VERSION]'
}
```

</details>

<details>

<summary>Gradle (Kotlin DSL)</summary>

```kotlin
repositories {
    maven(url = "https://repo.codemc.io/repository/maven-releases/")
}

dependencies {
    // Include Core Module
    implementation("me.gamercoder215.socketmc:socketmc-core:[VERSION]")
    implementation("me.gamercoder215.socketmc:socketmc-spigot:[VERSION]")
    
    // Alternatively, use the Paper Build
    implementation("me.gamercoder215.socketmc:socketmc-paper:[VERSION]")
}
```

</details>