This is the documentation for CC: Tweaked $modVersion for Minecraft $mcVersion. Documentation for other versions of Minecraft are available on the CC: Tweaked website:

- Minecraft 1.20.1
- Minecraft 1.21.1

# Quick links

You probably want to start in the following places:

- {@linkplain dan200.computercraft.api.peripheral Registering new peripherals}
- {@link dan200.computercraft.api.lua.LuaFunction} and {@link dan200.computercraft.api.lua.IArguments} for adding methods to your peripheral or Lua objects.
- {@linkplain dan200.computercraft.api.turtle.ITurtleUpgrade Turtle upgrades}
- {@linkplain dan200.computercraft.api.pocket.IPocketUpgrade Pocket upgrades}

# Using

CC: Tweaked is hosted on my maven repo, and so is relatively simple to depend on. You may wish to add a soft (or hard) dependency in your `mods.toml` file, with the appropriate version bounds, to ensure that API functionality you depend on is present.

    repositories {
        maven {
            url "https://maven.squiddev.cc"
            content { includeGroup("cc.tweaked") }
        }
    }

    dependencies {
        // Vanilla (i.e. for multi-loader systems)
        compileOnly("cc.tweaked:cc-tweaked-$mcVersion-common-api:$modVersion")

        // Forge Gradle
        compileOnly("cc.tweaked:cc-tweaked-$mcVersion-core-api:$modVersion")
        compileOnly(fg.deobf("cc.tweaked:cc-tweaked-$mcVersion-forge-api:$modVersion"))
        runtimeOnly(fg.deobf("cc.tweaked:cc-tweaked-$mcVersion-forge:$modVersion"))

        // Fabric Loom
        modCompileOnly("cc.tweaked:cc-tweaked-$mcVersion-fabric-api:$modVersion")
        modRuntimeOnly("cc.tweaked:cc-tweaked-$mcVersion-fabric:$modVersion")
    }

You should also be careful to only use classes within the `dan200.computercraft.api` package. Non-API classes are subject to change at any point. If you depend on functionality outside the API (or need to mixin to CC:T), please start a discussion to let me know!