MCMill

KO | EN

gitlite — search

#javascript #ai #machine-learning #rust #deep-learning #docker #nodejs #java #windows #awesome #cli #awesome-list #mcp #openai

(★ 9)

A Mill plugin for Minecraft Development

MCMill Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# MCMill

[![mcmill-spigot Scala version support](https://index.scala-lang.org/iltotore/mcmill/millmc-core/latest.svg)](https://index.scala-lang.org/iltotore/mcmill/millmc-core)

MCMill is a [Mill](https://github.com/com-lihaoyi/mill) plugin for Minecraft Development. It actually supports the
Spigot and Sponge APIs.

[Mill](https://github.com/com-lihaoyi/mill) is a lightweight and simple build tool using Scala for build scripts and
supports Java and Scala out of the box.

# Setup

## Import

You can import MCMIll in your buildscript by using the $ivy import syntax:

```scala
import $ivy.`io.github.iltotore::mcmill-<api>:<version>`
import io.github.iltotore.mcmill.<api>._
```

<details>
<summary>Example</summary>

```scala
import $ivy.`io.github.iltotore::mcmill-spigot:1.0.0`
import io.github.iltotore.mcmill.spigot._
```

</details>

## Spigot Support

You can set up a simple Spigot plugin by inheriting from the `SpigotModule` trait:

```scala
import $ivy.`io.github.iltotore::mcmill-spigot:version`
import io.github.iltotore.mcmill.spigot._

object spigot extends SpigotModule {

def spigotVersion = "1.19-R0.1-SNAPSHOT"

def spigotMetadata = SpigotMetadata(
    name = "plugin name",
    version = "0.1",
    mainClass = "path.to.your.MainClass"
  )
}
```

See [scaladoc](https://javadoc.io/doc/io.github.iltotore/mcmill-spigot_2.13/latest/io/github/iltotore/mcmill/spigot/index.html) for details.

### Automatic plugin dependency downloading

Spigot has an experimental `libraries` option in the `plugin.yml` file.
This option allows the developer to pass libraries to download before loading the plugin.

If `SpigotMetadata#downloadIvyDeps` is `true` (by default: `false`), MCMill will automatically add dependencies returned
by `pluginDeps` in the generated `plugin.yml`. Plugin dependencies are all runtime dependencies by default but can be
overridden:
```scala
object spigot extends SpigotModule {

def spigotVersion = "1.19-R0.1-SNAPSHOT"

def spigotMetadata = SpigotMetadata(
    name = "plugin name",
    version = "0.1",
    mainClass = "path.to.your.MainClass",
    downloadIvyDeps = true
  )
  
  def pluginIvyDeps = Agg( //Default: allIvyDeps() ++ runIvyDeps()
    ivy"org.group:special-dep-needed-before-enabling-this-plugin:version"
  )
}
```

### Paper support

If you want to use the Paper API, use `PaperModule`. This module extends from `SpigotModule` and has the same usage.

```scala
import $ivy.`io.github.iltotore::mcmill-spigot:version`
import io.github.iltotore.mcmill.spigot._

object paper extends PaperModule {

def spigotVersion = "1.19-R0.1-SNAPSHOT"

def spigotMetadata = SpigotMetadata(
    name = "plugin name",
    version = "0.1",
    mainClass = "path.to.your.MainClass"
  )
}
```

## Sponge Support

You can set up a simple Sponge plugin by inheriting from the `SpongeModule` trait:

```scala
import mill._, scalalib._

import $ivy.`io.github.iltotore::mcmill-sponge:version`
import io.github.iltotore.mcmill.sponge._

object main extends SpongeModule {

def spongeVersion = "9.0.0"

def spongeMetadata = SpongeMetadata(
    modId = "modid",
    name = "YourPluginName",
    version = "0.1"
  )
}
```

See [scaladoc](https://javadoc.io/doc/io.github.iltotore/mcmill-sponge_2.13/latest/io/github/iltotore/mcmill/sponge/index.html) for details.

**Note: If you use [SpongeScala](https://github.com/Iltotore/SpongeScala), you can use the SpongeScalaModule**

## Scaladoc
- [Core](https://javadoc.io/doc/io.github.iltotore/millmc-core_2.13/latest/io/github/iltotore/mcmill/index.html)
- [Spigot](https://javadoc.io/doc/io.github.iltotore/mcmill-spigot_2.13/latest/io/github/iltotore/mcmill/spigot/index.html)
- [Sponge](https://javadoc.io/doc/io.github.iltotore/mcmill-sponge_2.13/latest/io/github/iltotore/mcmill/sponge/index.html)

MCMill

MCMill Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

MCMill

MCMill Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README