Update to 1.20.4

One common issue we get when a program exits after handling a "key"
event is that it leaves the "char" event on the queue. This means that
the shell (or whatever program we switch in to) then receives the "char"
event, often displaying it to the screen.

Previously we've got around this by doing sleep(0) before exiting the
program. However, we also see this problem in edit's run handler script,
and I'm less comfortable doing the same hack there.

This adds a new internal discard_char function, which will either
wait one tick or return when seeing a char/key_up event.

Fixes #1705

.gitignore

@@ -7,6 +7,7 @@
 /logs
 /build
 /projects/*/logs
+/projects/fabric/fabricloader.log
 /projects/*/build
 /buildSrc/build
 /out

.pre-commit-config.yaml

@@ -6,7 +6,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v4.0.1
+  rev: v4.4.0
   hooks:
   - id: trailing-whitespace
   - id: end-of-file-fixer
@@ -20,14 +20,14 @@ repos:
     exclude: "tsconfig\\.json$"
 
 - repo: https://github.com/editorconfig-checker/editorconfig-checker.python
-  rev: 2.3.54
+  rev: 2.7.2
   hooks:
   - id: editorconfig-checker
     args: ['-disable-indentation']
     exclude: "^(.*\\.(bat)|LICENSE)$"
 
 - repo: https://github.com/fsfe/reuse-tool
-  rev: v1.1.0
+  rev: v2.1.0
   hooks:
   - id: reuse
 
@@ -44,7 +44,7 @@ repos:
     name: Check Java codestyle
     files: ".*\\.java$"
     language: system
-    entry: ./gradlew checkstyleMain checkstyleTest
+    entry: ./gradlew checkstyle
     pass_filenames: false
     require_serial: true
   - id: illuaminate

.reuse/dep5

@@ -10,8 +10,8 @@ Files:
   projects/common/src/testMod/resources/data/cctest/structures/*
   projects/fabric/src/generated/*
   projects/forge/src/generated/*
-  projects/web/src/export/index.json
-  projects/web/src/export/items/minecraft/*
+  projects/web/src/htmlTransform/export/index.json
+  projects/web/src/htmlTransform/export/items/minecraft/*
 Comment: Generated/data files are CC0.
 Copyright: The CC: Tweaked Developers
 License: CC0-1.0
@@ -37,10 +37,10 @@ Files:
   projects/fabric/src/testMod/resources/computercraft-gametest.fabric.mixins.json
   projects/fabric/src/testMod/resources/fabric.mod.json
   projects/forge/src/client/resources/computercraft-client.forge.mixins.json
-  projects/web/src/mount/.settings
-  projects/web/src/mount/example.nfp
-  projects/web/src/mount/example.nft
-  projects/web/src/mount/expr_template.lua
+  projects/web/src/frontend/mount/.settings
+  projects/web/src/frontend/mount/example.nfp
+  projects/web/src/frontend/mount/example.nft
+  projects/web/src/frontend/mount/expr_template.lua
   projects/web/tsconfig.json
 Comment: Several assets where it's inconvenient to create a .license file.
 Copyright: The CC: Tweaked Developers
@@ -53,19 +53,32 @@ Files:
   projects/common/src/main/resources/assets/computercraft/textures/*
   projects/common/src/main/resources/pack.mcmeta
   projects/common/src/main/resources/pack.png
+  projects/core/src/main/resources/assets/computercraft/textures/gui/term_font.png
   projects/core/src/main/resources/data/computercraft/lua/rom/autorun/.ignoreme
   projects/core/src/main/resources/data/computercraft/lua/rom/help/*
   projects/core/src/main/resources/data/computercraft/lua/rom/programs/fun/advanced/levels/*
-  projects/web/src/export/items/computercraft/*
+  projects/web/src/htmlTransform/export/items/computercraft/*
 Comment: Bulk-license original assets as CCPL.
 Copyright: 2011 Daniel Ratcliffe
 License: LicenseRef-CCPL
 
+Files:
+  projects/common/src/main/resources/assets/computercraft/lang/cs_cz.json
+  projects/common/src/main/resources/assets/computercraft/lang/ko_kr.json
+  projects/common/src/main/resources/assets/computercraft/lang/pl_pl.json
+  projects/common/src/main/resources/assets/computercraft/lang/pt_br.json
+  projects/common/src/main/resources/assets/computercraft/lang/ru_ru.json
+  projects/common/src/main/resources/assets/computercraft/lang/uk_ua.json
+  projects/common/src/main/resources/assets/computercraft/lang/zh_cn.json
+Comment: Community-contributed license files
+Copyright: 2017 The CC: Tweaked Developers
+License: LicenseRef-CCPL
+
 Files:
   projects/common/src/main/resources/assets/computercraft/lang/*
 Comment: Community-contributed license files
 Copyright: 2017 The CC: Tweaked Developers
-License: LicenseRef-CCPL
+License: MPL-2.0
 
 Files:
   .github/*

CONTRIBUTING.md

@@ -100,7 +100,6 @@ about how you can build on that until you've covered everything!
 [new-issue]: https://github.com/cc-tweaked/CC-Tweaked/issues/new/choose "Create a new issue"
 [community]: README.md#community "Get in touch with the community."
 [Adoptium]: https://adoptium.net/temurin/releases?version=17 "Download OpenJDK 17"
-[checkstyle]: https://checkstyle.org/
 [illuaminate]: https://github.com/SquidDev/illuaminate/ "Illuaminate on GitHub"
 [weblate]: https://i18n.tweaked.cc/projects/cc-tweaked/minecraft/ "CC: Tweaked weblate instance"
 [docs]: https://tweaked.cc/ "CC: Tweaked documentation"

README.md

@@ -42,7 +42,6 @@ repositories {
     url "https://squiddev.cc/maven/"
     content {
       includeGroup("cc.tweaked")
-      includeModule("org.squiddev", "Cobalt")
     }
   }
 }
@@ -52,9 +51,8 @@ dependencies {
   compileOnly("cc.tweaked:cc-tweaked-$mcVersion-common-api:$cctVersion")
 
   // Forge Gradle
-  compileOnly("cc.tweaked:cc-tweaked-$mcVersion-core-api:$cctVersion")
-  compileOnly(fg.deobf("cc.tweaked:cc-tweaked-$mcVersion-forge-api:$cctVersion"))
-  runtimeOnly(fg.deobf("cc.tweaked:cc-tweaked-$mcVersion-forge:$cctVersion"))
+  compileOnly("cc.tweaked:cc-tweaked-$mcVersion-forge-api:$cctVersion")
+  runtimeOnly("cc.tweaked:cc-tweaked-$mcVersion-forge:$cctVersion")
 
   // Fabric Loom
   modCompileOnly("cc.tweaked:cc-tweaked-$mcVersion-fabric-api:$cctVersion")
@@ -76,8 +74,8 @@ minecraft {
 ```
 
 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, file an issue, and we can look into
-exposing more features.
+subject to change at any point. If you depend on functionality outside the API (or need to mixin to CC:T), please file
+an issue to let me know!
 
 We bundle the API sources with the jar, so documentation should be easily viewable within your editor. Alternatively,
 the generated documentation [can be browsed online](https://tweaked.cc/javadoc/).

build.gradle.kts

@@ -2,13 +2,19 @@
 //
 // SPDX-License-Identifier: MPL-2.0
 
+import cc.tweaked.gradle.JUnitExt
+import net.fabricmc.loom.api.LoomGradleExtensionAPI
+import net.fabricmc.loom.util.gradle.SourceSetHelper
 import org.jetbrains.gradle.ext.compiler
+import org.jetbrains.gradle.ext.runConfigurations
 import org.jetbrains.gradle.ext.settings
 
 plugins {
     publishing
     alias(libs.plugins.taskTree)
     alias(libs.plugins.githubRelease)
+    alias(libs.plugins.gradleVersions)
+    alias(libs.plugins.versionCatalogUpdate)
     id("org.jetbrains.gradle.plugin.idea-ext")
     id("cc-tweaked")
 }
@@ -38,6 +44,50 @@ githubRelease {
 
 tasks.publish { dependsOn(tasks.githubRelease) }
 
+idea.project.settings.runConfigurations {
+    register<JUnitExt>("Core Tests") {
+        vmParameters = "-ea"
+        moduleName = "${idea.project.name}.core.test"
+        packageName = ""
+    }
+
+    register<JUnitExt>("CraftOS Tests") {
+        vmParameters = "-ea"
+        moduleName = "${idea.project.name}.core.test"
+        className = "dan200.computercraft.core.ComputerTestDelegate"
+    }
+
+    register<JUnitExt>("CraftOS Tests (Fast)") {
+        vmParameters = "-ea -Dcc.skip_keywords=slow"
+        moduleName = "${idea.project.name}.core.test"
+        className = "dan200.computercraft.core.ComputerTestDelegate"
+    }
+
+    register<JUnitExt>("Common Tests") {
+        vmParameters = "-ea"
+        moduleName = "${idea.project.name}.common.test"
+        packageName = ""
+    }
+
+    register<JUnitExt>("Fabric Tests") {
+        val fabricProject = evaluationDependsOn(":fabric")
+        val classPathGroup = fabricProject.extensions.getByType<LoomGradleExtensionAPI>().mods
+            .joinToString(File.pathSeparator + File.pathSeparator) { modSettings ->
+                SourceSetHelper.getClasspath(modSettings, project).joinToString(File.pathSeparator) { it.absolutePath }
+            }
+
+        vmParameters = "-ea -Dfabric.classPathGroups=$classPathGroup"
+        moduleName = "${idea.project.name}.fabric.test"
+        packageName = ""
+    }
+
+    register<JUnitExt>("Forge Tests") {
+        vmParameters = "-ea"
+        moduleName = "${idea.project.name}.forge.test"
+        packageName = ""
+    }
+}
+
 idea.project.settings.compiler.javac {
     // We want ErrorProne to be present when compiling via IntelliJ, as it offers some helpful warnings
     // and errors. Loop through our source sets and find the appropriate flags.
@@ -54,3 +104,9 @@ idea.project.settings.compiler.javac {
         }
         .toMap()
 }
+
+versionCatalogUpdate {
+    sortByKey.set(false)
+    pin { versions.addAll("fastutil", "guava", "netty", "slf4j") }
+    keep { keepUnusedLibraries.set(true) }
+}

buildSrc/build.gradle.kts

@@ -5,6 +5,8 @@
 plugins {
     `java-gradle-plugin`
     `kotlin-dsl`
+    alias(libs.plugins.gradleVersions)
+    alias(libs.plugins.versionCatalogUpdate)
 }
 
 // Duplicated in settings.gradle.kts
@@ -12,25 +14,14 @@ repositories {
     mavenCentral()
     gradlePluginPortal()
 
-    maven("https://maven.minecraftforge.net") {
-        name = "Forge"
+    maven("https://maven.neoforged.net/releases") {
+        name = "NeoForge"
         content {
             includeGroup("net.minecraftforge")
-            includeGroup("net.minecraftforge.gradle")
-        }
-    }
-
-    maven("https://maven.parchmentmc.org") {
-        name = "Librarian"
-        content {
-            includeGroupByRegex("^org\\.parchmentmc.*")
-        }
-    }
-
-    maven("https://repo.spongepowered.org/repository/maven-public/") {
-        name = "Sponge"
-        content {
-            includeGroup("org.spongepowered")
+            includeGroup("net.neoforged")
+            includeGroup("net.neoforged.gradle")
+            includeModule("codechicken", "DiffPatch")
+            includeModule("net.covers1624", "Quack")
         }
     }
 
@@ -40,6 +31,13 @@ repositories {
             includeGroup("net.fabricmc")
         }
     }
+
+    maven("https://squiddev.cc/maven") {
+        name = "SquidDev"
+        content {
+            includeGroup("cc.tweaked.vanilla-extract")
+        }
+    }
 }
 
 dependencies {
@@ -49,11 +47,10 @@ dependencies {
 
     implementation(libs.curseForgeGradle)
     implementation(libs.fabric.loom)
-    implementation(libs.forgeGradle)
-    implementation(libs.librarian)
+    implementation(libs.ideaExt)
     implementation(libs.minotaur)
-    implementation(libs.quiltflower)
-    implementation(libs.vanillaGradle)
+    implementation(libs.neoGradle.userdev)
+    implementation(libs.vanillaExtract)
 }
 
 gradlePlugin {
@@ -74,3 +71,9 @@ gradlePlugin {
         }
     }
 }
+
+versionCatalogUpdate {
+    sortByKey.set(false)
+    keep { keepUnusedLibraries.set(true) }
+    catalogFile.set(file("../gradle/libs.versions.toml"))
+}

buildSrc/src/main/kotlin/cc-tweaked.fabric.gradle.kts

@@ -12,7 +12,6 @@ import cc.tweaked.gradle.MinecraftConfigurations
 plugins {
     `java-library`
     id("fabric-loom")
-    id("io.github.juuxel.loom-quiltflower")
     id("cc-tweaked.java-convention")
 }
 

buildSrc/src/main/kotlin/cc-tweaked.forge.gradle.kts

@@ -10,10 +10,8 @@ import cc.tweaked.gradle.IdeaRunConfigurations
 import cc.tweaked.gradle.MinecraftConfigurations
 
 plugins {
-    id("net.minecraftforge.gradle")
-    // We must apply java-convention after Forge, as we need the fg extension to be present.
     id("cc-tweaked.java-convention")
-    id("org.parchmentmc.librarian.forgegradle")
+    id("net.neoforged.gradle.userdev")
 }
 
 plugins.apply(CCTweakedPlugin::class.java)
@@ -21,10 +19,20 @@ plugins.apply(CCTweakedPlugin::class.java)
 val mcVersion: String by extra
 
 minecraft {
-    val libs = project.extensions.getByType<VersionCatalogsExtension>().named("libs")
-    mappings("parchment", "${libs.findVersion("parchmentMc").get()}-${libs.findVersion("parchment").get()}-$mcVersion")
+    modIdentifier("computercraft")
+}
 
-    accessTransformer(project(":forge").file("src/main/resources/META-INF/accesstransformer.cfg"))
+subsystems {
+    parchment {
+        val libs = project.extensions.getByType<VersionCatalogsExtension>().named("libs")
+        minecraftVersion = libs.findVersion("parchmentMc").get().toString()
+        mappingsVersion = libs.findVersion("parchment").get().toString()
+    }
+}
+
+dependencies {
+    val libs = project.extensions.getByType<VersionCatalogsExtension>().named("libs")
+    implementation("net.neoforged:neoforge:${libs.findVersion("neoForge").get()}")
 }
 
 MinecraftConfigurations.setup(project)
@@ -32,13 +40,3 @@ MinecraftConfigurations.setup(project)
 extensions.configure(CCTweakedExtension::class.java) {
     linters(minecraft = true, loader = "forge")
 }
-
-dependencies {
-    val libs = project.extensions.getByType<VersionCatalogsExtension>().named("libs")
-    "minecraft"("net.minecraftforge:forge:$mcVersion-${libs.findVersion("forge").get()}")
-}
-
-tasks.configureEach {
-    // genIntellijRuns isn't registered until much later, so we need this silly hijinks.
-    if (name == "genIntellijRuns") doLast { IdeaRunConfigurations(project).patch() }
-}

buildSrc/src/main/kotlin/cc-tweaked.java-convention.gradle.kts

@@ -40,32 +40,23 @@ repositories {
 
     val mainMaven = maven("https://squiddev.cc/maven") {
         name = "SquidDev"
-        content {
-            // Until https://github.com/SpongePowered/Mixin/pull/593 is merged
-            includeModule("org.spongepowered", "mixin")
-        }
     }
 
     exclusiveContent {
         forRepositories(mainMaven)
-
-        // Include the ForgeGradle repository if present. This requires that ForgeGradle is already present, which we
-        // enforce in our Forge overlay.
-        val fg =
-            project.extensions.findByType(net.minecraftforge.gradle.userdev.DependencyManagementExtension::class.java)
-        if (fg != null) forRepositories(fg.repository)
-
         filter {
             includeGroup("cc.tweaked")
-            includeModule("org.squiddev", "Cobalt")
             // Things we mirror
+            includeGroup("commoble.morered")
             includeGroup("dev.architectury")
             includeGroup("dev.emi")
             includeGroup("maven.modrinth")
             includeGroup("me.shedaniel.cloth")
             includeGroup("me.shedaniel")
             includeGroup("mezz.jei")
+            includeGroup("org.teavm")
             includeModule("com.terraformersmc", "modmenu")
+            includeModule("me.lucko", "fabric-permissions-api")
         }
     }
 }
@@ -74,6 +65,12 @@ dependencies {
     val libs = project.extensions.getByType<VersionCatalogsExtension>().named("libs")
     checkstyle(libs.findLibrary("checkstyle").get())
 
+    constraints {
+        checkstyle("org.codehaus.plexus:plexus-container-default:2.1.1") {
+            because("2.1.0 depends on deprecated Google collections module")
+        }
+    }
+
     errorprone(libs.findLibrary("errorProne-core").get())
     errorprone(libs.findLibrary("nullAway").get())
 }
@@ -97,7 +94,10 @@ sourceSets.all {
             check("FutureReturnValueIgnored", CheckSeverity.OFF) // Too many false positives with Netty
 
             check("NullAway", CheckSeverity.ERROR)
-            option("NullAway:AnnotatedPackages", listOf("dan200.computercraft", "net.fabricmc.fabric.api").joinToString(","))
+            option(
+                "NullAway:AnnotatedPackages",
+                listOf("dan200.computercraft", "cc.tweaked", "net.fabricmc.fabric.api").joinToString(","),
+            )
             option("NullAway:ExcludedFieldAnnotations", listOf("org.spongepowered.asm.mixin.Shadow").joinToString(","))
             option("NullAway:CastToNonNullMethod", "dan200.computercraft.core.util.Nullability.assertNonNull")
             option("NullAway:CheckOptionalEmptiness")
@@ -172,6 +172,12 @@ project.plugins.withType(CCTweakedPlugin::class.java) {
     }
 }
 
+tasks.register("checkstyle") {
+    description = "Run Checkstyle on all sources"
+    group = LifecycleBasePlugin.VERIFICATION_GROUP
+    dependsOn(tasks.withType(Checkstyle::class.java))
+}
+
 spotless {
     encoding = StandardCharsets.UTF_8
     lineEndings = LineEnding.UNIX
@@ -189,6 +195,8 @@ spotless {
 
     val ktlintConfig = mapOf(
         "ktlint_standard_no-wildcard-imports" to "disabled",
+        "ktlint_standard_class-naming" to "disabled",
+        "ktlint_standard_function-naming" to "disabled",
         "ij_kotlin_allow_trailing_comma" to "true",
         "ij_kotlin_allow_trailing_comma_on_call_site" to "true",
     )

buildSrc/src/main/kotlin/cc-tweaked.vanilla.gradle.kts

@@ -10,25 +10,31 @@ import cc.tweaked.gradle.MinecraftConfigurations
 
 plugins {
     id("cc-tweaked.java-convention")
-    id("org.spongepowered.gradle.vanilla")
+    id("cc.tweaked.vanilla-extract")
 }
 
 plugins.apply(CCTweakedPlugin::class.java)
 
 val mcVersion: String by extra
 
+val libs = project.extensions.getByType<VersionCatalogsExtension>().named("libs")
+
 minecraft {
     version(mcVersion)
+
+    mappings {
+        parchment(libs.findVersion("parchmentMc").get().toString(), libs.findVersion("parchment").get().toString())
+    }
+
+    unpick(libs.findLibrary("yarn").get())
 }
 
 dependencies {
-    val libs = project.extensions.getByType<VersionCatalogsExtension>().named("libs")
-
     // Depend on error prone annotations to silence a lot of compile warnings.
-    compileOnlyApi(libs.findLibrary("errorProne.annotations").get())
+    compileOnly(libs.findLibrary("errorProne.annotations").get())
 }
 
-MinecraftConfigurations.setup(project)
+MinecraftConfigurations.setupBasic(project)
 
 extensions.configure(CCTweakedExtension::class.java) {
     linters(minecraft = true, loader = null)

buildSrc/src/main/kotlin/cc/tweaked/gradle/CCTweakedExtension.kt

@@ -10,9 +10,11 @@ import org.gradle.api.GradleException
 import org.gradle.api.NamedDomainObjectProvider
 import org.gradle.api.Project
 import org.gradle.api.Task
+import org.gradle.api.artifacts.Dependency
 import org.gradle.api.attributes.TestSuiteType
 import org.gradle.api.file.FileSystemOperations
 import org.gradle.api.plugins.JavaPluginExtension
+import org.gradle.api.provider.ListProperty
 import org.gradle.api.provider.Provider
 import org.gradle.api.provider.SetProperty
 import org.gradle.api.reporting.ReportingExtension
@@ -73,11 +75,17 @@ abstract class CCTweakedExtension(
      */
     val sourceDirectories: SetProperty<SourceSetReference> = project.objects.setProperty(SourceSetReference::class.java)
 
+    /**
+     * Dependencies excluded from published artifacts.
+     */
+    private val excludedDeps: ListProperty<Dependency> = project.objects.listProperty(Dependency::class.java)
+
     /** All source sets referenced by this project. */
     val sourceSets = sourceDirectories.map { x -> x.map { it.sourceSet } }
 
     init {
         sourceDirectories.finalizeValueOnRead()
+        excludedDeps.finalizeValueOnRead()
         project.afterEvaluate { sourceDirectories.disallowChanges() }
     }
 
@@ -173,7 +181,7 @@ abstract class CCTweakedExtension(
     }
 
     fun <T> jacoco(task: NamedDomainObjectProvider<T>) where T : Task, T : JavaForkOptions {
-        val classDump = project.buildDir.resolve("jacocoClassDump/${task.name}")
+        val classDump = project.layout.buildDirectory.dir("jacocoClassDump/${task.name}")
         val reportTaskName = "jacoco${task.name.capitalized()}Report"
 
         val jacoco = project.extensions.getByType(JacocoPluginExtension::class.java)
@@ -185,7 +193,7 @@ abstract class CCTweakedExtension(
             jacoco.applyTo(this)
             extensions.configure(JacocoTaskExtension::class.java) {
                 includes = listOf("dan200.computercraft.*")
-                classDumpDir = classDump
+                classDumpDir = classDump.get().asFile
 
                 // Older versions of modlauncher don't include a protection domain (and thus no code
                 // source). Jacoco skips such classes by default, so we need to explicitly include them.
@@ -246,6 +254,20 @@ abstract class CCTweakedExtension(
         ).resolve().single()
     }
 
+    /**
+     * Exclude a dependency from being published in Maven.
+     */
+    fun exclude(dep: Dependency) {
+        excludedDeps.add(dep)
+    }
+
+    /**
+     * Configure a [MavenDependencySpec].
+     */
+    fun configureExcludes(spec: MavenDependencySpec) {
+        for (dep in excludedDeps.get()) spec.exclude(dep)
+    }
+
     companion object {
         private val COMMIT_COUNTS = Pattern.compile("""^\s*[0-9]+\s+(.*)$""")
         private val IGNORED_USERS = setOf(

buildSrc/src/main/kotlin/cc/tweaked/gradle/CCTweakedPlugin.kt

@@ -9,6 +9,10 @@ import org.gradle.api.Project
 import org.gradle.api.plugins.JavaPlugin
 import org.gradle.api.plugins.JavaPluginExtension
 import org.gradle.jvm.toolchain.JavaLanguageVersion
+import org.gradle.plugins.ide.idea.model.IdeaModel
+import org.jetbrains.gradle.ext.IdeaExtPlugin
+import org.jetbrains.gradle.ext.runConfigurations
+import org.jetbrains.gradle.ext.settings
 
 /**
  * Configures projects to match a shared configuration.
@@ -21,6 +25,20 @@ class CCTweakedPlugin : Plugin<Project> {
             val sourceSets = project.extensions.getByType(JavaPluginExtension::class.java).sourceSets
             cct.sourceDirectories.add(SourceSetReference.internal(sourceSets.getByName("main")))
         }
+
+        project.plugins.withType(IdeaExtPlugin::class.java) { extendIdea(project) }
+    }
+
+    /**
+     * Extend the [IdeaExtPlugin] plugin's `runConfiguration` container to also support [JUnitExt].
+     */
+    private fun extendIdea(project: Project) {
+        val ideaModel = project.extensions.findByName("idea") as IdeaModel? ?: return
+        val ideaProject = ideaModel.project ?: return
+
+        ideaProject.settings.runConfigurations {
+            registerFactory(JUnitExt::class.java) { name -> project.objects.newInstance(JUnitExt::class.java, name) }
+        }
     }
 
     companion object {

buildSrc/src/main/kotlin/cc/tweaked/gradle/DependencyCheck.kt

@@ -0,0 +1,92 @@
+// SPDX-FileCopyrightText: 2023 The CC: Tweaked Developers
+//
+// SPDX-License-Identifier: MPL-2.0
+
+package cc.tweaked.gradle
+
+import org.gradle.api.DefaultTask
+import org.gradle.api.GradleException
+import org.gradle.api.artifacts.Configuration
+import org.gradle.api.artifacts.MinimalExternalModuleDependency
+import org.gradle.api.artifacts.component.ModuleComponentIdentifier
+import org.gradle.api.artifacts.component.ModuleComponentSelector
+import org.gradle.api.artifacts.component.ProjectComponentIdentifier
+import org.gradle.api.artifacts.result.DependencyResult
+import org.gradle.api.artifacts.result.ResolvedDependencyResult
+import org.gradle.api.provider.ListProperty
+import org.gradle.api.provider.MapProperty
+import org.gradle.api.provider.Provider
+import org.gradle.api.tasks.Input
+import org.gradle.api.tasks.TaskAction
+import org.gradle.language.base.plugins.LifecycleBasePlugin
+
+abstract class DependencyCheck : DefaultTask() {
+    @get:Input
+    abstract val configuration: ListProperty<Configuration>
+
+    /**
+     * A mapping of module coordinates (`group:module`) to versions, overriding the requested version.
+     */
+    @get:Input
+    abstract val overrides: MapProperty<String, String>
+
+    init {
+        description = "Check :core's dependencies are consistent with Minecraft's."
+        group = LifecycleBasePlugin.VERIFICATION_GROUP
+
+        configuration.finalizeValueOnRead()
+        overrides.finalizeValueOnRead()
+    }
+
+    /**
+     * Override a module with a different version.
+     */
+    fun override(module: Provider<MinimalExternalModuleDependency>, version: String) {
+        overrides.putAll(project.provider { mutableMapOf(module.get().module.toString() to version) })
+    }
+
+    @TaskAction
+    fun run() {
+        var ok = true
+        for (configuration in configuration.get()) {
+            configuration.incoming.resolutionResult.allDependencies {
+                if (!check(this@allDependencies)) ok = false
+            }
+        }
+
+        if (!ok) {
+            throw GradleException("Mismatched versions in Minecraft dependencies. gradle/libs.versions.toml may need updating.")
+        }
+    }
+
+    private fun check(dependency: DependencyResult): Boolean {
+        if (dependency !is ResolvedDependencyResult) {
+            logger.warn("Found unexpected dependency result {}", dependency)
+            return false
+        }
+
+        // Skip dependencies on non-modules.
+        val requested = dependency.requested
+        if (requested !is ModuleComponentSelector) return true
+
+        // If this dependency is specified within some project (so is non-transitive), or is pulled in via Minecraft,
+        // then check for consistency.
+        // It would be nice to be smarter about transitive dependencies, but avoiding false positives is hard.
+        val from = dependency.from.id
+        if (
+            from is ProjectComponentIdentifier ||
+            from is ModuleComponentIdentifier && (from.group == "net.minecraft" || from.group == "io.netty")
+        ) {
+            // If the version is different between the requested and selected version, report an error.
+            val selected = dependency.selected.moduleVersion!!.version
+            val requestedVersion = overrides.get()["${requested.group}:${requested.module}"] ?: requested.version
+            if (requestedVersion != selected) {
+                logger.error("Requested dependency {} (via {}) but got version {}", requested, from, selected)
+                return false
+            }
+
+            return true
+        }
+        return true
+    }
+}

buildSrc/src/main/kotlin/cc/tweaked/gradle/ExecTasks.kt

@@ -4,6 +4,7 @@
 
 package cc.tweaked.gradle
 
+import org.gradle.api.file.DirectoryProperty
 import org.gradle.api.provider.Property
 import org.gradle.api.tasks.AbstractExecTask
 import org.gradle.api.tasks.OutputDirectory
@@ -11,5 +12,5 @@ import java.io.File
 
 abstract class ExecToDir : AbstractExecTask<ExecToDir>(ExecToDir::class.java) {
     @get:OutputDirectory
-    abstract val output: Property<File>
+    abstract val output: DirectoryProperty
 }

buildSrc/src/main/kotlin/cc/tweaked/gradle/Extensions.kt

@@ -5,6 +5,7 @@
 package cc.tweaked.gradle
 
 import org.gradle.api.artifacts.dsl.DependencyHandler
+import org.gradle.api.file.FileSystemLocation
 import org.gradle.api.provider.Property
 import org.gradle.api.provider.Provider
 import org.gradle.api.tasks.JavaExec
@@ -124,3 +125,33 @@ class CloseScope : AutoCloseable {
 
 /** Proxy method to avoid overload ambiguity. */
 fun <T> Property<T>.setProvider(provider: Provider<out T>) = set(provider)
+
+/** Short-cut method to get the absolute path of a [FileSystemLocation] provider. */
+fun Provider<out FileSystemLocation>.getAbsolutePath(): String = get().asFile.absolutePath
+
+/**
+ * Get the version immediately after the provided version.
+ *
+ * For example, given "1.2.3", this will return "1.2.4".
+ */
+fun getNextVersion(version: String): String {
+    // Split a version like x.y.z-SNAPSHOT into x.y.z and -SNAPSHOT
+    val dashIndex = version.indexOf('-')
+    val mainVersion = if (dashIndex < 0) version else version.substring(0, dashIndex)
+
+    // Find the last component in x.y.z and increment it.
+    val lastIndex = mainVersion.lastIndexOf('.')
+    if (lastIndex < 0) throw IllegalArgumentException("Cannot parse version format \"$version\"")
+    val lastVersion = try {
+        version.substring(lastIndex + 1).toInt()
+    } catch (e: NumberFormatException) {
+        throw IllegalArgumentException("Cannot parse version format \"$version\"", e)
+    }
+
+    // Then append all components together.
+    val out = StringBuilder()
+    out.append(version, 0, lastIndex + 1)
+    out.append(lastVersion + 1)
+    if (dashIndex >= 0) out.append(version, dashIndex, version.length)
+    return out.toString()
+}

buildSrc/src/main/kotlin/cc/tweaked/gradle/ForgeExtensions.kt

@@ -4,23 +4,59 @@
 
 package cc.tweaked.gradle
 
-import net.minecraftforge.gradle.common.util.RunConfig
-import net.minecraftforge.gradle.common.util.runs.setRunConfigInternal
+import net.neoforged.gradle.common.runs.run.RunImpl
+import net.neoforged.gradle.common.runs.tasks.RunExec
+import net.neoforged.gradle.dsl.common.extensions.RunnableSourceSet
+import net.neoforged.gradle.dsl.common.runs.run.Run
 import org.gradle.api.plugins.JavaPluginExtension
 import org.gradle.api.tasks.JavaExec
+import org.gradle.api.tasks.SourceSet
 import org.gradle.jvm.toolchain.JavaToolchainService
+import org.gradle.kotlin.dsl.assign
+import org.gradle.kotlin.dsl.create
+import org.gradle.kotlin.dsl.findByType
 import java.nio.file.Files
 
 /**
  * Set [JavaExec] task to run a given [RunConfig].
+ *
+ * See also [RunExec].
  */
-fun JavaExec.setRunConfig(config: RunConfig) {
-    dependsOn("prepareRuns")
-    setRunConfigInternal(project, this, config)
-    doFirst("Create working directory") { Files.createDirectories(workingDir.toPath()) }
+fun JavaExec.setRunConfig(config: Run) {
+    mainClass.set(config.mainClass)
+    workingDir = config.workingDirectory.get().asFile
+    argumentProviders.add { config.programArguments.get() }
+    jvmArgumentProviders.add { config.jvmArguments.get() }
+
+    environment(config.environmentVariables.get())
+    systemProperties(config.systemProperties.get())
+
+    config.modSources.get().forEach { classpath(it.runtimeClasspath) }
+    classpath(config.classpath)
+    classpath(config.dependencies.get().configuration)
+
+    (config as RunImpl).taskDependencies.forEach { dependsOn(it) }
 
     javaLauncher.set(
         project.extensions.getByType(JavaToolchainService::class.java)
             .launcherFor(project.extensions.getByType(JavaPluginExtension::class.java).toolchain),
     )
+
+    doFirst("Create working directory") { Files.createDirectories(workingDir.toPath()) }
+}
+
+/**
+ * Add a new [Run.modSource] with a specific mod id.
+ */
+fun Run.modSourceAs(sourceSet: SourceSet, mod: String) {
+    // NeoGradle requires a RunnableSourceSet to be present, so we inject it into other project's source sets.
+    val runnable = sourceSet.extensions.findByType<RunnableSourceSet>() ?: run {
+        val extension = sourceSet.extensions.create<RunnableSourceSet>(RunnableSourceSet.NAME, project)
+        extension.modIdentifier = mod
+        extension.modIdentifier.finalizeValueOnRead()
+        extension
+    }
+    if (runnable.modIdentifier.get() != mod) throw IllegalArgumentException("Multiple mod identifiers")
+
+    modSource(sourceSet)
 }

buildSrc/src/main/kotlin/cc/tweaked/gradle/IdeaExt.kt

@@ -0,0 +1,23 @@
+// SPDX-FileCopyrightText: 2023 The CC: Tweaked Developers
+//
+// SPDX-License-Identifier: MPL-2.0
+
+package cc.tweaked.gradle
+
+import org.jetbrains.gradle.ext.JUnit
+import javax.inject.Inject
+
+/**
+ * A version of [JUnit] with a functional [className].
+ *
+ * See [#92](https://github.com/JetBrains/gradle-idea-ext-plugin/issues/92).
+ */
+open class JUnitExt @Inject constructor(nameParam: String) : JUnit(nameParam) {
+    override fun toMap(): MutableMap<String, *> {
+        val map = HashMap(super.toMap())
+        // Should be "class" instead of "className".
+        // See https://github.com/JetBrains/intellij-community/blob/9ba394021dc73a3926f13d6d6cdf434f9ee7046d/plugins/junit/src/com/intellij/execution/junit/JUnitRunConfigurationImporter.kt#L39
+        map["class"] = className
+        return map
+    }
+}

buildSrc/src/main/kotlin/cc/tweaked/gradle/MavenDependencySpec.kt

@@ -6,6 +6,8 @@ package cc.tweaked.gradle
 
 import org.gradle.api.artifacts.Dependency
 import org.gradle.api.artifacts.MinimalExternalModuleDependency
+import org.gradle.api.artifacts.ProjectDependency
+import org.gradle.api.plugins.BasePluginExtension
 import org.gradle.api.publish.maven.MavenPublication
 import org.gradle.api.specs.Spec
 
@@ -26,8 +28,13 @@ class MavenDependencySpec {
 
     fun exclude(dep: Dependency) {
         exclude {
+            // We have to cheat a little for project dependencies, as the project name doesn't match the artifact group.
+            val name = when (dep) {
+                is ProjectDependency -> dep.dependencyProject.extensions.getByType(BasePluginExtension::class.java).archivesName.get()
+                else -> dep.name
+            }
             (dep.group.isNullOrEmpty() || dep.group == it.groupId) &&
-                (dep.name.isNullOrEmpty() || dep.name == it.artifactId) &&
+                (name.isNullOrEmpty() || name == it.artifactId) &&
                 (dep.version.isNullOrEmpty() || dep.version == it.version)
         }
     }

buildSrc/src/main/kotlin/cc/tweaked/gradle/MinecraftConfigurations.kt

@@ -4,23 +4,17 @@
 
 package cc.tweaked.gradle
 
+import cc.tweaked.vanillaextract.configurations.Capabilities
+import cc.tweaked.vanillaextract.configurations.MinecraftSetup
 import org.gradle.api.Project
-import org.gradle.api.artifacts.Configuration
 import org.gradle.api.artifacts.ModuleDependency
 import org.gradle.api.artifacts.dsl.DependencyHandler
-import org.gradle.api.attributes.Bundling
-import org.gradle.api.attributes.Category
-import org.gradle.api.attributes.LibraryElements
-import org.gradle.api.attributes.Usage
-import org.gradle.api.attributes.java.TargetJvmVersion
-import org.gradle.api.capabilities.Capability
 import org.gradle.api.plugins.BasePlugin
 import org.gradle.api.plugins.JavaPluginExtension
 import org.gradle.api.tasks.SourceSet
 import org.gradle.api.tasks.bundling.Jar
 import org.gradle.api.tasks.javadoc.Javadoc
 import org.gradle.kotlin.dsl.get
-import org.gradle.kotlin.dsl.named
 
 /**
  * This sets up a separate client-only source set, and extends that and the main/common source set with additional
@@ -59,31 +53,13 @@ class MinecraftConfigurations private constructor(private val project: Project)
         }
         configurations.named(client.implementationConfigurationName) { extendsFrom(clientApi) }
 
-        /*
-          Now add outgoing variants for the main and common source sets that we can consume downstream. This is possibly
-          the worst way to do things, but unfortunately the alternatives don't actually work very well:
-
-           - Just using source set outputs: This means dependencies don't propagate, which means when :fabric depends
-             on :fabric-api, we don't inherit the fake :common-api in IDEA.
-
-           - Having separate common/main jars: Nice in principle, but unfortunately Forge needs a separate deobf jar
-             task (as the original jar is obfuscated), and IDEA is not able to map its output back to a source set.
-
-          This works for now, but is incredibly brittle. It's part of the reason we can't use testFixtures inside our
-          MC projects, as that adds a project(self) -> test dependency, which would pull in the jar instead.
-
-          Note we register a fake client jar here. It's not actually needed, but is there to make sure IDEA has
-          a way to tell that client classes are needed at runtime.
-
-          I'm so sorry, deeply aware how cursed this is.
-        */
-        setupOutgoing(main, "CommonOnly")
         project.tasks.register(client.jarTaskName, Jar::class.java) {
             description = "An empty jar standing in for the client classes."
             group = BasePlugin.BUILD_GROUP
             archiveClassifier.set("client")
         }
-        setupOutgoing(client)
+
+        MinecraftSetup(project).setupOutgoingConfigurations()
 
         // Reset the client classpath (Loom configures it slightly differently to this) and add a main -> client
         // dependency. Here we /can/ use source set outputs as we add transitive deps by patching the classpath. Nasty,
@@ -106,88 +82,39 @@ class MinecraftConfigurations private constructor(private val project: Project)
         project.tasks.named("jar", Jar::class.java) { from(client.output) }
         project.tasks.named("sourcesJar", Jar::class.java) { from(client.allSource) }
 
+        setupBasic()
+    }
+
+    private fun setupBasic() {
+        val client = sourceSets["client"]
+
         project.extensions.configure(CCTweakedExtension::class.java) {
             sourceDirectories.add(SourceSetReference.internal(client))
         }
-    }
 
-    private fun setupOutgoing(sourceSet: SourceSet, suffix: String = "") {
-        setupOutgoing("${sourceSet.apiElementsConfigurationName}$suffix", sourceSet, objects.named(Usage.JAVA_API)) {
-            description = "API elements for ${sourceSet.name}"
-            extendsFrom(configurations[sourceSet.apiConfigurationName])
-        }
-
-        setupOutgoing("${sourceSet.runtimeElementsConfigurationName}$suffix", sourceSet, objects.named(Usage.JAVA_RUNTIME)) {
-            description = "Runtime elements for ${sourceSet.name}"
-            extendsFrom(configurations[sourceSet.implementationConfigurationName], configurations[sourceSet.runtimeOnlyConfigurationName])
-        }
-    }
-
-    /**
-     * Set up an outgoing configuration for a specific source set. We set an additional "main" or "client" capability
-     * (depending on the source set name) which allows downstream projects to consume them separately (see
-     * [DependencyHandler.commonClasses] and [DependencyHandler.clientClasses]).
-     */
-    private fun setupOutgoing(name: String, sourceSet: SourceSet, usage: Usage, configure: Configuration.() -> Unit) {
-        configurations.register(name) {
-            isVisible = false
-            isCanBeConsumed = true
-            isCanBeResolved = false
-
-            configure(this)
-
-            attributes {
-                attribute(Category.CATEGORY_ATTRIBUTE, objects.named(Category.LIBRARY))
-                attribute(Usage.USAGE_ATTRIBUTE, usage)
-                attribute(Bundling.BUNDLING_ATTRIBUTE, objects.named(Bundling.EXTERNAL))
-                attributeProvider(
-                    TargetJvmVersion.TARGET_JVM_VERSION_ATTRIBUTE,
-                    java.toolchain.languageVersion.map { it.asInt() },
-                )
-                attribute(LibraryElements.LIBRARY_ELEMENTS_ATTRIBUTE, objects.named(LibraryElements.JAR))
+        // Register a task to check there are no conflicts with the core project.
+        val checkDependencyConsistency =
+            project.tasks.register("checkDependencyConsistency", DependencyCheck::class.java) {
+                // We need to check both the main and client classpath *configurations*, as the actual configuration
+                configuration.add(configurations.named(main.runtimeClasspathConfigurationName))
+                configuration.add(configurations.named(client.runtimeClasspathConfigurationName))
             }
-
-            outgoing {
-                capability(BasicOutgoingCapability(project, sourceSet.name))
-
-                // We have two outgoing variants here: the original jar and the classes.
-                artifact(project.tasks.named(sourceSet.jarTaskName))
-
-                variants.create("classes") {
-                    attributes.attribute(LibraryElements.LIBRARY_ELEMENTS_ATTRIBUTE, objects.named(LibraryElements.CLASSES))
-                    sourceSet.output.classesDirs.forEach { artifact(it) { builtBy(sourceSet.output) } }
-                }
-            }
-        }
+        project.tasks.named("check") { dependsOn(checkDependencyConsistency) }
     }
 
     companion object {
+        fun setupBasic(project: Project) {
+            MinecraftConfigurations(project).setupBasic()
+        }
+
         fun setup(project: Project) {
             MinecraftConfigurations(project).setup()
         }
     }
 }
 
-private class BasicIncomingCapability(private val module: ModuleDependency, private val name: String) : Capability {
-    override fun getGroup(): String = module.group!!
-    override fun getName(): String = "${module.name}-$name"
-    override fun getVersion(): String? = null
-}
+fun DependencyHandler.clientClasses(notation: Any): ModuleDependency =
+    Capabilities.clientClasses(create(notation) as ModuleDependency)
 
-private class BasicOutgoingCapability(private val project: Project, private val name: String) : Capability {
-    override fun getGroup(): String = project.group.toString()
-    override fun getName(): String = "${project.name}-$name"
-    override fun getVersion(): String = project.version.toString()
-}
-
-fun DependencyHandler.clientClasses(notation: Any): ModuleDependency {
-    val dep = create(notation) as ModuleDependency
-    dep.capabilities { requireCapability(BasicIncomingCapability(dep, "client")) }
-    return dep
-}
-
-fun DependencyHandler.commonClasses(notation: Any): ModuleDependency {
-    val dep = create(notation) as ModuleDependency
-    dep.capabilities { requireCapability(BasicIncomingCapability(dep, "main")) }
-    return dep
-}
+fun DependencyHandler.commonClasses(notation: Any): ModuleDependency =
+    Capabilities.commonClasses(create(notation) as ModuleDependency)

buildSrc/src/main/kotlin/cc/tweaked/gradle/MinecraftExec.kt

@@ -4,7 +4,6 @@
 
 package cc.tweaked.gradle
 
-import net.minecraftforge.gradle.common.util.RunConfig
 import org.gradle.api.GradleException
 import org.gradle.api.file.FileSystemOperations
 import org.gradle.api.invocation.Gradle
@@ -58,21 +57,13 @@ abstract class ClientJavaExec : JavaExec() {
         if (!clientDebug) systemProperty("cctest.client", "")
         if (renderdoc) environment("LD_PRELOAD", "/usr/lib/librenderdoc.so")
         systemProperty("cctest.gametest-report", testResults.get().asFile.absoluteFile)
-        workingDir(project.buildDir.resolve("gametest").resolve(name))
+        workingDir(project.layout.buildDirectory.dir("gametest/$name"))
     }
 
     init {
         setTestProperties()
     }
 
-    /**
-     * Set this task to run a given [RunConfig].
-     */
-    fun setRunConfig(config: RunConfig) {
-        (this as JavaExec).setRunConfig(config)
-        setTestProperties() // setRunConfig may clobber some properties, ensure everything is set.
-    }
-
     /**
      * Copy configuration from a task with the given name.
      */

buildSrc/src/main/kotlin/net/minecraftforge/gradle/common/util/runs/RunConfigSetup.kt

@@ -1,51 +0,0 @@
-// SPDX-FileCopyrightText: 2023 The CC: Tweaked Developers
-//
-// SPDX-License-Identifier: MPL-2.0
-
-package net.minecraftforge.gradle.common.util.runs
-
-import net.minecraftforge.gradle.common.util.RunConfig
-import org.gradle.api.Project
-import org.gradle.process.CommandLineArgumentProvider
-import org.gradle.process.JavaExecSpec
-import java.io.File
-import java.util.function.Supplier
-import java.util.stream.Collectors
-import java.util.stream.Stream
-
-/**
- * Set up a [JavaExecSpec] to execute a [RunConfig].
- *
- * [MinecraftRunTask] sets up all its properties when the task is executed, rather than when configured. As such, it's
- * not possible to use [cc.tweaked.gradle.copyToFull] like we do for Fabric. Instead, we set up the task manually.
- *
- * Unfortunately most of the functionality we need is package-private, and so we have to put our code into the package.
- */
-internal fun setRunConfigInternal(project: Project, spec: JavaExecSpec, config: RunConfig) {
-    spec.workingDir = File(config.workingDirectory)
-
-    spec.mainClass.set(config.main)
-    for (source in config.allSources) spec.classpath(source.runtimeClasspath)
-
-    val originalTask = project.tasks.named(config.taskName, MinecraftRunTask::class.java)
-
-    // Add argument and JVM argument via providers, to be as lazy as possible with fetching artifacts.
-    val lazyTokens = RunConfigGenerator.configureTokensLazy(
-        project, config, RunConfigGenerator.mapModClassesToGradle(project, config),
-        originalTask.get().minecraftArtifacts,
-        originalTask.get().runtimeClasspathArtifacts,
-    )
-    spec.argumentProviders.add(
-        CommandLineArgumentProvider {
-            RunConfigGenerator.getArgsStream(config, lazyTokens, false).toList()
-        },
-    )
-    spec.jvmArgumentProviders.add(
-        CommandLineArgumentProvider {
-            (if (config.isClient) config.jvmArgs + originalTask.get().additionalClientArgs.get() else config.jvmArgs).map { config.replace(lazyTokens, it) } +
-                config.properties.map { (k, v) -> "-D${k}=${config.replace(lazyTokens, v)}" }
-        },
-    )
-
-    for ((key, value) in config.environment) spec.environment(key, config.replace(lazyTokens, value))
-}

config/checkstyle/checkstyle.xml

@@ -112,7 +112,9 @@ SPDX-License-Identifier: MPL-2.0
         <module name="LambdaParameterName" />
         <module name="LocalFinalVariableName" />
         <module name="LocalVariableName" />
-        <module name="MemberName" />
+        <module name="MemberName">
+            <property name="format" value="^\$?[a-z][a-zA-Z0-9]*$" />
+        </module>
         <module name="MethodName">
             <property name="format" value="^(computercraft\$)?[a-z][a-zA-Z0-9]*$" />
         </module>
@@ -122,7 +124,7 @@ SPDX-License-Identifier: MPL-2.0
         </module>
         <module name="ParameterName" />
         <module name="StaticVariableName">
-            <property name="format" value="^[a-z][a-zA-Z0-9]*|CAPABILITY(_[A-Z_]+)?$" />
+            <property name="format" value="^[a-z][a-zA-Z0-9]*$" />
         </module>
         <module name="TypeName" />
 

config/checkstyle/suppressions.xml

@@ -16,4 +16,10 @@ SPDX-License-Identifier: MPL-2.0
 
     <!-- The commands API is documented in Lua. -->
     <suppress checks="SummaryJavadocCheck" files=".*[\\/]CommandAPI.java" />
+
+    <!-- Allow putting files in other packages if they look like our TeaVM stubs. -->
+    <suppress checks="PackageName" files=".*[\\/]T[A-Za-z]+.java" />
+
+    <!-- Allow underscores in our test classes. -->
+    <suppress checks="MethodName" files=".*Contract.java" />
 </suppressions>

doc/events/alarm.md

@@ -9,11 +9,11 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{alarm} event is fired when an alarm started with @{os.setAlarm} completes.
+The [`alarm`] event is fired when an alarm started with [`os.setAlarm`] completes.
 
 ## Return Values
-1. @{string}: The event name.
-2. @{number}: The ID of the alarm that finished.
+1. [`string`]: The event name.
+2. [`number`]: The ID of the alarm that finished.
 
 ## Example
 Starts a timer and then waits for it to complete.

doc/events/char.md

@@ -6,18 +6,18 @@ see: key To listen to any key press.
 <!--
 SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 
-SPDX-License-Identifier: LicenseRef-CCPL
+SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{char} event is fired when a character is typed on the keyboard.
+The [`char`] event is fired when a character is typed on the keyboard.
 
-The @{char} event is different to a key press. Sometimes multiple key presses may result in one character being
+The [`char`] event is different to a key press. Sometimes multiple key presses may result in one character being
 typed (for instance, on some European keyboards). Similarly, some keys (e.g. <kbd>Ctrl</kbd>) do not have any
-corresponding character. The @{key} should be used if you want to listen to key presses themselves.
+corresponding character. The [`key`] should be used if you want to listen to key presses themselves.
 
 ## Return values
-1. @{string}: The event name.
-2. @{string}: The string representing the character that was pressed.
+1. [`string`]: The event name.
+2. [`string`]: The string representing the character that was pressed.
 
 
 ## Example

doc/events/computer_command.md

@@ -8,11 +8,11 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{computer_command} event is fired when the `/computercraft queue` command is run for the current computer.
+The [`computer_command`] event is fired when the `/computercraft queue` command is run for the current computer.
 
 ## Return Values
-1. @{string}: The event name.
-2. @{string}<abbr title="Variable number of arguments">&hellip;</abbr>: The arguments passed to the command.
+1. [`string`]: The event name.
+2. [`string`]<abbr title="Variable number of arguments">&hellip;</abbr>: The arguments passed to the command.
 
 ## Example
 Prints the contents of messages sent:

doc/events/disk.md

@@ -9,11 +9,11 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{disk} event is fired when a disk is inserted into an adjacent or networked disk drive.
+The [`disk`] event is fired when a disk is inserted into an adjacent or networked disk drive.
 
 ## Return Values
-1. @{string}: The event name.
-2. @{string}: The side of the disk drive that had a disk inserted.
+1. [`string`]: The event name.
+2. [`string`]: The side of the disk drive that had a disk inserted.
 
 ## Example
 Prints a message when a disk is inserted:

doc/events/disk_eject.md

@@ -9,11 +9,11 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{disk_eject} event is fired when a disk is removed from an adjacent or networked disk drive.
+The [`disk_eject`] event is fired when a disk is removed from an adjacent or networked disk drive.
 
 ## Return Values
-1. @{string}: The event name.
-2. @{string}: The side of the disk drive that had a disk removed.
+1. [`string`]: The event name.
+2. [`string`]: The side of the disk drive that had a disk removed.
 
 ## Example
 Prints a message when a disk is removed:

doc/events/file_transfer.md

@@ -9,15 +9,15 @@ SPDX-FileCopyrightText: 2022 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{file_transfer} event is queued when a user drags-and-drops a file on an open computer.
+The [`file_transfer`] event is queued when a user drags-and-drops a file on an open computer.
 
-This event contains a single argument of type @{TransferredFiles}, which can be used to @{TransferredFiles.getFiles|get
-the files to be transferred}. Each file returned is a @{fs.BinaryReadHandle|binary file handle} with an additional
-@{TransferredFile.getName|getName} method.
+This event contains a single argument of type [`TransferredFiles`], which can be used to [get the files to be
+transferred][`TransferredFiles.getFiles`]. Each file returned is a [binary file handle][`fs.ReadHandle`] with an
+additional [getName][`TransferredFile.getName`] method.
 
 ## Return values
-1. @{string}: The event name
-2. @{TransferredFiles}: The list of transferred files.
+1. [`string`]: The event name
+2. [`TransferredFiles`]: The list of transferred files.
 
 ## Example
 Waits for a user to drop files on top of the computer, then prints the list of files and the size of each file.
@@ -29,7 +29,7 @@ for _, file in ipairs(files.getFiles()) do
   local size = file.seek("end")
   file.seek("set", 0)
 
-  print(file.getName() .. " " .. file.getSize())
+  print(file.getName() .. " " .. size)
 end
 ```
 

doc/events/http_check.md

@@ -9,12 +9,12 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{http_check} event is fired when a URL check finishes.
+The [`http_check`] event is fired when a URL check finishes.
 
-This event is normally handled inside @{http.checkURL}, but it can still be seen when using @{http.checkURLAsync}.
+This event is normally handled inside [`http.checkURL`], but it can still be seen when using [`http.checkURLAsync`].
 
 ## Return Values
-1. @{string}: The event name.
-2. @{string}: The URL requested to be checked.
-3. @{boolean}: Whether the check succeeded.
-4. <span class="type">@{string}|@{nil}</span>: If the check failed, a reason explaining why the check failed.
+1. [`string`]: The event name.
+2. [`string`]: The URL requested to be checked.
+3. [`boolean`]: Whether the check succeeded.
+4. <span class="type">[`string`]|[`nil`]</span>: If the check failed, a reason explaining why the check failed.

doc/events/http_failure.md

@@ -9,15 +9,15 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{http_failure} event is fired when an HTTP request fails.
+The [`http_failure`] event is fired when an HTTP request fails.
 
-This event is normally handled inside @{http.get} and @{http.post}, but it can still be seen when using @{http.request}.
+This event is normally handled inside [`http.get`] and [`http.post`], but it can still be seen when using [`http.request`].
 
 ## Return Values
-1. @{string}: The event name.
-2. @{string}: The URL of the site requested.
-3. @{string}: An error describing the failure.
-4. <span class="type">@{http.Response}|@{nil}</span>: A response handle if the connection succeeded, but the server's
+1. [`string`]: The event name.
+2. [`string`]: The URL of the site requested.
+3. [`string`]: An error describing the failure.
+4. <span class="type">[`http.Response`]|[`nil`]</span>: A response handle if the connection succeeded, but the server's
    response indicated failure.
 
 ## Example

doc/events/http_success.md

@@ -9,14 +9,14 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{http_success} event is fired when an HTTP request returns successfully.
+The [`http_success`] event is fired when an HTTP request returns successfully.
 
-This event is normally handled inside @{http.get} and @{http.post}, but it can still be seen when using @{http.request}.
+This event is normally handled inside [`http.get`] and [`http.post`], but it can still be seen when using [`http.request`].
 
 ## Return Values
-1. @{string}: The event name.
-2. @{string}: The URL of the site requested.
-3. @{http.Response}: The successful HTTP response.
+1. [`string`]: The event name.
+2. [`string`]: The URL of the site requested.
+3. [`http.Response`]: The successful HTTP response.
 
 ## Example
 Prints the content of a website (this may fail if the request fails):

doc/events/key.md

@@ -5,21 +5,21 @@ module: [kind=event] key
 <!--
 SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 
-SPDX-License-Identifier: LicenseRef-CCPL
+SPDX-License-Identifier: MPL-2.0
 -->
 
 This event is fired when any key is pressed while the terminal is focused.
 
 This event returns a numerical "key code" (for instance, <kbd>F1</kbd> is 290). This value may vary between versions and
-so it is recommended to use the constants in the @{keys} API rather than hard coding numeric values.
+so it is recommended to use the constants in the [`keys`] API rather than hard coding numeric values.
 
-If the button pressed represented a printable character, then the @{key} event will be followed immediately by a @{char}
-event. If you are consuming text input, use a @{char} event instead!
+If the button pressed represented a printable character, then the [`key`] event will be followed immediately by a [`char`]
+event. If you are consuming text input, use a [`char`] event instead!
 
 ## Return values
-1. @{string}: The event name.
-2. @{number}: The numerical key value of the key pressed.
-3. @{boolean}: Whether the key event was generated while holding the key (@{true}), rather than pressing it the first time (@{false}).
+1. [`string`]: The event name.
+2. [`number`]: The numerical key value of the key pressed.
+3. [`boolean`]: Whether the key event was generated while holding the key ([`true`]), rather than pressing it the first time ([`false`]).
 
 ## Example
 Prints each key when the user presses it, and if the key is being held.

doc/events/key_up.md

@@ -6,20 +6,20 @@ see: keys For a lookup table of the given keys.
 <!--
 SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 
-SPDX-License-Identifier: LicenseRef-CCPL
+SPDX-License-Identifier: MPL-2.0
 -->
 
 Fired whenever a key is released (or the terminal is closed while a key was being pressed).
 
 This event returns a numerical "key code" (for instance, <kbd>F1</kbd> is 290). This value may vary between versions and
-so it is recommended to use the constants in the @{keys} API rather than hard coding numeric values.
+so it is recommended to use the constants in the [`keys`] API rather than hard coding numeric values.
 
 ## Return values
-1. @{string}: The event name.
-2. @{number}: The numerical key value of the key pressed.
+1. [`string`]: The event name.
+2. [`number`]: The numerical key value of the key pressed.
 
 ## Example
-Prints each key released on the keyboard whenever a @{key_up} event is fired.
+Prints each key released on the keyboard whenever a [`key_up`] event is fired.
 
 ```lua
 while true do

doc/events/modem_message.md

@@ -8,18 +8,18 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{modem_message} event is fired when a message is received on an open channel on any @{modem}.
+The [`modem_message`] event is fired when a message is received on an open channel on any [`modem`].
 
 ## Return Values
-1. @{string}: The event name.
-2. @{string}: The side of the modem that received the message.
-3. @{number}: The channel that the message was sent on.
-4. @{number}: The reply channel set by the sender.
-5. @{any}: The message as sent by the sender.
-6. <span class="type">@{number}|@{nil}</span>: The distance between the sender and the receiver in blocks, or @{nil} if the message was sent between dimensions.
+1. [`string`]: The event name.
+2. [`string`]: The side of the modem that received the message.
+3. [`number`]: The channel that the message was sent on.
+4. [`number`]: The reply channel set by the sender.
+5. [`any`]: The message as sent by the sender.
+6. <span class="type">[`number`]|[`nil`]</span>: The distance between the sender and the receiver in blocks, or [`nil`] if the message was sent between dimensions.
 
 ## Example
-Wraps a @{modem} peripheral, opens channel 0 for listening, and prints all received messages.
+Wraps a [`modem`] peripheral, opens channel 0 for listening, and prints all received messages.
 
 ```lua
 local modem = peripheral.find("modem") or error("No modem attached", 0)

doc/events/monitor_resize.md

@@ -8,11 +8,11 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{monitor_resize} event is fired when an adjacent or networked monitor's size is changed.
+The [`monitor_resize`] event is fired when an adjacent or networked monitor's size is changed.
 
 ## Return Values
-1. @{string}: The event name.
-2. @{string}: The side or network ID of the monitor that was resized.
+1. [`string`]: The event name.
+2. [`string`]: The side or network ID of the monitor that was resized.
 
 ## Example
 Prints a message when a monitor is resized:

doc/events/monitor_touch.md

@@ -8,13 +8,13 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{monitor_touch} event is fired when an adjacent or networked Advanced Monitor is right-clicked.
+The [`monitor_touch`] event is fired when an adjacent or networked Advanced Monitor is right-clicked.
 
 ## Return Values
-1. @{string}: The event name.
-2. @{string}: The side or network ID of the monitor that was touched.
-3. @{number}: The X coordinate of the touch, in characters.
-4. @{number}: The Y coordinate of the touch, in characters.
+1. [`string`]: The event name.
+2. [`string`]: The side or network ID of the monitor that was touched.
+3. [`number`]: The X coordinate of the touch, in characters.
+4. [`number`]: The Y coordinate of the touch, in characters.
 
 ## Example
 Prints a message when a monitor is touched:

doc/events/mouse_click.md

@@ -5,20 +5,20 @@ module: [kind=event] mouse_click
 <!--
 SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 
-SPDX-License-Identifier: LicenseRef-CCPL
+SPDX-License-Identifier: MPL-2.0
 -->
 
 This event is fired when the terminal is clicked with a mouse. This event is only fired on advanced computers (including
 advanced turtles and pocket computers).
 
 ## Return values
-1. @{string}: The event name.
-2. @{number}: The mouse button that was clicked.
-3. @{number}: The X-coordinate of the click.
-4. @{number}: The Y-coordinate of the click.
+1. [`string`]: The event name.
+2. [`number`]: The mouse button that was clicked.
+3. [`number`]: The X-coordinate of the click.
+4. [`number`]: The Y-coordinate of the click.
 
 ## Mouse buttons
-Several mouse events (@{mouse_click}, @{mouse_up}, @{mouse_scroll}) contain a "mouse button" code. This takes a
+Several mouse events ([`mouse_click`], [`mouse_up`], [`mouse_scroll`]) contain a "mouse button" code. This takes a
 numerical value depending on which button on your mouse was last pressed when this event occurred.
 
 | Button Code | Mouse Button  |

doc/events/mouse_drag.md

@@ -6,16 +6,16 @@ see: mouse_click For when a mouse button is initially pressed.
 <!--
 SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 
-SPDX-License-Identifier: LicenseRef-CCPL
+SPDX-License-Identifier: MPL-2.0
 -->
 
 This event is fired every time the mouse is moved while a mouse button is being held.
 
 ## Return values
-1. @{string}: The event name.
-2. @{number}: The [mouse button](mouse_click.html#Mouse_buttons) that is being pressed.
-3. @{number}: The X-coordinate of the mouse.
-4. @{number}: The Y-coordinate of the mouse.
+1. [`string`]: The event name.
+2. [`number`]: The [mouse button](mouse_click.html#Mouse_buttons) that is being pressed.
+3. [`number`]: The X-coordinate of the mouse.
+4. [`number`]: The Y-coordinate of the mouse.
 
 ## Example
 Print the button and the coordinates whenever the mouse is dragged.

doc/events/mouse_scroll.md

@@ -5,16 +5,16 @@ module: [kind=event] mouse_scroll
 <!--
 SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 
-SPDX-License-Identifier: LicenseRef-CCPL
+SPDX-License-Identifier: MPL-2.0
 -->
 
 This event is fired when a mouse wheel is scrolled in the terminal.
 
 ## Return values
-1. @{string}: The event name.
-2. @{number}: The direction of the scroll. (-1 = up, 1 = down)
-3. @{number}: The X-coordinate of the mouse when scrolling.
-4. @{number}: The Y-coordinate of the mouse when scrolling.
+1. [`string`]: The event name.
+2. [`number`]: The direction of the scroll. (-1 = up, 1 = down)
+3. [`number`]: The X-coordinate of the mouse when scrolling.
+4. [`number`]: The Y-coordinate of the mouse when scrolling.
 
 ## Example
 Prints the direction of each scroll, and the position of the mouse at the time.

doc/events/mouse_up.md

@@ -5,16 +5,16 @@ module: [kind=event] mouse_up
 <!--
 SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 
-SPDX-License-Identifier: LicenseRef-CCPL
+SPDX-License-Identifier: MPL-2.0
 -->
 
 This event is fired when a mouse button is released or a held mouse leaves the computer's terminal.
 
 ## Return values
-1. @{string}: The event name.
-2. @{number}: The [mouse button](mouse_click.html#Mouse_buttons) that was released.
-3. @{number}: The X-coordinate of the mouse.
-4. @{number}: The Y-coordinate of the mouse.
+1. [`string`]: The event name.
+2. [`number`]: The [mouse button](mouse_click.html#Mouse_buttons) that was released.
+3. [`number`]: The X-coordinate of the mouse.
+4. [`number`]: The Y-coordinate of the mouse.
 
 ## Example
 Prints the coordinates and button number whenever the mouse is released.

doc/events/paste.md

@@ -8,11 +8,11 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{paste} event is fired when text is pasted into the computer through Ctrl-V (or ⌘V on Mac).
+The [`paste`] event is fired when text is pasted into the computer through Ctrl-V (or ⌘V on Mac).
 
 ## Return values
-1. @{string}: The event name.
-2. @{string} The text that was pasted.
+1. [`string`]: The event name.
+2. [`string`] The text that was pasted.
 
 ## Example
 Prints pasted text:

doc/events/peripheral.md

@@ -9,11 +9,11 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{peripheral} event is fired when a peripheral is attached on a side or to a modem.
+The [`peripheral`] event is fired when a peripheral is attached on a side or to a modem.
 
 ## Return Values
-1. @{string}: The event name.
-2. @{string}: The side the peripheral was attached to.
+1. [`string`]: The event name.
+2. [`string`]: The side the peripheral was attached to.
 
 ## Example
 Prints a message when a peripheral is attached:

doc/events/peripheral_detach.md

@@ -9,11 +9,11 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{peripheral_detach} event is fired when a peripheral is detached from a side or from a modem.
+The [`peripheral_detach`] event is fired when a peripheral is detached from a side or from a modem.
 
 ## Return Values
-1. @{string}: The event name.
-2. @{string}: The side the peripheral was detached from.
+1. [`string`]: The event name.
+2. [`string`]: The side the peripheral was detached from.
 
 ## Example
 Prints a message when a peripheral is detached:

doc/events/rednet_message.md

@@ -10,17 +10,17 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{rednet_message} event is fired when a message is sent over Rednet.
+The [`rednet_message`] event is fired when a message is sent over Rednet.
 
-This event is usually handled by @{rednet.receive}, but it can also be pulled manually.
+This event is usually handled by [`rednet.receive`], but it can also be pulled manually.
 
-@{rednet_message} events are sent by @{rednet.run} in the top-level coroutine in response to @{modem_message} events. A @{rednet_message} event is always preceded by a @{modem_message} event. They are generated inside CraftOS rather than being sent by the ComputerCraft machine.
+[`rednet_message`] events are sent by [`rednet.run`] in the top-level coroutine in response to [`modem_message`] events. A [`rednet_message`] event is always preceded by a [`modem_message`] event. They are generated inside CraftOS rather than being sent by the ComputerCraft machine.
 
 ## Return Values
-1. @{string}: The event name.
-2. @{number}: The ID of the sending computer.
-3. @{any}: The message sent.
-4. <span class="type">@{string}|@{nil}</span>: The protocol of the message, if provided.
+1. [`string`]: The event name.
+2. [`number`]: The ID of the sending computer.
+3. [`any`]: The message sent.
+4. <span class="type">[`string`]|[`nil`]</span>: The protocol of the message, if provided.
 
 ## Example
 Prints a message when one is sent:

doc/events/redstone.md

@@ -8,10 +8,10 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{event!redstone} event is fired whenever any redstone inputs on the computer change.
+The [`event!redstone`] event is fired whenever any redstone inputs on the computer change.
 
 ## Return values
-1. @{string}: The event name.
+1. [`string`]: The event name.
 
 ## Example
 Prints a message when a redstone input changes:

doc/events/speaker_audio_empty.md

@@ -10,13 +10,13 @@ SPDX-License-Identifier: MPL-2.0
 -->
 
 ## Return Values
-1. @{string}: The event name.
-2. @{string}: The name of the speaker which is available to play more audio.
+1. [`string`]: The event name.
+2. [`string`]: The name of the speaker which is available to play more audio.
 
 
 ## Example
-This uses @{io.lines} to read audio data in blocks of 16KiB from "example_song.dfpwm", and then attempts to play it
-using @{speaker.playAudio}. If the speaker's buffer is full, it waits for an event and tries again.
+This uses [`io.lines`] to read audio data in blocks of 16KiB from "example_song.dfpwm", and then attempts to play it
+using [`speaker.playAudio`]. If the speaker's buffer is full, it waits for an event and tries again.
 
 ```lua {data-peripheral=speaker}
 local dfpwm = require("cc.audio.dfpwm")

doc/events/task_complete.md

@@ -9,13 +9,13 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{task_complete} event is fired when an asynchronous task completes. This is usually handled inside the function call that queued the task; however, functions such as @{commands.execAsync} return immediately so the user can wait for completion.
+The [`task_complete`] event is fired when an asynchronous task completes. This is usually handled inside the function call that queued the task; however, functions such as [`commands.execAsync`] return immediately so the user can wait for completion.
 
 ## Return Values
-1. @{string}: The event name.
-2. @{number}: The ID of the task that completed.
-3. @{boolean}: Whether the command succeeded.
-4. @{string}: If the command failed, an error message explaining the failure. (This is not present if the command succeeded.)
+1. [`string`]: The event name.
+2. [`number`]: The ID of the task that completed.
+3. [`boolean`]: Whether the command succeeded.
+4. [`string`]: If the command failed, an error message explaining the failure. (This is not present if the command succeeded.)
 5. <abbr title="Variable number of arguments">&hellip;</abbr>: Any parameters returned from the command.
 
 ## Example

doc/events/term_resize.md

@@ -8,15 +8,15 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{term_resize} event is fired when the main terminal is resized. For instance:
- - When a the tab bar is shown or hidden in @{multishell}.
+The [`term_resize`] event is fired when the main terminal is resized. For instance:
+ - When a the tab bar is shown or hidden in [`multishell`].
  - When the terminal is redirected to a monitor via the "monitor" program and the monitor is resized.
 
 When this event fires, some parts of the terminal may have been moved or deleted. Simple terminal programs (those
-not using @{term.setCursorPos}) can ignore this event, but more complex GUI programs should redraw the entire screen.
+not using [`term.setCursorPos`]) can ignore this event, but more complex GUI programs should redraw the entire screen.
 
 ## Return values
-1. @{string}: The event name.
+1. [`string`]: The event name.
 
 ## Example
 Print a message each time the terminal is resized.

doc/events/terminate.md

@@ -8,14 +8,14 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{terminate} event is fired when <kbd>Ctrl-T</kbd> is held down.
+The [`terminate`] event is fired when <kbd>Ctrl-T</kbd> is held down.
 
-This event is normally handled by @{os.pullEvent}, and will not be returned. However, @{os.pullEventRaw} will return this event when fired.
+This event is normally handled by [`os.pullEvent`], and will not be returned. However, [`os.pullEventRaw`] will return this event when fired.
 
-@{terminate} will be sent even when a filter is provided to @{os.pullEventRaw}. When using @{os.pullEventRaw} with a filter, make sure to check that the event is not @{terminate}.
+[`terminate`] will be sent even when a filter is provided to [`os.pullEventRaw`]. When using [`os.pullEventRaw`] with a filter, make sure to check that the event is not [`terminate`].
 
 ## Return values
-1. @{string}: The event name.
+1. [`string`]: The event name.
 
 ## Example
 Prints a message when Ctrl-T is held:

doc/events/timer.md

@@ -9,11 +9,11 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{timer} event is fired when a timer started with @{os.startTimer} completes.
+The [`timer`] event is fired when a timer started with [`os.startTimer`] completes.
 
 ## Return Values
-1. @{string}: The event name.
-2. @{number}: The ID of the timer that finished.
+1. [`string`]: The event name.
+2. [`number`]: The ID of the timer that finished.
 
 ## Example
 Start and wait for a timer to finish.

doc/events/turtle_inventory.md

@@ -8,10 +8,10 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{turtle_inventory} event is fired when a turtle's inventory is changed.
+The [`turtle_inventory`] event is fired when a turtle's inventory is changed.
 
 ## Return values
-1. @{string}: The event name.
+1. [`string`]: The event name.
 
 ## Example
 Prints a message when the inventory is changed:

doc/events/websocket_closed.md

@@ -8,16 +8,16 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{websocket_closed} event is fired when an open WebSocket connection is closed.
+The [`websocket_closed`] event is fired when an open WebSocket connection is closed.
 
 ## Return Values
-1. @{string}: The event name.
-2. @{string}: The URL of the WebSocket that was closed.
-3. <span class="type">@{string}|@{nil}</span>: The [server-provided reason][close_reason]
-   the websocket was closed. This will be @{nil} if the connection was closed
+1. [`string`]: The event name.
+2. [`string`]: The URL of the WebSocket that was closed.
+3. <span class="type">[`string`]|[`nil`]</span>: The [server-provided reason][close_reason]
+   the websocket was closed. This will be [`nil`] if the connection was closed
    abnormally.
-4. <span class="type">@{number}|@{nil}</span>: The [connection close code][close_code],
-   indicating why the socket was closed. This will be @{nil} if the connection
+4. <span class="type">[`number`]|[`nil`]</span>: The [connection close code][close_code],
+   indicating why the socket was closed. This will be [`nil`] if the connection
    was closed abnormally.
 
 [close_reason]: https://www.rfc-editor.org/rfc/rfc6455.html#section-7.1.6 "The WebSocket Connection Close Reason, RFC 6455"

doc/events/websocket_failure.md

@@ -9,14 +9,14 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{websocket_failure} event is fired when a WebSocket connection request fails.
+The [`websocket_failure`] event is fired when a WebSocket connection request fails.
 
-This event is normally handled inside @{http.websocket}, but it can still be seen when using @{http.websocketAsync}.
+This event is normally handled inside [`http.websocket`], but it can still be seen when using [`http.websocketAsync`].
 
 ## Return Values
-1. @{string}: The event name.
-2. @{string}: The URL of the site requested.
-3. @{string}: An error describing the failure.
+1. [`string`]: The event name.
+2. [`string`]: The URL of the site requested.
+3. [`string`]: An error describing the failure.
 
 ## Example
 Prints an error why the website cannot be contacted:

doc/events/websocket_message.md

@@ -8,15 +8,15 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{websocket_message} event is fired when a message is received on an open WebSocket connection.
+The [`websocket_message`] event is fired when a message is received on an open WebSocket connection.
 
-This event is normally handled by @{http.Websocket.receive}, but it can also be pulled manually.
+This event is normally handled by [`http.Websocket.receive`], but it can also be pulled manually.
 
 ## Return Values
-1. @{string}: The event name.
-2. @{string}: The URL of the WebSocket.
-3. @{string}: The contents of the message.
-4. @{boolean}: Whether this is a binary message.
+1. [`string`]: The event name.
+2. [`string`]: The URL of the WebSocket.
+3. [`string`]: The contents of the message.
+4. [`boolean`]: Whether this is a binary message.
 
 ## Example
 Prints a message sent by a WebSocket:

doc/events/websocket_success.md

@@ -9,14 +9,14 @@ SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 SPDX-License-Identifier: MPL-2.0
 -->
 
-The @{websocket_success} event is fired when a WebSocket connection request returns successfully.
+The [`websocket_success`] event is fired when a WebSocket connection request returns successfully.
 
-This event is normally handled inside @{http.websocket}, but it can still be seen when using @{http.websocketAsync}.
+This event is normally handled inside [`http.websocket`], but it can still be seen when using [`http.websocketAsync`].
 
 ## Return Values
-1. @{string}: The event name.
-2. @{string}: The URL of the site.
-3. @{http.Websocket}: The handle for the WebSocket.
+1. [`string`]: The event name.
+2. [`string`]: The URL of the site.
+3. [`http.Websocket`]: The handle for the WebSocket.
 
 ## Example
 Prints the content of a website (this may fail if the request fails):

doc/guides/gps_setup.md

@@ -9,7 +9,7 @@ SPDX-License-Identifier: MPL-2.0
 -->
 
 # Setting up GPS
-The @{gps} API allows computers and turtles to find their current position using wireless modems.
+The [`gps`] API allows computers and turtles to find their current position using wireless modems.
 
 In order to use GPS, you'll need to set up multiple *GPS hosts*. These are computers running the special `gps host`
 program, which tell other computers the host's position. Several hosts running together are known as a *GPS
@@ -19,22 +19,21 @@ In order to give the best results, a GPS constellation needs at least four compu
 constellation is redundant, but it does not cause problems.
 
 ## Building a GPS constellation
-![An example GPS constellation.](/images/gps-constellation-example.png){.big-image}
+<img alt="An example GPS constellation." src="/images/gps-constellation-example.png" class="big-image" />
 
 We are going to build our GPS constellation as shown in the image above. You will need 4 computers and either 4 wireless
 modems or 4 ender modems. Try not to mix ender and wireless modems together as you might get some odd behavior when your
 requesting computers are out of range.
 
-:::tip Ender modems vs wireless modems
-Ender modems have a very large range, which makes them very useful for setting up GPS hosts. If you do this then you
-will likely only need one GPS constellation for the whole dimension (such as the Overworld or Nether).
-
-If you do use wireless modems then you may find that you need multiple GPS constellations to cover your needs.
-
-A computer needs a wireless or ender modem and to be in range of a GPS constellation that is in the same dimension as it
-to use the GPS API. The reason for this is that ComputerCraft mimics real-life GPS by making use of the distance
-parameter of @{modem_message|modem messages} and some maths.
-:::
+> [Ender modems vs wireless modems][!TIP]
+> Ender modems have a very large range, which makes them very useful for setting up GPS hosts. If you do this then you
+> will likely only need one GPS constellation for the whole dimension (such as the Overworld or Nether).
+>
+> If you do use wireless modems then you may find that you need multiple GPS constellations to cover your needs.
+>
+> A computer needs a wireless or ender modem and to be in range of a GPS constellation that is in the same dimension as
+> it to use the GPS API. The reason for this is that ComputerCraft mimics real-life GPS by making use of the distance
+> parameter of [modem messages][`modem_message`] and some maths.
 
 Locate where you want to place your GPS constellation. You will need an area at least 6 blocks high, 6 blocks wide, and
 6 blocks deep (6x6x6). If you are using wireless modems then you may want to build your constellation as high as you can
@@ -79,18 +78,16 @@ To hide Minecraft's debug screen, press <kbd>F3</kbd> again.
 Create similar startup files for the other computers in your constellation, making sure to input the each computer's own
 coordinates.
 
-:::caution Modem messages come from the computer's position, not the modem's
-Wireless modems transmit from the block that they are attached to *not* the block space that they occupy, the
-coordinates that you input into your GPS host should be the position of the computer and not the position of the modem.
-:::
+> [Modem messages come from the computer's position, not the modem's][!WARNING]
+> Wireless modems transmit from the block that they are attached to *not* the block space that they occupy, the
+> coordinates that you input into your GPS host should be the position of the computer and not the position of the modem.
 
 Congratulations, your constellation is now fully set up! You can test it by placing another computer close by, placing a
-wireless modem on it, and running the `gps locate` program (or calling the @{gps.locate} function).
+wireless modem on it, and running the `gps locate` program (or calling the [`gps.locate`] function).
 
-:::info Why use Minecraft's coordinates?
-CC doesn't care if you use Minecraft's coordinate system, so long as all of the GPS hosts with overlapping ranges use
-the same reference point (requesting computers will get confused if hosts have different reference points). However,
-using MC's coordinate system does provide a nice standard to adopt server-wide. It also is consistent with how command
-computers get their location, they use MC's command system to get their block which returns that in MC's coordinate
-system.
-:::
+> [Why use Minecraft's coordinates?][!INFO]
+> CC doesn't care if you use Minecraft's coordinate system, so long as all of the GPS hosts with overlapping ranges use
+> the same reference point (requesting computers will get confused if hosts have different reference points). However,
+> using MC's coordinate system does provide a nice standard to adopt server-wide. It also is consistent with how command
+> computers get their location, they use MC's command system to get their block which returns that in MC's coordinate
+> system.

doc/guides/speaker_audio.md

@@ -11,7 +11,7 @@ SPDX-License-Identifier: MPL-2.0
 -->
 
 # Playing audio with speakers
-CC: Tweaked's speaker peripheral provides a powerful way to play any audio you like with the @{speaker.playAudio}
+CC: Tweaked's speaker peripheral provides a powerful way to play any audio you like with the [`speaker.playAudio`]
 method. However, for people unfamiliar with digital audio, it's not the most intuitive thing to use. This guide provides
 an introduction to digital audio, demonstrates how to play music with CC: Tweaked's speakers, and then briefly discusses
 the more complex topic of audio processing.
@@ -60,7 +60,7 @@ sine waves (and why wouldn't you?), you'd need a table with almost 3 _million_.
 up very quickly, and these tables take up more and more memory.
 
 Instead of building our entire song (well, sine wave) in one go, we can produce it in small batches, each of which get
-passed off to @{speaker.playAudio} when the time is right. This allows us to build a _stream_ of audio, where we read
+passed off to [`speaker.playAudio`] when the time is right. This allows us to build a _stream_ of audio, where we read
 chunks of audio one at a time (either from a file or a tone generator like above), do some optional processing to each
 one, and then play them.
 
@@ -84,15 +84,15 @@ end
 ```
 
 It looks pretty similar to before, aside from we've wrapped the generation and playing code in a while loop, and added a
-rather odd loop with @{speaker.playAudio} and @{os.pullEvent}.
+rather odd loop with [`speaker.playAudio`] and [`os.pullEvent`].
 
-Let's talk about this loop, why do we need to keep calling @{speaker.playAudio}? Remember that what we're trying to do
+Let's talk about this loop, why do we need to keep calling [`speaker.playAudio`]? Remember that what we're trying to do
 here is avoid keeping too much audio in memory at once. However, if we're generating audio quicker than the speakers can
 play it, we're not helping at all - all this audio is still hanging around waiting to be played!
 
 In order to avoid this, the speaker rejects any new chunks of audio if its backlog is too large. When this happens,
-@{speaker.playAudio} returns false. Once enough audio has played, and the backlog has been reduced, a
-@{speaker_audio_empty} event is queued, and we can try to play our chunk once more.
+[`speaker.playAudio`] returns false. Once enough audio has played, and the backlog has been reduced, a
+[`speaker_audio_empty`] event is queued, and we can try to play our chunk once more.
 
 ## Storing audio
 PCM is a fantastic way of representing audio when we want to manipulate it, but it's not very efficient when we want to
@@ -106,7 +106,7 @@ computer. Instead, we need something much simpler.
 
 DFPWM (Dynamic Filter Pulse Width Modulation) is the de facto standard audio format of the ComputerCraft (and
 OpenComputers) world. Originally popularised by the addon mod [Computronics], CC:T now has built-in support for it with
-the @{cc.audio.dfpwm} module. This allows you to read DFPWM files from disk, decode them to PCM, and then play them
+the [`cc.audio.dfpwm`] module. This allows you to read DFPWM files from disk, decode them to PCM, and then play them
 using the speaker.
 
 Let's dive in with an example, and we'll explain things afterwards:
@@ -125,16 +125,16 @@ for chunk in io.lines("data/example.dfpwm", 16 * 1024) do
 end
 ```
 
-Once again, we see the @{speaker.playAudio}/@{speaker_audio_empty} loop. However, the rest of the program is a little
+Once again, we see the [`speaker.playAudio`]/[`speaker_audio_empty`] loop. However, the rest of the program is a little
 different.
 
-First, we require the dfpwm module and call @{cc.audio.dfpwm.make_decoder} to construct a new decoder. This decoder
+First, we require the dfpwm module and call [`cc.audio.dfpwm.make_decoder`] to construct a new decoder. This decoder
 accepts blocks of DFPWM data and converts it to a list of 8-bit amplitudes, which we can then play with our speaker.
 
-As mentioned above, @{speaker.playAudio} accepts at most 128×1024 samples in one go. DFPMW uses a single bit for each
+As mentioned above, [`speaker.playAudio`] accepts at most 128×1024 samples in one go. DFPMW uses a single bit for each
 sample, which means we want to process our audio in chunks of 16×1024 bytes (16KiB). In order to do this, we use
-@{io.lines}, which provides a nice way to loop over chunks of a file. You can of course just use @{fs.open} and
-@{fs.BinaryReadHandle.read} if you prefer.
+[`io.lines`], which provides a nice way to loop over chunks of a file. You can of course just use [`fs.open`] and
+[`fs.ReadHandle.read`] if you prefer.
 
 ## Processing audio
 As mentioned near the beginning of this guide, PCM audio is pretty easy to work with as it's just a list of amplitudes.
@@ -189,10 +189,9 @@ for chunk in io.lines("data/example.dfpwm", 16 * 1024) do
 end
 ```
 
-:::note Confused?
-Don't worry if you don't understand this example. It's quite advanced, and does use some ideas that this guide doesn't
-cover. That said, don't be afraid to ask on [GitHub Discussions] or [IRC] either!
-:::
+> [Confused?][!NOTE]
+> Don't worry if you don't understand this example. It's quite advanced, and does use some ideas that this guide doesn't
+> cover. That said, don't be afraid to ask on [GitHub Discussions] or [IRC] either!
 
 It's worth noting that the examples of audio processing we've mentioned here are about manipulating the _amplitude_ of
 the wave. If you wanted to modify the _frequency_ (for instance, shifting the pitch), things get rather more complex.

doc/guides/using_require.md

@@ -13,7 +13,7 @@ A library is a collection of useful functions and other definitions which is sto
 might want to create a library because you have some functions which are used in multiple programs, or just to split
 your program into multiple more modular files.
 
-Let's say we want to create a small library to make working with the @{term|terminal} a little easier. We'll provide two
+Let's say we want to create a small library to make working with the [terminal][`term`] a little easier. We'll provide two
 functions: `reset`, which clears the terminal and sets the cursor to (1, 1), and `write_center`, which prints some text
 in the middle of the screen.
 
@@ -48,32 +48,32 @@ more_term.write_center("Hello, world!")
 When run, this'll clear the screen and print some text in the middle of the first line.
 
 ## require in depth
-While the previous section is a good introduction to how @{require} operates, there are a couple of remaining points
+While the previous section is a good introduction to how [`require`] operates, there are a couple of remaining points
 which are worth mentioning for more advanced usage.
 
 ### Libraries can return anything
 In our above example, we return a table containing the functions we want to expose. However, it's worth pointing out
-that you can return ''anything'' from your library - a table, a function or even just a string! @{require} treats them
+that you can return ''anything'' from your library - a table, a function or even just a string! [`require`] treats them
 all the same, and just returns whatever your library provides.
 
 ### Module resolution and the package path
-In the above examples, we defined our library in a file, and @{require} read from it. While this is what you'll do most
-of the time, it is possible to make @{require} look elsewhere for your library, such as downloading from a website or
+In the above examples, we defined our library in a file, and [`require`] read from it. While this is what you'll do most
+of the time, it is possible to make [`require`] look elsewhere for your library, such as downloading from a website or
 loading from an in-memory library store.
 
-As a result, the *module name* you pass to @{require} doesn't correspond to a file path. One common mistake is to load
+As a result, the *module name* you pass to [`require`] doesn't correspond to a file path. One common mistake is to load
 code from a sub-directory using `require("folder/library")` or even `require("folder/library.lua")`, neither of which
 will do quite what you expect.
 
-When loading libraries (also referred to as *modules*) from files, @{require} searches along the *@{package.path|module
-path}*. By default, this looks something like:
+When loading libraries (also referred to as *modules*) from files, [`require`] searches along the [*module
+path*][`package.path`]. By default, this looks something like:
 
 * `?.lua`
 * `?/init.lua`
 * `/rom/modules/main/?.lua`
 * etc...
 
-When you call `require("my_library")`, @{require} replaces the `?` in each element of the path with your module name, and
+When you call `require("my_library")`, [`require`] replaces the `?` in each element of the path with your module name, and
 checks if the file exists. In this case, we'd look for `my_library.lua`, `my_library/init.lua`,
 `/rom/modules/main/my_library.lua` and so on. Note that this works *relative to the current program*, so if your
 program is actually called `folder/program`, then we'll look for `folder/my_library.lua`, etc...
@@ -86,4 +86,4 @@ before we start looking for the library.
 There are several external resources which go into require in a little more detail:
 
  - The [Lua Module tutorial](http://lua-users.org/wiki/ModulesTutorial) on the Lua wiki.
- - [Lua's manual section on @{require}](https://www.lua.org/manual/5.1/manual.html#pdf-require).
+ - [Lua's manual section on `require`](https://www.lua.org/manual/5.1/manual.html#pdf-require).

doc/index.md

@@ -15,13 +15,13 @@ CC: Tweaked can be installed from [CurseForge] or [Modrinth]. It runs on both [M
 Controlled using the [Lua programming language][lua], CC: Tweaked's computers provides all the tools you need to start
 writing code and automating your Minecraft world.
 
-![A ComputerCraft terminal open and ready to be programmed.](images/basic-terminal.png){.big-image}
+<img alt="A ComputerCraft terminal open and ready to be programmed." src="images/basic-terminal.png" class="big-image" />
 
 While computers are incredibly powerful, they're rather limited by their inability to move about. *Turtles* are the
 solution here. They can move about the world, placing and breaking blocks, swinging a sword to protect you from zombies,
 or whatever else you program them to!
 
-![A turtle tunneling in Minecraft.](images/turtle.png){.big-image}
+<img alt="A turtle tunneling in Minecraft." src="images/turtle.png" class="big-image" />
 
 Not all problems can be solved with a pickaxe though, and so CC: Tweaked also provides a bunch of additional peripherals
 for your computers. You can play a tune with speakers, display text or images on a monitor, connect all your
@@ -30,7 +30,7 @@ computers together with modems, and much more.
 Computers can now also interact with inventories such as chests, allowing you to build complex inventory and item
 management systems.
 
-![A chest's contents being read by a computer and displayed on a monitor.](images/peripherals.png){.big-image}
+<img alt="A chest's contents being read by a computer and displayed on a monitor." src="images/peripherals.png" class="big-image" />
 
 ## Getting Started
 While ComputerCraft is lovely for both experienced programmers and for people who have never coded before, it can be a

doc/reference/breaking_changes.md

@@ -0,0 +1,81 @@
+---
+module: [kind=reference] breaking_changes
+---
+
+<!--
+SPDX-FileCopyrightText: 2019 The CC: Tweaked Developers
+
+SPDX-License-Identifier: MPL-2.0
+-->
+
+# Incompatibilities between versions
+
+CC: Tweaked tries to remain as compatible between versions as possible, meaning most programs written for older version
+of the mod should run fine on later versions.
+
+> [External peripherals][!WARNING]
+>
+> While CC: Tweaked is relatively stable across versions, this may not be true for other mods which add their own
+> peripherals. Older programs which interact with external blocks may not work on newer versions of the game.
+
+However, some changes to the underlying game, or CC: Tweaked's own internals may break some programs. This page serves
+as documentation for breaking changes and "gotchas" one should look out for between versions.
+
+## CC: Tweaked 1.109.0 to 1.109.3 {#cct-1.109}
+
+ - Update to Lua 5.2:
+   - Support for Lua 5.0's pseudo-argument `arg` has been removed. You should always use `...` for varargs.
+   - Environments are no longer baked into the runtime, and instead use the `_ENV` local or upvalue. `getfenv`/`setfenv`
+     now only work on Lua functions with an `_ENV` upvalue. `getfenv` will return the global environment when called
+     with other functions, and `setfenv` will have no effect.
+   - `load`/`loadstring` defaults to using the global environment (`_G`) rather than the current coroutine's
+     environment.
+   - Support for dumping functions (`string.dump`) and loading binary chunks has been removed.
+   - `math.random` now uses Lua 5.4's random number generator.
+
+ - File handles, HTTP requests and websockets now always use the original bytes rather than encoding/decoding to UTF-8.
+
+## Minecraft 1.13 {#mc-1.13}
+ - The "key code" for [`key`] and [`key_up`] events has changed, due to Minecraft updating to LWJGL 3. Make sure you're
+   using the constants provided by the [`keys`] API, rather than hard-coding numerical values.
+
+   Related to this change, the numpad enter key now has a different key code to the enter key. You may need to adjust
+   your programs to handle both. (Note, the `keys.numpadEnter` constant was defined in pre-1.13 versions of CC, but the
+   `keys.enter` constant was queued when the key was pressed)
+
+ - Minecraft 1.13 removed the concept of item damage and block metadata (see ["The Flattening"][flattening]). As a
+   result `turtle.inspect` no longer provides block metadata, and `turtle.getItemDetail` no longer provides damage.
+
+   - Block states (`turtle.inspect().state`) should provide all the same information as block metadata, but in a much
+     more understandable format.
+
+   - Item and block names now represent a unique item type. For instance, wool is split into 16 separate items
+     (`minecraft:white_wool`, etc...) rather than a single `minecraft:wool` with each meta/damage value specifying the
+     colour.
+
+ - Custom ROMs are now provided using data packs rather than resource packs. This should mostly be a matter of renaming
+   the "assets" folder to "data", and placing it in "datapacks", but there are a couple of other gotchas to look out
+   for:
+
+   - Data packs [impose some restrictions on file names][legal_data_pack]. As a result, your programs and directories
+     must all be lower case.
+   - Due to how data packs are read by CC: Tweaked, you may need to use the `/reload` command to see changes to your
+     pack show up on the computer.
+
+   See [the example datapack][datapack-example] for how to get started.
+
+ - Turtles can now be waterlogged and move "through" water sources rather than breaking them.
+
+## CC: Tweaked 1.88.0 {#cc-1.88}
+ - Unlabelled computers and turtles now keep their ID when broken, meaning that unlabelled computers/items do not stack.
+
+## ComputerCraft 1.80pr1 {#cc-1.80}
+ - Programs run via `shell.run` are now started in their own isolated environment. This means globals set by programs
+   will not be accessible outside of this program.
+
+ - Programs containing `/` are looked up in the current directory and are no longer looked up on the path. For instance,
+   you can no longer type `turtle/excavate` to run `/rom/programs/turtle/excavate.lua`.
+
+[flattening]: https://minecraft.wiki/w/Java_Edition_1.13/Flattening
+[legal_data_pack]: https://minecraft.gamepedia.com/Tutorials/Creating_a_data_pack#Legal_characters
+[datapack-example]: https://github.com/cc-tweaked/datapack-example "An example datapack for CC: Tweaked"

doc/reference/feature_compat.md

@@ -9,17 +9,19 @@ SPDX-License-Identifier: MPL-2.0
 -->
 
 # Lua 5.2/5.3 features in CC: Tweaked
-CC: Tweaked is based off of the Cobalt Lua runtime, which uses Lua 5.1. However, Cobalt and CC:T implement additional features from Lua 5.2 and 5.3 (as well as some deprecated 5.0 features) that are not available in base 5.1. This page lists all of the compatibility for these newer versions.
+CC: Tweaked is based off of the Cobalt Lua runtime, which uses Lua 5.2. However, Cobalt and CC:T implement additional
+features from Lua 5.2 and 5.3 (as well as some deprecated 5.0 and 5.1 features). This page lists all of the
+compatibility for these newer versions.
 
 ## Lua 5.2
 | Feature                                                       | Supported? | Notes                                                             |
 |---------------------------------------------------------------|------------|-------------------------------------------------------------------|
-| `goto`/labels                                                 | ❌         |                                                                   |
-| `_ENV`                                                        | 🔶         | The `_ENV` global points to `getfenv()`, but it cannot be set.    |
+| `goto`/labels                                                 | ✔          |                                                                   |
+| `_ENV`                                                        | ✔          |                                                                   |
 | `\z` escape                                                   | ✔          |                                                                   |
 | `\xNN` escape                                                 | ✔          |                                                                   |
 | Hex literal fractional/exponent parts                         | ✔          |                                                                   |
-| Empty statements                                              | ❌         |                                                                   |
+| Empty statements                                              | ✔          |                                                                   |
 | `__len` metamethod                                            | ✔          |                                                                   |
 | `__ipairs` metamethod                                         | ❌         | Deprecated in Lua 5.3. `ipairs` uses `__len`/`__index` instead.   |
 | `__pairs` metamethod                                          | ✔          |                                                                   |
@@ -27,12 +29,12 @@ CC: Tweaked is based off of the Cobalt Lua runtime, which uses Lua 5.1. However,
 | `collectgarbage` isrunning, generational, incremental options | ❌         | `collectgarbage` does not exist in CC:T.                          |
 | New `load` syntax                                             | ✔          |                                                                   |
 | `loadfile` mode parameter                                     | ✔          | Supports both 5.1 and 5.2+ syntax.                                |
-| Removed `loadstring`                                          | 🔶         | Only if `disable_lua51_features` is enabled in the configuration. |
-| Removed `getfenv`, `setfenv`                                  | 🔶         | Only if `disable_lua51_features` is enabled in the configuration. |
+| Removed `loadstring`                                          | ❌         |                                                                   |
+| Removed `getfenv`, `setfenv`                                  | 🔶         | Only supports closures with an `_ENV` upvalue.                    |
 | `rawlen` function                                             | ✔          |                                                                   |
 | Negative index to `select`                                    | ✔          |                                                                   |
-| Removed `unpack`                                              | 🔶         | Only if `disable_lua51_features` is enabled in the configuration. |
-| Arguments to `xpcall`                                         | ✔         |                                                                   |
+| Removed `unpack`                                              | ❌         |                                                                   |
+| Arguments to `xpcall`                                         | ✔          |                                                                   |
 | Second return value from `coroutine.running`                  | ✔          |                                                                   |
 | Removed `module`                                              | ✔          |                                                                   |
 | `package.loaders` -> `package.searchers`                      | ❌         |                                                                   |
@@ -40,14 +42,14 @@ CC: Tweaked is based off of the Cobalt Lua runtime, which uses Lua 5.1. However,
 | `package.config`                                              | ✔          |                                                                   |
 | `package.searchpath`                                          | ✔          |                                                                   |
 | Removed `package.seeall`                                      | ✔          |                                                                   |
-| `string.dump` on functions with upvalues (blanks them out)    | ✔          |                                                                   |
-| `string.rep` separator                                        | ✔         |                                                                   |
+| `string.dump` on functions with upvalues (blanks them out)    | ❌         | `string.dump` is not supported                                    |
+| `string.rep` separator                                        | ✔          |                                                                   |
 | `%g` match group                                              | ❌         |                                                                   |
 | Removal of `%z` match group                                   | ❌         |                                                                   |
-| Removed `table.maxn`                                          | 🔶         | Only if `disable_lua51_features` is enabled in the configuration. |
+| Removed `table.maxn`                                          | ❌         |                                                                   |
 | `table.pack`/`table.unpack`                                   | ✔          |                                                                   |
 | `math.log` base argument                                      | ✔          |                                                                   |
-| Removed `math.log10`                                          | 🔶         | Only if `disable_lua51_features` is enabled in the configuration. |
+| Removed `math.log10`                                          | ❌         |                                                                   |
 | `*L` mode to `file:read`                                      | ✔          |                                                                   |
 | `os.execute` exit type + return value                         | ❌         | `os.execute` does not exist in CC:T.                              |
 | `os.exit` close argument                                      | ❌         | `os.exit` does not exist in CC:T.                                 |
@@ -61,7 +63,7 @@ CC: Tweaked is based off of the Cobalt Lua runtime, which uses Lua 5.1. However,
 | Tail call hooks                                               | ❌         |                                                                   |
 | `=` prefix for chunks                                         | ✔          |                                                                   |
 | Yield across C boundary                                       | ✔          |                                                                   |
-| Removal of ambiguity error                                    | ❌         |                                                                   |
+| Removal of ambiguity error                                    | ✔          |                                                                   |
 | Identifiers may no longer use locale-dependent letters        | ✔          |                                                                   |
 | Ephemeron tables                                              | ❌         |                                                                   |
 | Identical functions may be reused                             | ❌         | Removed in Lua 5.4                                                |

doc/stub/global.lua

@@ -13,22 +13,20 @@ include standard Lua functions.
 
 As it waits for a fixed amount of world ticks, `time` will automatically be
 rounded up to the nearest multiple of 0.05 seconds. If you are using coroutines
-or the @{parallel|parallel API}, it will only pause execution of the current
+or the [parallel API][`parallel`], it will only pause execution of the current
 thread, not the whole program.
 
-:::tip
-Because sleep internally uses timers, it is a function that yields. This means
-that you can use it to prevent "Too long without yielding" errors. However, as
-the minimum sleep time is 0.05 seconds, it will slow your program down.
-:::
+> [!TIP]
+> Because sleep internally uses timers, it is a function that yields. This means
+> that you can use it to prevent "Too long without yielding" errors. However, as
+> the minimum sleep time is 0.05 seconds, it will slow your program down.
 
-:::caution
-Internally, this function queues and waits for a timer event (using
-@{os.startTimer}), however it does not listen for any other events. This means
-that any event that occurs while sleeping will be entirely discarded. If you
-need to receive events while sleeping, consider using @{os.startTimer|timers},
-or the @{parallel|parallel API}.
-:::
+> [!WARNING]
+> Internally, this function queues and waits for a timer event (using
+> [`os.startTimer`]), however it does not listen for any other events. This means
+> that any event that occurs while sleeping will be entirely discarded. If you
+> need to receive events while sleeping, consider using [timers][`os.startTimer`],
+> or the [parallel API][`parallel`].
 
 @tparam number time The number of seconds to sleep for, rounded up to the
 nearest multiple of 0.05.
@@ -116,7 +114,7 @@ function read(replaceChar, history, completeFn, default) end
 
 --- Stores the current ComputerCraft and Minecraft versions.
 --
--- Outside of Minecraft (for instance, in an emulator) @{_HOST} will contain the
+-- Outside of Minecraft (for instance, in an emulator) [`_HOST`] will contain the
 -- emulator's version instead.
 --
 -- For example, `ComputerCraft 1.93.0 (Minecraft 1.15.2)`.

doc/stub/os.lua

@@ -15,27 +15,27 @@ variables and functions exported by it will by available through the use of
 @deprecated When possible it's best to avoid using this function. It pollutes
 the global table and can mask errors.
 
-@{require} should be used to load libraries instead.
+[`require`] should be used to load libraries instead.
 ]]
 function loadAPI(path) end
 
---- Unloads an API which was loaded by @{os.loadAPI}.
+--- Unloads an API which was loaded by [`os.loadAPI`].
 --
 -- This effectively removes the specified table from `_G`.
 --
 -- @tparam string name The name of the API to unload.
 -- @since 1.2
--- @deprecated See @{os.loadAPI} for why.
+-- @deprecated See [`os.loadAPI`] for why.
 function unloadAPI(name) end
 
 --[[- Pause execution of the current thread and waits for any events matching
 `filter`.
 
-This function @{coroutine.yield|yields} the current process and waits for it
+This function [yields][`coroutine.yield`] the current process and waits for it
 to be resumed with a vararg list where the first element matches `filter`.
 If no `filter` is supplied, this will match all events.
 
-Unlike @{os.pullEventRaw}, it will stop the application upon a "terminate"
+Unlike [`os.pullEventRaw`], it will stop the application upon a "terminate"
 event, printing the error "Terminated".
 
 @tparam[opt] string filter Event to filter for.
@@ -69,7 +69,7 @@ function pullEvent(filter) end
 --[[- Pause execution of the current thread and waits for events, including the
 `terminate` event.
 
-This behaves almost the same as @{os.pullEvent}, except it allows you to handle
+This behaves almost the same as [`os.pullEvent`], except it allows you to handle
 the `terminate` event yourself - the program will not stop execution when
 <kbd>Ctrl+T</kbd> is pressed.
 
@@ -89,16 +89,16 @@ the `terminate` event yourself - the program will not stop execution when
 ]]
 function pullEventRaw(filter) end
 
---- Pauses execution for the specified number of seconds, alias of @{_G.sleep}.
+--- Pauses execution for the specified number of seconds, alias of [`_G.sleep`].
 --
 -- @tparam number time The number of seconds to sleep for, rounded up to the
 -- nearest multiple of 0.05.
 function sleep(time) end
 
---- Get the current CraftOS version (for example, `CraftOS 1.8`).
+--- Get the current CraftOS version (for example, `CraftOS 1.9`).
 --
 -- This is defined by `bios.lua`. For the current version of CC:Tweaked, this
--- should return `CraftOS 1.8`.
+-- should return `CraftOS 1.9`.
 --
 -- @treturn string The current CraftOS version.
 -- @usage os.version()
@@ -109,12 +109,12 @@ arguments.
 
 This function does not resolve program names like the shell does. This means
 that, for example, `os.run("edit")` will not work. As well as this, it does not
-provide access to the @{shell} API in the environment. For this behaviour, use
-@{shell.run} instead.
+provide access to the [`shell`] API in the environment. For this behaviour, use
+[`shell.run`] instead.
 
 If the program cannot be found, or failed to run, it will print the error and
 return `false`. If you want to handle this more gracefully, use an alternative
-such as @{loadfile}.
+such as [`loadfile`].
 
 @tparam table env The environment to run the program with.
 @tparam string path The exact path of the program to run.

gradle.properties

@@ -9,8 +9,8 @@ kotlin.stdlib.default.dependency=false
 kotlin.jvm.target.validation.mode=error
 
 # Mod properties
-isUnstable=false
-modVersion=1.107.0
+isUnstable=true
+modVersion=1.109.5
 
 # Minecraft properties: We want to configure this here so we can read it in settings.gradle
-mcVersion=1.20.1
+mcVersion=1.20.4

gradle/libs.versions.toml

@@ -7,75 +7,82 @@
 # Minecraft
 # MC version is specified in gradle.properties, as we need that in settings.gradle.
 # Remember to update corresponding versions in fabric.mod.json/mods.toml
-fabric-api = "0.86.1+1.20.1"
-fabric-loader = "0.14.21"
-forge = "47.1.0"
-forgeSpi = "6.0.0"
+fabric-api = "0.93.1+1.20.4"
+fabric-loader = "0.15.3"
+neoForge = "20.4.142-beta"
+neoForgeSpi = "8.0.1"
 mixin = "0.8.5"
-parchment = "2023.06.26"
-parchmentMc = "1.19.4"
+parchment = "2023.12.31"
+parchmentMc = "1.20.3"
+yarn = "1.20.4+build.3"
 
-# Normal dependencies
-asm = "9.3"
-autoService = "1.0.1"
-checkerFramework = "3.32.0"
-cobalt = "0.7.1"
-cobalt-next = "0.7.2" # Not a real version, used to constrain the version we accept.
-fastutil = "8.5.9"
-guava = "31.1-jre"
-jetbrainsAnnotations = "24.0.1"
+# Core dependencies (these versions are tied to the version Minecraft uses)
+fastutil = "8.5.12"
+guava = "32.1.2-jre"
+netty = "4.1.97.Final"
+slf4j = "2.0.7"
+
+# Core dependencies (independent of Minecraft)
+asm = "9.6"
+autoService = "1.1.1"
+checkerFramework = "3.42.0"
+cobalt = "0.9.0"
+commonsCli = "1.6.0"
+jetbrainsAnnotations = "24.1.0"
 jsr305 = "3.0.2"
 jzlib = "1.1.3"
-kotlin = "1.8.10"
-kotlin-coroutines = "1.6.4"
-netty = "4.1.82.Final"
-nightConfig = "3.6.5"
-slf4j = "1.7.36"
+kotlin = "1.9.21"
+kotlin-coroutines = "1.7.3"
+nightConfig = "3.6.7"
 
 # Minecraft mods
-emi = "1.0.8+1.20.1"
-iris = "1.6.4+1.20"
-jei = "15.2.0.22"
-modmenu = "7.1.0"
+emi = "1.0.30+1.20.4"
+fabricPermissions = "0.3.20230723"
+iris = "1.6.14+1.20.4"
+jei = "16.0.0.28"
+modmenu = "9.0.0"
+moreRed = "4.0.0.4"
 oculus = "1.2.5"
-rei = "12.0.626"
+rei = "14.0.688"
 rubidium = "0.6.1"
 sodium = "mc1.20-0.4.10"
 
 # Testing
-byteBuddy = "1.14.2"
 hamcrest = "2.2"
-jqwik = "1.7.2"
-junit = "5.9.2"
+jqwik = "1.8.2"
+junit = "5.10.1"
 
 # Build tools
-cctJavadoc = "1.7.0"
-checkstyle = "10.3.4"
-curseForgeGradle = "1.0.14"
-errorProne-core = "2.18.0"
-errorProne-plugin = "3.0.1"
-fabric-loom = "1.3.7"
-forgeGradle = "6.0.8"
-githubRelease = "2.2.12"
-ideaExt = "1.1.6"
-illuaminate = "0.1.0-28-ga7efd71"
-librarian = "1.+"
-minotaur = "2.+"
-mixinGradle = "0.7.+"
+cctJavadoc = "1.8.2"
+checkstyle = "10.12.6"
+curseForgeGradle = "1.1.18"
+errorProne-core = "2.23.0"
+errorProne-plugin = "3.1.0"
+fabric-loom = "1.5.7"
+githubRelease = "2.5.2"
+gradleVersions = "0.50.0"
+ideaExt = "1.1.7"
+illuaminate = "0.1.0-44-g9ee0055"
+lwjgl = "3.3.3"
+minotaur = "2.8.7"
+neoGradle = "7.0.85"
 nullAway = "0.9.9"
-quiltflower = "1.10.0"
-spotless = "6.17.0"
+spotless = "6.23.3"
 taskTree = "2.1.1"
-vanillaGradle = "0.2.1-SNAPSHOT"
+teavm = "0.10.0-SQUID.2"
+vanillaExtract = "0.1.1"
+versionCatalogUpdate = "0.8.1"
 
 [libraries]
 # Normal dependencies
 asm = { module = "org.ow2.asm:asm", version.ref = "asm" }
+asm-commons = { module = "org.ow2.asm:asm-commons", version.ref = "asm" }
 autoService = { module = "com.google.auto.service:auto-service", version.ref = "autoService" }
 checkerFramework = { module = "org.checkerframework:checker-qual", version.ref = "checkerFramework" }
-cobalt = { module = "org.squiddev:Cobalt", version.ref = "cobalt" }
+cobalt = { module = "cc.tweaked:cobalt", version.ref = "cobalt" }
+commonsCli = { module = "commons-cli:commons-cli", version.ref = "commonsCli" }
 fastutil = { module = "it.unimi.dsi:fastutil", version.ref = "fastutil" }
-forgeSpi = { module = "net.minecraftforge:forgespi", version.ref = "forgeSpi" }
+neoForgeSpi = { module = "net.neoforged:neoforgespi", version.ref = "neoForgeSpi" }
 guava = { module = "com.google.guava:guava", version.ref = "guava" }
 jetbrainsAnnotations = { module = "org.jetbrains:annotations", version.ref = "jetbrainsAnnotations" }
 jsr305 = { module = "com.google.code.findbugs:jsr305", version.ref = "jsr305" }
@@ -93,13 +100,16 @@ slf4j = { module = "org.slf4j:slf4j-api", version.ref = "slf4j" }
 # Minecraft mods
 fabric-api = { module = "net.fabricmc.fabric-api:fabric-api", version.ref = "fabric-api" }
 fabric-loader = { module = "net.fabricmc:fabric-loader", version.ref = "fabric-loader" }
+fabric-junit = { module = "net.fabricmc:fabric-loader-junit", version.ref = "fabric-loader" }
+fabricPermissions = { module = "me.lucko:fabric-permissions-api", version.ref = "fabricPermissions" }
 emi = { module = "dev.emi:emi-xplat-mojmap", version.ref = "emi" }
 iris = { module = "maven.modrinth:iris", version.ref = "iris" }
-jei-api = { module = "mezz.jei:jei-1.20.1-common-api", version.ref = "jei" }
-jei-fabric = { module = "mezz.jei:jei-1.20.1-fabric", version.ref = "jei" }
-jei-forge = { module = "mezz.jei:jei-1.20.1-forge", version.ref = "jei" }
+jei-api = { module = "mezz.jei:jei-1.20.2-common-api", version.ref = "jei" }
+jei-fabric = { module = "mezz.jei:jei-1.20.2-fabric", version.ref = "jei" }
+jei-forge = { module = "mezz.jei:jei-1.20.2-forge", version.ref = "jei" }
 mixin = { module = "org.spongepowered:mixin", version.ref = "mixin" }
 modmenu = { module = "com.terraformersmc:modmenu", version.ref = "modmenu" }
+moreRed = { module = "commoble.morered:morered-1.20.1", version.ref = "moreRed" }
 oculus = { module = "maven.modrinth:oculus", version.ref = "oculus" }
 rei-api = { module = "me.shedaniel:RoughlyEnoughItems-api", version.ref = "rei" }
 rei-builtin = { module = "me.shedaniel:RoughlyEnoughItems-default-plugin", version.ref = "rei" }
@@ -108,8 +118,6 @@ rubidium = { module = "maven.modrinth:rubidium", version.ref = "rubidium" }
 sodium = { module = "maven.modrinth:sodium", version.ref = "sodium" }
 
 # Testing
-byteBuddyAgent = { module = "net.bytebuddy:byte-buddy-agent", version.ref = "byteBuddy" }
-byteBuddy = { module = "net.bytebuddy:byte-buddy", version.ref = "byteBuddy" }
 hamcrest = { module = "org.hamcrest:hamcrest", version.ref = "hamcrest" }
 jqwik-api = { module = "net.jqwik:jqwik-api", version.ref = "jqwik" }
 jqwik-engine = { module = "net.jqwik:jqwik-engine", version.ref = "jqwik" }
@@ -118,6 +126,12 @@ junit-jupiter-engine = { module = "org.junit.jupiter:junit-jupiter-engine", vers
 junit-jupiter-params = { module = "org.junit.jupiter:junit-jupiter-params", version.ref = "junit" }
 slf4j-simple = { module = "org.slf4j:slf4j-simple", version.ref = "slf4j" }
 
+# LWJGL
+lwjgl-bom = { module = "org.lwjgl:lwjgl-bom", version.ref = "lwjgl" }
+lwjgl-core = { module = "org.lwjgl:lwjgl" }
+lwjgl-opengl = { module = "org.lwjgl:lwjgl-opengl" }
+lwjgl-glfw = { module = "org.lwjgl:lwjgl-glfw" }
+
 # Build tools
 cctJavadoc = { module = "cc.tweaked:cct-javadoc", version.ref = "cctJavadoc" }
 checkstyle = { module = "com.puppycrawl.tools:checkstyle", version.ref = "checkstyle" }
@@ -128,35 +142,45 @@ errorProne-core = { module = "com.google.errorprone:error_prone_core", version.r
 errorProne-plugin = { module = "net.ltgt.gradle:gradle-errorprone-plugin", version.ref = "errorProne-plugin" }
 errorProne-testHelpers = { module = "com.google.errorprone:error_prone_test_helpers", version.ref = "errorProne-core" }
 fabric-loom = { module = "net.fabricmc:fabric-loom", version.ref = "fabric-loom" }
-forgeGradle = { module = "net.minecraftforge.gradle:ForgeGradle", version.ref = "forgeGradle" }
+ideaExt = { module = "gradle.plugin.org.jetbrains.gradle.plugin.idea-ext:gradle-idea-ext", version.ref = "ideaExt" }
 kotlin-plugin = { module = "org.jetbrains.kotlin:kotlin-gradle-plugin", version.ref = "kotlin" }
-librarian = { module = "org.parchmentmc:librarian", version.ref = "librarian" }
 minotaur = { module = "com.modrinth.minotaur:Minotaur", version.ref = "minotaur" }
+neoGradle-userdev = { module = "net.neoforged.gradle:userdev", version.ref = "neoGradle" }
 nullAway = { module = "com.uber.nullaway:nullaway", version.ref = "nullAway" }
-quiltflower = { module = "io.github.juuxel:loom-quiltflower", version.ref = "quiltflower" }
 spotless = { module = "com.diffplug.spotless:spotless-plugin-gradle", version.ref = "spotless" }
-vanillaGradle = { module = "org.spongepowered:vanillagradle", version.ref = "vanillaGradle" }
+teavm-classlib = { module = "org.teavm:teavm-classlib", version.ref = "teavm" }
+teavm-jso = { module = "org.teavm:teavm-jso", version.ref = "teavm" }
+teavm-jso-apis = { module = "org.teavm:teavm-jso-apis", version.ref = "teavm" }
+teavm-jso-impl = { module = "org.teavm:teavm-jso-impl", version.ref = "teavm" }
+teavm-metaprogramming-api = { module = "org.teavm:teavm-metaprogramming-api", version.ref = "teavm" }
+teavm-metaprogramming-impl = { module = "org.teavm:teavm-metaprogramming-impl", version.ref = "teavm" }
+teavm-platform = { module = "org.teavm:teavm-platform", version.ref = "teavm" }
+teavm-tooling = { module = "org.teavm:teavm-tooling", version.ref = "teavm" }
+vanillaExtract = { module = "cc.tweaked.vanilla-extract:plugin", version.ref = "vanillaExtract" }
+yarn = { module = "net.fabricmc:yarn", version.ref = "yarn" }
 
 [plugins]
-forgeGradle = { id = "net.minecraftforge.gradle", version.ref = "forgeGradle" }
 githubRelease = { id = "com.github.breadmoirai.github-release", version.ref = "githubRelease" }
-ideaExt = { id = "org.jetbrains.gradle.plugin.idea-ext", version.ref = "ideaExt" }
+gradleVersions = { id = "com.github.ben-manes.versions", version.ref = "gradleVersions" }
 kotlin = { id = "org.jetbrains.kotlin.jvm", version.ref = "kotlin" }
-librarian = { id = "org.parchmentmc.librarian.forgegradle", version.ref = "librarian" }
-mixinGradle = { id = "org.spongepowered.mixin", version.ref = "mixinGradle" }
 taskTree = { id = "com.dorongold.task-tree", version.ref = "taskTree" }
+versionCatalogUpdate = { id = "nl.littlerobots.version-catalog-update", version.ref = "versionCatalogUpdate" }
 
 [bundles]
+annotations = ["jsr305", "checkerFramework", "jetbrainsAnnotations"]
 kotlin = ["kotlin-stdlib", "kotlin-coroutines"]
 
 # Minecraft
 externalMods-common = ["jei-api", "nightConfig-core", "nightConfig-toml"]
-externalMods-forge-compile = ["oculus", "jei-api"]
-externalMods-forge-runtime = ["jei-forge"]
-externalMods-fabric = ["nightConfig-core", "nightConfig-toml"]
-externalMods-fabric-compile = ["iris", "jei-api", "rei-api", "rei-builtin"]
-externalMods-fabric-runtime = ["jei-fabric", "modmenu"]
+externalMods-forge-compile = ["moreRed", "oculus", "jei-api"]
+externalMods-forge-runtime = []
+externalMods-fabric-compile = ["fabricPermissions", "iris", "jei-api", "rei-api", "rei-builtin"]
+externalMods-fabric-runtime = []
 
 # Testing
 test = ["junit-jupiter-api", "junit-jupiter-params", "hamcrest", "jqwik-api"]
 testRuntime = ["junit-jupiter-engine", "jqwik-engine"]
+
+# Build tools
+teavm-api = ["teavm-jso", "teavm-jso-apis", "teavm-platform", "teavm-classlib", "teavm-metaprogramming-api"]
+teavm-tooling = ["teavm-tooling", "teavm-metaprogramming-impl", "teavm-jso-impl"]

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,7 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-8.1.1-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.5-bin.zip
 networkTimeout=10000
+validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists

gradlew

@@ -83,7 +83,8 @@ done
 # This is normally unused
 # shellcheck disable=SC2034
 APP_BASE_NAME=${0##*/}
-APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
+# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
+APP_HOME=$( cd "${APP_HOME:-./}" > /dev/null && pwd -P ) || exit
 
 # Use the maximum available, or set MAX_FD != -1 to use that value.
 MAX_FD=maximum
@@ -130,10 +131,13 @@ location of your Java installation."
     fi
 else
     JAVACMD=java
-    which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
+    if ! command -v java >/dev/null 2>&1
+    then
+        die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
 
 Please set the JAVA_HOME variable in your environment to match the
 location of your Java installation."
+    fi
 fi
 
 # Increase the maximum file descriptors if we can.
@@ -141,7 +145,7 @@ if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
     case $MAX_FD in #(
       max*)
         # In POSIX sh, ulimit -H is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045
+        # shellcheck disable=SC2039,SC3045
         MAX_FD=$( ulimit -H -n ) ||
             warn "Could not query maximum file descriptor limit"
     esac
@@ -149,7 +153,7 @@ if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
       '' | soft) :;; #(
       *)
         # In POSIX sh, ulimit -n is undefined. That's why the result is checked to see if it worked.
-        # shellcheck disable=SC3045
+        # shellcheck disable=SC2039,SC3045
         ulimit -n "$MAX_FD" ||
             warn "Could not set maximum file descriptor limit to $MAX_FD"
     esac
@@ -198,11 +202,11 @@ fi
 # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
 DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
 
-# Collect all arguments for the java command;
-#   * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
-#     shell script including quotes and variable substitutions, so put them in
-#     double quotes to make sure that they get re-expanded; and
-#   * put everything else in single quotes, so that it's not re-expanded.
+# Collect all arguments for the java command:
+#   * DEFAULT_JVM_OPTS, JAVA_OPTS, JAVA_OPTS, and optsEnvironmentVar are not allowed to contain shell fragments,
+#     and any embedded shellness will be escaped.
+#   * For example: A user cannot expect ${Hostname} to be expanded, as it is an environment variable and will be
+#     treated as '${Hostname}' itself on the command line.
 
 set -- \
         "-Dorg.gradle.appname=$APP_BASE_NAME" \

illuaminate.sexp

@@ -2,16 +2,15 @@
 
 ; SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
 ;
-; SPDX-License-Identifier: LicenseRef-CCPL
+; SPDX-License-Identifier: MPL-2.0
 
 (sources
   /doc/
-  /projects/forge/build/docs/luaJavadoc/
+  /projects/common/build/docs/luaJavadoc/
   /projects/core/src/main/resources/data/computercraft/lua/bios.lua
   /projects/core/src/main/resources/data/computercraft/lua/rom/
   /projects/core/src/test/resources/test-rom
-  /projects/web/src/mount)
-
+  /projects/web/src/frontend/mount)
 
 (doc
   ; Also defined in projects/web/build.gradle.kts
@@ -24,7 +23,7 @@
     (url https://tweaked.cc/)
     (source-link https://github.com/cc-tweaked/CC-Tweaked/blob/${commit}/${path}#L${line})
 
-    (styles /projects/web/src/styles.css)
+    (styles  /projects/web/build/rollup/index.css)
     (scripts /projects/web/build/rollup/index.js)
     (head doc/head.html))
 
@@ -37,7 +36,7 @@
 
   (library-path
     /doc/stub/
-    /projects/forge/build/docs/luaJavadoc/
+    /projects/common/build/docs/luaJavadoc/
 
     /projects/core/src/main/resources/data/computercraft/lua/rom/apis/
     /projects/core/src/main/resources/data/computercraft/lua/rom/apis/command/
@@ -50,6 +49,8 @@
 (at /
   (linters
     syntax:string-index
+    doc:docusaurus-admonition
+    doc:ldoc-reference
 
     ;; It'd be nice to avoid this, but right now there's a lot of instances of
     ;; it.
@@ -76,29 +77,24 @@
     (globals
       :max
       _CC_DEFAULT_SETTINGS
-      _CC_DISABLE_LUA51_FEATURES
       _HOST
       ;; Ideally we'd pick these up from bios.lua, but illuaminate currently
       ;; isn't smart enough.
       sleep write printError read rs)))
 
-;; We disable the unused global linter in bios.lua and the APIs. In the future
-;; hopefully we'll get illuaminate to handle this.
+;; We disable the unused global linter in bios.lua, APIs and our documentation
+;; stubs docs. In the future hopefully we'll get illuaminate to handle this.
 (at
-  (/projects/core/src/main/resources/data/computercraft/lua/bios.lua
-   /projects/core/src/main/resources/data/computercraft/lua/rom/apis/)
-  (linters -var:unused-global)
-  (lint (allow-toplevel-global true)))
-
-;; Silence some variable warnings in documentation stubs.
-(at (/doc/stub/ /projects/forge/build/docs/luaJavadoc/)
+  (/doc/stub/
+   /projects/core/src/main/resources/data/computercraft/lua/bios.lua
+   /projects/core/src/main/resources/data/computercraft/lua/rom/apis/
+   /projects/common/build/docs/luaJavadoc/)
   (linters -var:unused-global)
   (lint (allow-toplevel-global true)))
 
 ;; Suppress warnings for currently undocumented modules.
 (at
   (; Lua APIs
-   /projects/core/src/main/resources/data/computercraft/lua/rom/apis/io.lua
    /projects/core/src/main/resources/data/computercraft/lua/rom/apis/window.lua)
 
   (linters -doc:undocumented -doc:undocumented-arg -doc:undocumented-return))
@@ -118,4 +114,4 @@
       :max sleep write
       cct_test describe expect howlci fail it pending stub before_each)))
 
-(at /projects/web/src/mount/expr_template.lua (lint (globals :max __expr__)))
+(at /projects/web/src/frontend/mount/expr_template.lua (lint (globals :max __expr__)))

package.json

@@ -6,24 +6,24 @@
   "license": "BSD-3-Clause",
   "type": "module",
   "dependencies": {
+    "@squid-dev/cc-web-term": "^2.0.0",
     "preact": "^10.5.5",
+    "setimmediate": "^1.0.5",
     "tslib": "^2.0.3"
   },
   "devDependencies": {
-    "@rollup/plugin-terser": "^0.4.0",
+    "@rollup/plugin-node-resolve": "^15.2.1",
     "@rollup/plugin-typescript": "^11.0.0",
     "@rollup/plugin-url": "^8.0.1",
-    "@types/glob": "^8.1.0",
-    "@types/react-dom": "^18.0.5",
-    "glob": "^9.3.0",
-    "react-dom": "^18.1.0",
-    "react": "^18.1.0",
-    "rehype-highlight": "^6.0.0",
-    "rehype-react": "^7.1.1",
-    "rehype": "^12.0.1",
-    "requirejs": "^2.3.6",
-    "rollup": "^3.19.1",
-    "ts-node": "^10.8.0",
-    "typescript": "^4.0.5"
+    "@swc/core": "^1.3.92",
+    "@types/node": "^20.8.3",
+    "lightningcss": "^1.22.0",
+    "preact-render-to-string": "^6.2.1",
+    "rehype": "^13.0.0",
+    "rehype-highlight": "^7.0.0",
+    "rehype-react": "^8.0.0",
+    "rollup": "^4.0.0",
+    "tsx": "^4.7.0",
+    "typescript": "^5.2.2"
   }
 }

projects/ARCHITECTURE.md

@@ -62,6 +62,9 @@ mentioning:
  - `lints`: This defines an [ErrorProne] plugin which adds a couple of compile-time checks to our code. This is what
    enforces that no client-specific code is used inside the `main` source set (and a couple of other things!).
 
+ - `standalone`: This contains a standalone UI for computers, allowing debugging and development of CraftOS without
+   launching Minecraft.
+
  - `web`: This contains the additional tooling for building [the documentation website][tweaked.cc], such as support for
    rendering recipes
 

projects/common-api/src/client/java/dan200/computercraft/api/client/turtle/RegisterTurtleUpgradeModeller.java

@@ -0,0 +1,26 @@
+// SPDX-FileCopyrightText: 2023 The CC: Tweaked Developers
+//
+// SPDX-License-Identifier: MPL-2.0
+
+package dan200.computercraft.api.client.turtle;
+
+import dan200.computercraft.api.turtle.ITurtleUpgrade;
+import dan200.computercraft.api.upgrades.UpgradeSerialiser;
+
+/**
+ * A functional interface to register a {@link TurtleUpgradeModeller} for a class of turtle upgrades.
+ * <p>
+ * This interface is largely intended to be used from multi-loader code, to allow sharing registration code between
+ * multiple loaders.
+ */
+@FunctionalInterface
+public interface RegisterTurtleUpgradeModeller {
+    /**
+     * Register a {@link TurtleUpgradeModeller}.
+     *
+     * @param serialiser The turtle upgrade serialiser.
+     * @param modeller   The upgrade modeller.
+     * @param <T>        The type of the turtle upgrade.
+     */
+    <T extends ITurtleUpgrade> void register(UpgradeSerialiser<T> serialiser, TurtleUpgradeModeller<T> modeller);
+}

projects/common-api/src/client/java/dan200/computercraft/api/client/turtle/TurtleUpgradeModeller.java

@@ -4,13 +4,10 @@
 
 package dan200.computercraft.api.client.turtle;
 
-import dan200.computercraft.api.client.ComputerCraftAPIClient;
 import dan200.computercraft.api.client.TransformedModel;
 import dan200.computercraft.api.turtle.ITurtleAccess;
 import dan200.computercraft.api.turtle.ITurtleUpgrade;
 import dan200.computercraft.api.turtle.TurtleSide;
-import dan200.computercraft.api.turtle.TurtleUpgradeSerialiser;
-import net.minecraft.client.resources.model.ModelResourceLocation;
 import net.minecraft.client.resources.model.UnbakedModel;
 import net.minecraft.nbt.CompoundTag;
 import net.minecraft.resources.ResourceLocation;
@@ -21,38 +18,27 @@ import java.util.List;
 
 /**
  * Provides models for a {@link ITurtleUpgrade}.
+ * <p>
+ * Use {@code dan200.computercraft.api.client.FabricComputerCraftAPIClient#registerTurtleUpgradeModeller} to register a
+ * modeller on Fabric and {@code dan200.computercraft.api.client.turtle.RegisterTurtleModellersEvent} to register one
+ * on Forge
  *
  * @param <T> The type of turtle upgrade this modeller applies to.
- * @see ComputerCraftAPIClient#registerTurtleUpgradeModeller(TurtleUpgradeSerialiser, TurtleUpgradeModeller) To register a modeller.
+ * @see RegisterTurtleUpgradeModeller For multi-loader registration support.
  */
 public interface TurtleUpgradeModeller<T extends ITurtleUpgrade> {
     /**
      * Obtain the model to be used when rendering a turtle peripheral.
      * <p>
-     * When the current turtle is {@literal null}, this function should be constant for a given upgrade and side.
+     * When the current turtle is {@literal null}, this function should be constant for a given upgrade, side and data.
      *
      * @param upgrade The upgrade that you're getting the model for.
-     * @param turtle  Access to the turtle that the upgrade resides on. This will be null when getting item models, unless
-     *                {@link #getModel(ITurtleUpgrade, CompoundTag, TurtleSide)} is overriden.
+     * @param turtle  Access to the turtle that the upgrade resides on. This will be null when getting item models.
      * @param side    Which side of the turtle (left or right) the upgrade resides on.
-     * @return The model that you wish to be used to render your upgrade.
-     */
-    TransformedModel getModel(T upgrade, @Nullable ITurtleAccess turtle, TurtleSide side);
-
-    /**
-     * Obtain the model to be used when rendering a turtle peripheral.
-     * <p>
-     * This is used when rendering the turtle's item model, and so no {@link ITurtleAccess} is available.
-     *
-     * @param upgrade The upgrade that you're getting the model for.
      * @param data    Upgrade data instance for current turtle side.
-     * @param side    Which side of the turtle (left or right) the upgrade resides on.
      * @return The model that you wish to be used to render your upgrade.
      */
-    default TransformedModel getModel(T upgrade, CompoundTag data, TurtleSide side) {
-        return getModel(upgrade, (ITurtleAccess) null, side);
-    }
-
+    TransformedModel getModel(T upgrade, @Nullable ITurtleAccess turtle, TurtleSide side, CompoundTag data);
 
     /**
      * Get a list of models that this turtle modeller depends on.
@@ -83,19 +69,6 @@ public interface TurtleUpgradeModeller<T extends ITurtleUpgrade> {
         return (TurtleUpgradeModeller<T>) TurtleUpgradeModellers.UPGRADE_ITEM;
     }
 
-    /**
-     * Construct a {@link TurtleUpgradeModeller} which has a single model for the left and right side.
-     *
-     * @param left  The model to use on the left.
-     * @param right The model to use on the right.
-     * @param <T>   The type of the turtle upgrade.
-     * @return The constructed modeller.
-     */
-    static <T extends ITurtleUpgrade> TurtleUpgradeModeller<T> sided(ModelResourceLocation left, ModelResourceLocation right) {
-        // TODO(1.21.0): Remove this.
-        return sided((ResourceLocation) left, right);
-    }
-
     /**
      * Construct a {@link TurtleUpgradeModeller} which has a single model for the left and right side.
      *
@@ -107,7 +80,7 @@ public interface TurtleUpgradeModeller<T extends ITurtleUpgrade> {
     static <T extends ITurtleUpgrade> TurtleUpgradeModeller<T> sided(ResourceLocation left, ResourceLocation right) {
         return new TurtleUpgradeModeller<>() {
             @Override
-            public TransformedModel getModel(T upgrade, @Nullable ITurtleAccess turtle, TurtleSide side) {
+            public TransformedModel getModel(T upgrade, @Nullable ITurtleAccess turtle, TurtleSide side, CompoundTag data) {
                 return TransformedModel.of(side == TurtleSide.LEFT ? left : right);
             }
 

projects/common-api/src/client/java/dan200/computercraft/api/client/turtle/TurtleUpgradeModellers.java

@@ -12,12 +12,11 @@ import dan200.computercraft.api.turtle.TurtleSide;
 import dan200.computercraft.impl.client.ClientPlatformHelper;
 import net.minecraft.client.Minecraft;
 import net.minecraft.nbt.CompoundTag;
-import net.minecraft.world.item.ItemStack;
 import org.joml.Matrix4f;
 
 import javax.annotation.Nullable;
 
-class TurtleUpgradeModellers {
+final class TurtleUpgradeModellers {
     private static final Transformation leftTransform = getMatrixFor(-0.4065f);
     private static final Transformation rightTransform = getMatrixFor(0.4065f);
 
@@ -35,18 +34,10 @@ class TurtleUpgradeModellers {
 
     static final TurtleUpgradeModeller<ITurtleUpgrade> UPGRADE_ITEM = new UpgradeItemModeller();
 
-    private static class UpgradeItemModeller implements TurtleUpgradeModeller<ITurtleUpgrade> {
+    private static final class UpgradeItemModeller implements TurtleUpgradeModeller<ITurtleUpgrade> {
         @Override
-        public TransformedModel getModel(ITurtleUpgrade upgrade, @Nullable ITurtleAccess turtle, TurtleSide side) {
-            return getModel(turtle == null ? upgrade.getCraftingItem() : upgrade.getUpgradeItem(turtle.getUpgradeNBTData(side)), side);
-        }
-
-        @Override
-        public TransformedModel getModel(ITurtleUpgrade upgrade, CompoundTag data, TurtleSide side) {
-            return getModel(upgrade.getUpgradeItem(data), side);
-        }
-
-        private TransformedModel getModel(ItemStack stack, TurtleSide side) {
+        public TransformedModel getModel(ITurtleUpgrade upgrade, @Nullable ITurtleAccess turtle, TurtleSide side, CompoundTag data) {
+            var stack = upgrade.getUpgradeItem(data);
             var model = Minecraft.getInstance().getItemRenderer().getItemModelShaper().getItemModel(stack);
             if (stack.hasFoil()) model = ClientPlatformHelper.get().createdFoiledModel(model);
             return new TransformedModel(model, side == TurtleSide.LEFT ? leftTransform : rightTransform);

projects/common-api/src/main/java/dan200/computercraft/api/ComputerCraftTags.java

@@ -46,6 +46,14 @@ public class ComputerCraftTags {
         public static final TagKey<Block> WIRED_MODEM = make("wired_modem");
         public static final TagKey<Block> MONITOR = make("monitor");
 
+        /**
+         * Blocks which should be ignored by a {@code peripheral_hub} peripheral.
+         * <p>
+         * This should include blocks which themselves expose a peripheral hub (such as {@linkplain #WIRED_MODEM wired
+         * modems}).
+         */
+        public static final TagKey<Block> PERIPHERAL_HUB_IGNORE = make("peripheral_hub_ignore");
+
         /**
          * Blocks which can be broken by any turtle tool.
          */

projects/common-api/src/main/java/dan200/computercraft/api/pocket/IPocketAccess.java

@@ -4,15 +4,12 @@
 
 package dan200.computercraft.api.pocket;
 
-import dan200.computercraft.api.peripheral.IPeripheral;
 import dan200.computercraft.api.upgrades.UpgradeBase;
 import net.minecraft.nbt.CompoundTag;
-import net.minecraft.resources.ResourceLocation;
 import net.minecraft.world.entity.Entity;
 import net.minecraft.world.item.ItemStack;
 
 import javax.annotation.Nullable;
-import java.util.Map;
 
 /**
  * Wrapper class for pocket computers.
@@ -90,13 +87,4 @@ public interface IPocketAccess {
      * entity} changes.
      */
     void invalidatePeripheral();
-
-    /**
-     * Get a list of all upgrades for the pocket computer.
-     *
-     * @return A collection of all upgrade names.
-     * @deprecated This is a relic of a previous API, which no longer makes sense with newer versions of ComputerCraft.
-     */
-    @Deprecated(forRemoval = true)
-    Map<ResourceLocation, IPeripheral> getUpgrades();
 }

projects/common-api/src/main/java/dan200/computercraft/api/pocket/IPocketUpgrade.java

@@ -6,6 +6,10 @@ package dan200.computercraft.api.pocket;
 
 import dan200.computercraft.api.peripheral.IPeripheral;
 import dan200.computercraft.api.upgrades.UpgradeBase;
+import dan200.computercraft.api.upgrades.UpgradeSerialiser;
+import dan200.computercraft.impl.ComputerCraftAPIService;
+import net.minecraft.core.Registry;
+import net.minecraft.resources.ResourceKey;
 import net.minecraft.world.level.Level;
 
 import javax.annotation.Nullable;
@@ -13,16 +17,46 @@ import javax.annotation.Nullable;
 /**
  * A peripheral which can be equipped to the back side of a pocket computer.
  * <p>
- * Pocket upgrades are defined in two stages. First, on creates a {@link IPocketUpgrade} subclass and corresponding
- * {@link PocketUpgradeSerialiser} instance, which are then registered in a Forge registry.
+ * Pocket upgrades are defined in two stages. First, one creates a {@link IPocketUpgrade} subclass and corresponding
+ * {@link UpgradeSerialiser} instance, which are then registered in a registry.
  * <p>
  * You then write a JSON file in your mod's {@literal data/} folder. This is then parsed when the world is loaded, and
- * the upgrade registered internally. See the documentation in {@link PocketUpgradeSerialiser} for details on this process
- * and where files should be located.
+ * the upgrade automatically registered. It is recommended this is done via {@linkplain PocketUpgradeDataProvider data
+ * generators}.
  *
- * @see PocketUpgradeSerialiser For how to register a pocket computer upgrade.
+ * <h2>Example</h2>
+ * <pre>{@code
+ * // We use Forge's DeferredRegister to register our serialiser. Fabric mods may register their serialiser directly.
+ * static final DeferredRegister<UpgradeSerialiser<? extends IPocketUpgrade>> SERIALISERS = DeferredRegister.create(IPocketUpgrade.serialiserRegistryKey(), "my_mod");
+ *
+ * // Register a new upgrade serialiser called "my_upgrade".
+ * public static final RegistryObject<UpgradeSerialiser<MyUpgrade>> MY_UPGRADE =
+ *     SERIALISERS.register("my_upgrade", () -> UpgradeSerialiser.simple(MyUpgrade::new));
+ *
+ * // Then in your constructor
+ * SERIALISERS.register(bus);
+ * }</pre>
+ * <p>
+ * We can then define a new upgrade using JSON by placing the following in
+ * {@code data/<my_mod>/computercraft/pocket_upgrades/<my_upgrade_id>.json}.
+ * <pre>{@code
+ * {
+ *     "type": my_mod:my_upgrade",
+ * }
+ * }</pre>
+ * <p>
+ * {@link PocketUpgradeDataProvider} provides a data provider to aid with generating these JSON files.
  */
 public interface IPocketUpgrade extends UpgradeBase {
+    /**
+     * The registry key for upgrade serialisers.
+     *
+     * @return The registry key.
+     */
+    static ResourceKey<Registry<UpgradeSerialiser<? extends IPocketUpgrade>>> serialiserRegistryKey() {
+        return ComputerCraftAPIService.get().pocketUpgradeRegistryId();
+    }
+
     /**
      * Creates a peripheral for the pocket computer.
      * <p>

projects/common-api/src/main/java/dan200/computercraft/api/pocket/PocketUpgradeDataProvider.java

@@ -5,6 +5,7 @@
 package dan200.computercraft.api.pocket;
 
 import dan200.computercraft.api.upgrades.UpgradeDataProvider;
+import dan200.computercraft.api.upgrades.UpgradeSerialiser;
 import net.minecraft.data.DataGenerator;
 import net.minecraft.data.PackOutput;
 
@@ -17,10 +18,11 @@ import java.util.function.Consumer;
  * {@link #addUpgrades(Consumer)} function, construct each upgrade, and pass them off to the provided consumer to
  * generate them.
  *
- * @see PocketUpgradeSerialiser
+ * @see IPocketUpgrade
+ * @see UpgradeSerialiser
  */
-public abstract class PocketUpgradeDataProvider extends UpgradeDataProvider<IPocketUpgrade, PocketUpgradeSerialiser<?>> {
+public abstract class PocketUpgradeDataProvider extends UpgradeDataProvider<IPocketUpgrade> {
     public PocketUpgradeDataProvider(PackOutput output) {
-        super(output, "Pocket Computer Upgrades", "computercraft/pocket_upgrades", PocketUpgradeSerialiser.registryId());
+        super(output, "Pocket Computer Upgrades", "computercraft/pocket_upgrades", IPocketUpgrade.serialiserRegistryKey());
     }
 }

projects/common-api/src/main/java/dan200/computercraft/api/pocket/PocketUpgradeSerialiser.java

@@ -1,79 +0,0 @@
-// SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
-//
-// SPDX-License-Identifier: MPL-2.0
-
-package dan200.computercraft.api.pocket;
-
-import dan200.computercraft.api.upgrades.UpgradeBase;
-import dan200.computercraft.api.upgrades.UpgradeSerialiser;
-import dan200.computercraft.impl.ComputerCraftAPIService;
-import dan200.computercraft.impl.upgrades.SerialiserWithCraftingItem;
-import dan200.computercraft.impl.upgrades.SimpleSerialiser;
-import net.minecraft.core.Registry;
-import net.minecraft.resources.ResourceKey;
-import net.minecraft.resources.ResourceLocation;
-import net.minecraft.world.item.ItemStack;
-import net.minecraft.world.item.crafting.SimpleCraftingRecipeSerializer;
-
-import java.util.function.BiFunction;
-import java.util.function.Function;
-
-/**
- * Reads a {@link IPocketUpgrade} from disk and reads/writes it to a network packet.
- * <p>
- * This follows the same format as {@link dan200.computercraft.api.turtle.TurtleUpgradeSerialiser} - consult the
- * documentation there for more information.
- *
- * @param <T> The type of pocket computer upgrade this is responsible for serialising.
- * @see IPocketUpgrade
- * @see PocketUpgradeDataProvider
- */
-public interface PocketUpgradeSerialiser<T extends IPocketUpgrade> extends UpgradeSerialiser<T> {
-    /**
-     * The ID for the associated registry.
-     *
-     * @return The registry key.
-     */
-    static ResourceKey<Registry<PocketUpgradeSerialiser<?>>> registryId() {
-        return ComputerCraftAPIService.get().pocketUpgradeRegistryId();
-    }
-
-    /**
-     * Create an upgrade serialiser for a simple upgrade. This is similar to a {@link SimpleCraftingRecipeSerializer},
-     * but for upgrades.
-     * <p>
-     * If you might want to vary the item, it's suggested you use {@link #simpleWithCustomItem(BiFunction)} instead.
-     *
-     * @param factory Generate a new upgrade with a specific ID.
-     * @param <T>     The type of the generated upgrade.
-     * @return The serialiser for this upgrade
-     */
-    static <T extends IPocketUpgrade> PocketUpgradeSerialiser<T> simple(Function<ResourceLocation, T> factory) {
-        final class Impl extends SimpleSerialiser<T> implements PocketUpgradeSerialiser<T> {
-            private Impl(Function<ResourceLocation, T> constructor) {
-                super(constructor);
-            }
-        }
-
-        return new Impl(factory);
-    }
-
-    /**
-     * Create an upgrade serialiser for a simple upgrade whose crafting item can be specified.
-     *
-     * @param factory Generate a new upgrade with a specific ID and crafting item. The returned upgrade's
-     *                {@link UpgradeBase#getCraftingItem()} <strong>MUST</strong> equal the provided item.
-     * @param <T>     The type of the generated upgrade.
-     * @return The serialiser for this upgrade.
-     * @see #simple(Function)  For upgrades whose crafting stack should not vary.
-     */
-    static <T extends IPocketUpgrade> PocketUpgradeSerialiser<T> simpleWithCustomItem(BiFunction<ResourceLocation, ItemStack, T> factory) {
-        final class Impl extends SerialiserWithCraftingItem<T> implements PocketUpgradeSerialiser<T> {
-            private Impl(BiFunction<ResourceLocation, ItemStack, T> factory) {
-                super(factory);
-            }
-        }
-
-        return new Impl(factory);
-    }
-}

projects/common-api/src/main/java/dan200/computercraft/api/turtle/ITurtleUpgrade.java

@@ -6,8 +6,12 @@ package dan200.computercraft.api.turtle;
 
 import dan200.computercraft.api.peripheral.IPeripheral;
 import dan200.computercraft.api.upgrades.UpgradeBase;
+import dan200.computercraft.api.upgrades.UpgradeSerialiser;
+import dan200.computercraft.impl.ComputerCraftAPIService;
 import net.minecraft.core.Direction;
+import net.minecraft.core.Registry;
 import net.minecraft.nbt.CompoundTag;
+import net.minecraft.resources.ResourceKey;
 
 import javax.annotation.Nullable;
 
@@ -16,15 +20,54 @@ import javax.annotation.Nullable;
  * peripheral.
  * <p>
  * Turtle upgrades are defined in two stages. First, one creates a {@link ITurtleUpgrade} subclass and corresponding
- * {@link TurtleUpgradeSerialiser} instance, which are then registered in a Forge registry.
+ * {@link UpgradeSerialiser} instance, which are then registered in a registry.
  * <p>
  * You then write a JSON file in your mod's {@literal data/} folder. This is then parsed when the world is loaded, and
- * the upgrade registered internally. See the documentation in {@link TurtleUpgradeSerialiser} for details on this process
- * and where files should be located.
+ * the upgrade automatically registered. It is recommended this is done via {@linkplain TurtleUpgradeDataProvider data
+ * generators}.
  *
- * @see TurtleUpgradeSerialiser For how to register a turtle upgrade.
+ * <h2>Example</h2>
+ * <pre>{@code
+ * // We use Forge's DeferredRegister to register our serialiser. Fabric mods may register their serialiser directly.
+ * static final DeferredRegister<UpgradeSerialiser<? extends ITurtleUpgrade>> SERIALISERS = DeferredRegister.create(ITurtleUpgrade.serialiserRegistryKey(), "my_mod");
+ *
+ * // Register a new upgrade serialiser called "my_upgrade".
+ * public static final RegistryObject<UpgradeSerialiser<MyUpgrade>> MY_UPGRADE =
+ *     SERIALISERS.register( "my_upgrade", () -> TurtleUpgradeSerialiser.simple( MyUpgrade::new ) );
+ *
+ * // Then in your constructor
+ * SERIALISERS.register( bus );
+ * }</pre>
+ * <p>
+ * We can then define a new upgrade using JSON by placing the following in
+ * {@literal data/<my_mod>/computercraft/turtle_upgrades/<my_upgrade_id>.json}}.
+ *
+ * <pre>{@code
+ * {
+ *     "type": my_mod:my_upgrade",
+ * }
+ * }</pre>
+ * <p>
+ * {@link TurtleUpgradeDataProvider} provides a data provider to aid with generating these JSON files.
+ * <p>
+ * Finally, we need to register a model for our upgrade, see
+ * {@link dan200.computercraft.api.client.turtle.TurtleUpgradeModeller} for more information.
+ *
+ * <pre>{@code
+ * // Register our model inside FMLClientSetupEvent
+ * ComputerCraftAPIClient.registerTurtleUpgradeModeller(MY_UPGRADE.get(), TurtleUpgradeModeller.flatItem())
+ * }</pre>
  */
 public interface ITurtleUpgrade extends UpgradeBase {
+    /**
+     * The registry key for upgrade serialisers.
+     *
+     * @return The registry key.
+     */
+    static ResourceKey<Registry<UpgradeSerialiser<? extends ITurtleUpgrade>>> serialiserRegistryKey() {
+        return ComputerCraftAPIService.get().turtleUpgradeRegistryId();
+    }
+
     /**
      * Return whether this turtle adds a tool or a peripheral to the turtle.
      *

projects/common-api/src/main/java/dan200/computercraft/api/turtle/TurtleUpgradeDataProvider.java

@@ -7,8 +7,9 @@ package dan200.computercraft.api.turtle;
 import dan200.computercraft.api.ComputerCraftAPI;
 import dan200.computercraft.api.ComputerCraftTags;
 import dan200.computercraft.api.upgrades.UpgradeDataProvider;
-import dan200.computercraft.impl.PlatformHelper;
-import net.minecraft.core.registries.Registries;
+import dan200.computercraft.api.upgrades.UpgradeSerialiser;
+import dan200.computercraft.impl.RegistryHelper;
+import net.minecraft.core.registries.BuiltInRegistries;
 import net.minecraft.data.DataGenerator;
 import net.minecraft.data.PackOutput;
 import net.minecraft.resources.ResourceLocation;
@@ -29,13 +30,13 @@ import java.util.function.Consumer;
  * {@link #addUpgrades(Consumer)} function, construct each upgrade, and pass them off to the provided consumer to
  * generate them.
  *
- * @see TurtleUpgradeSerialiser
+ * @see ITurtleUpgrade
  */
-public abstract class TurtleUpgradeDataProvider extends UpgradeDataProvider<ITurtleUpgrade, TurtleUpgradeSerialiser<?>> {
+public abstract class TurtleUpgradeDataProvider extends UpgradeDataProvider<ITurtleUpgrade> {
     private static final ResourceLocation TOOL_ID = new ResourceLocation(ComputerCraftAPI.MOD_ID, "tool");
 
     public TurtleUpgradeDataProvider(PackOutput output) {
-        super(output, "Turtle Upgrades", "computercraft/turtle_upgrades", TurtleUpgradeSerialiser.registryId());
+        super(output, "Turtle Upgrades", "computercraft/turtle_upgrades", ITurtleUpgrade.serialiserRegistryKey());
     }
 
     /**
@@ -57,7 +58,7 @@ public abstract class TurtleUpgradeDataProvider extends UpgradeDataProvider<ITur
      */
     public static class ToolBuilder {
         private final ResourceLocation id;
-        private final TurtleUpgradeSerialiser<?> serialiser;
+        private final UpgradeSerialiser<? extends ITurtleUpgrade> serialiser;
         private final Item toolItem;
         private @Nullable String adjective;
         private @Nullable Item craftingItem;
@@ -66,7 +67,7 @@ public abstract class TurtleUpgradeDataProvider extends UpgradeDataProvider<ITur
         private boolean allowEnchantments = false;
         private TurtleToolDurability consumeDurability = TurtleToolDurability.NEVER;
 
-        ToolBuilder(ResourceLocation id, TurtleUpgradeSerialiser<?> serialiser, Item toolItem) {
+        ToolBuilder(ResourceLocation id, UpgradeSerialiser<? extends ITurtleUpgrade> serialiser, Item toolItem) {
             this.id = id;
             this.serialiser = serialiser;
             this.toolItem = toolItem;
@@ -149,12 +150,12 @@ public abstract class TurtleUpgradeDataProvider extends UpgradeDataProvider<ITur
          *
          * @param add The callback given to {@link #addUpgrades(Consumer)}.
          */
-        public void add(Consumer<Upgrade<TurtleUpgradeSerialiser<?>>> add) {
+        public void add(Consumer<Upgrade<UpgradeSerialiser<? extends ITurtleUpgrade>>> add) {
             add.accept(new Upgrade<>(id, serialiser, s -> {
-                s.addProperty("item", PlatformHelper.get().getRegistryKey(Registries.ITEM, toolItem).toString());
+                s.addProperty("item", RegistryHelper.getKeyOrThrow(BuiltInRegistries.ITEM, toolItem).toString());
                 if (adjective != null) s.addProperty("adjective", adjective);
                 if (craftingItem != null) {
-                    s.addProperty("craftItem", PlatformHelper.get().getRegistryKey(Registries.ITEM, craftingItem).toString());
+                    s.addProperty("craftItem", RegistryHelper.getKeyOrThrow(BuiltInRegistries.ITEM, craftingItem).toString());
                 }
                 if (damageMultiplier != null) s.addProperty("damageMultiplier", damageMultiplier);
                 if (breakable != null) s.addProperty("breakable", breakable.location().toString());

projects/common-api/src/main/java/dan200/computercraft/api/turtle/TurtleUpgradeSerialiser.java

@@ -1,114 +0,0 @@
-// SPDX-FileCopyrightText: 2021 The CC: Tweaked Developers
-//
-// SPDX-License-Identifier: MPL-2.0
-
-package dan200.computercraft.api.turtle;
-
-import dan200.computercraft.api.upgrades.UpgradeBase;
-import dan200.computercraft.api.upgrades.UpgradeSerialiser;
-import dan200.computercraft.impl.ComputerCraftAPIService;
-import dan200.computercraft.impl.upgrades.SerialiserWithCraftingItem;
-import dan200.computercraft.impl.upgrades.SimpleSerialiser;
-import net.minecraft.core.Registry;
-import net.minecraft.resources.ResourceKey;
-import net.minecraft.resources.ResourceLocation;
-import net.minecraft.world.item.ItemStack;
-import net.minecraft.world.item.crafting.RecipeSerializer;
-import net.minecraft.world.item.crafting.SimpleCraftingRecipeSerializer;
-
-import java.util.function.BiFunction;
-import java.util.function.Function;
-
-/**
- * Reads a {@link ITurtleUpgrade} from disk and reads/writes it to a network packet.
- * <p>
- * These should be registered in a {@link Registry} while the game is loading, much like {@link RecipeSerializer}s.
- * <p>
- * If your turtle upgrade doesn't have any associated configurable parameters (like most upgrades), you can use
- * {@link #simple(Function)} or {@link #simpleWithCustomItem(BiFunction)} to create a basic upgrade serialiser.
- *
- * <h2>Example (Forge)</h2>
- * <pre>{@code
- * static final DeferredRegister<TurtleUpgradeSerialiser<?>> SERIALISERS = DeferredRegister.create( TurtleUpgradeSerialiser.TYPE, "my_mod" );
- *
- * // Register a new upgrade serialiser called "my_upgrade".
- * public static final RegistryObject<TurtleUpgradeSerialiser<MyUpgrade>> MY_UPGRADE =
- *     SERIALISERS.register( "my_upgrade", () -> TurtleUpgradeSerialiser.simple( MyUpgrade::new ) );
- *
- * // Then in your constructor
- * SERIALISERS.register( bus );
- * }</pre>
- * <p>
- * We can then define a new upgrade using JSON by placing the following in
- * {@literal data/<my_mod>/computercraft/turtle_upgrades/<my_upgrade_id>.json}}.
- *
- * <pre>{@code
- * {
- *     "type": my_mod:my_upgrade",
- * }
- * }</pre>
- * <p>
- * Finally, we need to register a model for our upgrade. This is done with
- * {@link dan200.computercraft.api.client.ComputerCraftAPIClient#registerTurtleUpgradeModeller}:
- *
- * <pre>{@code
- * // Register our model inside FMLClientSetupEvent
- * ComputerCraftAPIClient.registerTurtleUpgradeModeller(MY_UPGRADE.get(), TurtleUpgradeModeller.flatItem())
- * }</pre>
- * <p>
- * {@link TurtleUpgradeDataProvider} provides a data provider to aid with generating these JSON files.
- *
- * @param <T> The type of turtle upgrade this is responsible for serialising.
- * @see ITurtleUpgrade
- * @see TurtleUpgradeDataProvider
- * @see dan200.computercraft.api.client.turtle.TurtleUpgradeModeller
- */
-public interface TurtleUpgradeSerialiser<T extends ITurtleUpgrade> extends UpgradeSerialiser<T> {
-    /**
-     * The ID for the associated registry.
-     *
-     * @return The registry key.
-     */
-    static ResourceKey<Registry<TurtleUpgradeSerialiser<?>>> registryId() {
-        return ComputerCraftAPIService.get().turtleUpgradeRegistryId();
-    }
-
-    /**
-     * Create an upgrade serialiser for a simple upgrade. This is similar to a {@link SimpleCraftingRecipeSerializer},
-     * but for upgrades.
-     * <p>
-     * If you might want to vary the item, it's suggested you use {@link #simpleWithCustomItem(BiFunction)} instead.
-     *
-     * @param factory Generate a new upgrade with a specific ID.
-     * @param <T>     The type of the generated upgrade.
-     * @return The serialiser for this upgrade
-     */
-    static <T extends ITurtleUpgrade> TurtleUpgradeSerialiser<T> simple(Function<ResourceLocation, T> factory) {
-        final class Impl extends SimpleSerialiser<T> implements TurtleUpgradeSerialiser<T> {
-            private Impl(Function<ResourceLocation, T> constructor) {
-                super(constructor);
-            }
-        }
-
-        return new Impl(factory);
-    }
-
-    /**
-     * Create an upgrade serialiser for a simple upgrade whose crafting item can be specified.
-     *
-     * @param factory Generate a new upgrade with a specific ID and crafting item. The returned upgrade's
-     *                {@link UpgradeBase#getCraftingItem()} <strong>MUST</strong> equal the provided item.
-     * @param <T>     The type of the generated upgrade.
-     * @return The serialiser for this upgrade.
-     * @see #simple(Function)  For upgrades whose crafting stack should not vary.
-     */
-    static <T extends ITurtleUpgrade> TurtleUpgradeSerialiser<T> simpleWithCustomItem(BiFunction<ResourceLocation, ItemStack, T> factory) {
-        final class Impl extends SerialiserWithCraftingItem<T> implements TurtleUpgradeSerialiser<T> {
-            private Impl(BiFunction<ResourceLocation, ItemStack, T> factory) {
-                super(factory);
-            }
-        }
-
-        return new Impl(factory);
-    }
-}

projects/common-api/src/main/java/dan200/computercraft/api/upgrades/UpgradeBase.java

@@ -9,7 +9,6 @@ import dan200.computercraft.api.pocket.IPocketUpgrade;
 import dan200.computercraft.api.turtle.ITurtleAccess;
 import dan200.computercraft.api.turtle.ITurtleUpgrade;
 import dan200.computercraft.api.turtle.TurtleSide;
-import dan200.computercraft.impl.PlatformHelper;
 import net.minecraft.Util;
 import net.minecraft.nbt.CompoundTag;
 import net.minecraft.resources.ResourceLocation;
@@ -100,7 +99,7 @@ public interface UpgradeBase {
      * The default check requires that any non-capability NBT is exactly the same as the
      * crafting item, but this may be relaxed for your upgrade.
      * <p>
-     * This is based on {@code net.minecraftforge.common.crafting.StrictNBTIngredient}'s check.
+     * This is based on {@code net.neoforged.common.crafting.StrictNBTIngredient}'s check.
      *
      * @param stack The stack to check. This is guaranteed to be non-empty and have the same item as
      *              {@link #getCraftingItem()}.
@@ -111,12 +110,12 @@ public interface UpgradeBase {
 
         // A more expanded form of ItemStack.areShareTagsEqual, but allowing an empty tag to be equal to a
         // null one.
-        var shareTag = PlatformHelper.get().getShareTag(stack);
-        var craftingShareTag = PlatformHelper.get().getShareTag(crafting);
-        if (shareTag == craftingShareTag) return true;
-        if (shareTag == null) return Objects.requireNonNull(craftingShareTag).isEmpty();
-        if (craftingShareTag == null) return shareTag.isEmpty();
-        return shareTag.equals(craftingShareTag);
+        var tag = stack.getTag();
+        var craftingTag = crafting.getTag();
+        if (tag == craftingTag) return true;
+        if (tag == null) return Objects.requireNonNull(craftingTag).isEmpty();
+        if (craftingTag == null) return tag.isEmpty();
+        return tag.equals(craftingTag);
     }
 
     /**

projects/common-api/src/main/java/dan200/computercraft/api/upgrades/UpgradeDataProvider.java

@@ -6,21 +6,20 @@ package dan200.computercraft.api.upgrades;
 
 import com.google.gson.JsonObject;
 import com.google.gson.JsonParseException;
-import dan200.computercraft.api.turtle.TurtleUpgradeSerialiser;
 import dan200.computercraft.impl.PlatformHelper;
+import dan200.computercraft.impl.RegistryHelper;
 import dan200.computercraft.impl.upgrades.SerialiserWithCraftingItem;
 import dan200.computercraft.impl.upgrades.SimpleSerialiser;
 import net.minecraft.Util;
 import net.minecraft.core.Registry;
-import net.minecraft.core.registries.Registries;
+import net.minecraft.core.registries.BuiltInRegistries;
 import net.minecraft.data.CachedOutput;
 import net.minecraft.data.DataProvider;
 import net.minecraft.data.PackOutput;
 import net.minecraft.resources.ResourceKey;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.world.item.Item;
-import org.apache.logging.log4j.LogManager;
-import org.apache.logging.log4j.Logger;
+import org.jetbrains.annotations.ApiStatus;
 
 import javax.annotation.Nullable;
 import java.util.*;
@@ -33,33 +32,31 @@ import java.util.function.Function;
  * the other subclasses.
  *
  * @param <T> The base class of upgrades.
- * @param <R> The upgrade serialiser to register for.
  */
-public abstract class UpgradeDataProvider<T extends UpgradeBase, R extends UpgradeSerialiser<? extends T>> implements DataProvider {
-    private static final Logger LOGGER = LogManager.getLogger();
-
+public abstract class UpgradeDataProvider<T extends UpgradeBase> implements DataProvider {
     private final PackOutput output;
     private final String name;
     private final String folder;
-    private final ResourceKey<Registry<R>> registry;
+    private final Registry<UpgradeSerialiser<? extends T>> registry;
 
     private @Nullable List<T> upgrades;
 
-    protected UpgradeDataProvider(PackOutput output, String name, String folder, ResourceKey<Registry<R>> registry) {
+    @ApiStatus.Internal
+    protected UpgradeDataProvider(PackOutput output, String name, String folder, ResourceKey<Registry<UpgradeSerialiser<? extends T>>> registry) {
         this.output = output;
         this.name = name;
         this.folder = folder;
-        this.registry = registry;
+        this.registry = RegistryHelper.getRegistry(registry);
     }
 
     /**
-     * Register an upgrade using a "simple" serialiser (e.g. {@link TurtleUpgradeSerialiser#simple(Function)}).
+     * Register an upgrade using a {@linkplain UpgradeSerialiser#simple(Function) "simple" serialiser}.
      *
      * @param id         The ID of the upgrade to create.
      * @param serialiser The simple serialiser.
      * @return The constructed upgrade, ready to be passed off to {@link #addUpgrades(Consumer)}'s consumer.
      */
-    public final Upgrade<R> simple(ResourceLocation id, R serialiser) {
+    public final Upgrade<UpgradeSerialiser<? extends T>> simple(ResourceLocation id, UpgradeSerialiser<? extends T> serialiser) {
         if (!(serialiser instanceof SimpleSerialiser)) {
             throw new IllegalStateException(serialiser + " must be a simple() seriaiser.");
         }
@@ -69,20 +66,20 @@ public abstract class UpgradeDataProvider<T extends UpgradeBase, R extends Upgra
     }
 
     /**
-     * Register an upgrade using a "simple" serialiser (e.g. {@link TurtleUpgradeSerialiser#simple(Function)}).
+     * Register an upgrade using a {@linkplain UpgradeSerialiser#simple(Function) simple serialiser}.
      *
      * @param id         The ID of the upgrade to create.
      * @param serialiser The simple serialiser.
      * @param item       The crafting upgrade for this item.
      * @return The constructed upgrade, ready to be passed off to {@link #addUpgrades(Consumer)}'s consumer.
      */
-    public final Upgrade<R> simpleWithCustomItem(ResourceLocation id, R serialiser, Item item) {
+    public final Upgrade<UpgradeSerialiser<? extends T>> simpleWithCustomItem(ResourceLocation id, UpgradeSerialiser<? extends T> serialiser, Item item) {
         if (!(serialiser instanceof SerialiserWithCraftingItem)) {
             throw new IllegalStateException(serialiser + " must be a simpleWithCustomItem() serialiser.");
         }
 
         return new Upgrade<>(id, serialiser, s ->
-            s.addProperty("item", PlatformHelper.get().getRegistryKey(Registries.ITEM, item).toString())
+            s.addProperty("item", RegistryHelper.getKeyOrThrow(BuiltInRegistries.ITEM, item).toString())
         );
     }
 
@@ -98,7 +95,7 @@ public abstract class UpgradeDataProvider<T extends UpgradeBase, R extends Upgra
      *
      * @param addUpgrade A callback used to register an upgrade.
      */
-    protected abstract void addUpgrades(Consumer<Upgrade<R>> addUpgrade);
+    protected abstract void addUpgrades(Consumer<Upgrade<UpgradeSerialiser<? extends T>>> addUpgrade);
 
     @Override
     public CompletableFuture<?> run(CachedOutput cache) {
@@ -111,7 +108,7 @@ public abstract class UpgradeDataProvider<T extends UpgradeBase, R extends Upgra
             if (!seen.add(upgrade.id())) throw new IllegalStateException("Duplicate upgrade " + upgrade.id());
 
             var json = new JsonObject();
-            json.addProperty("type", PlatformHelper.get().getRegistryKey(registry, upgrade.serialiser()).toString());
+            json.addProperty("type", RegistryHelper.getKeyOrThrow(registry, upgrade.serialiser()).toString());
             upgrade.serialise().accept(json);
 
             futures.add(DataProvider.saveStable(cache, json, base.resolve(upgrade.id().getNamespace() + "/" + folder + "/" + upgrade.id().getPath() + ".json")));
@@ -133,9 +130,9 @@ public abstract class UpgradeDataProvider<T extends UpgradeBase, R extends Upgra
         return name;
     }
 
-    public final R existingSerialiser(ResourceLocation id) {
-        var result = PlatformHelper.get().getRegistryObject(registry, id);
-        if (result == null) throw new IllegalArgumentException("No such serialiser " + registry);
+    public final UpgradeSerialiser<? extends T> existingSerialiser(ResourceLocation id) {
+        var result = registry.get(id);
+        if (result == null) throw new IllegalArgumentException("No such serialiser " + id);
         return result;
     }
 

projects/common-api/src/main/java/dan200/computercraft/api/upgrades/UpgradeSerialiser.java

@@ -5,21 +5,40 @@
 package dan200.computercraft.api.upgrades;
 
 import com.google.gson.JsonObject;
-import dan200.computercraft.api.pocket.PocketUpgradeSerialiser;
-import dan200.computercraft.api.turtle.TurtleUpgradeSerialiser;
+import dan200.computercraft.api.pocket.IPocketUpgrade;
+import dan200.computercraft.api.pocket.PocketUpgradeDataProvider;
+import dan200.computercraft.api.turtle.ITurtleUpgrade;
+import dan200.computercraft.api.turtle.TurtleUpgradeDataProvider;
+import dan200.computercraft.impl.upgrades.SerialiserWithCraftingItem;
+import dan200.computercraft.impl.upgrades.SimpleSerialiser;
+import net.minecraft.core.Registry;
 import net.minecraft.network.FriendlyByteBuf;
 import net.minecraft.resources.ResourceLocation;
+import net.minecraft.world.item.ItemStack;
+import net.minecraft.world.item.crafting.RecipeSerializer;
+import net.minecraft.world.item.crafting.SimpleCraftingRecipeSerializer;
 
+import java.util.function.BiFunction;
+import java.util.function.Function;
 
 /**
- * Base interface for upgrade serialisers. This should generally not be implemented directly, instead implementing one
- * of {@link TurtleUpgradeSerialiser} or {@link PocketUpgradeSerialiser}.
+ * A serialiser for {@link ITurtleUpgrade} or {@link IPocketUpgrade}s.
  * <p>
- * However, it may sometimes be useful to implement this if you have some shared logic between upgrade types.
+ * These should be registered in a {@link Registry} while the game is loading, much like {@link RecipeSerializer}s.
+ * <p>
+ * This interface is very similar to {@link RecipeSerializer}; each serialiser should correspond to a specific upgrade
+ * class. Upgrades are then read from JSON files in datapacks, allowing multiple instances of the upgrade to be
+ * registered.
+ * <p>
+ * If your upgrade doesn't have any associated configurable parameters (like most upgrades), you can use
+ * {@link #simple(Function)} or {@link #simpleWithCustomItem(BiFunction)} to create a basic upgrade serialiser.
+ * <p>
+ * Upgrades may be data generated via a {@link UpgradeDataProvider} (see {@link TurtleUpgradeDataProvider} and
+ * {@link PocketUpgradeDataProvider}).
  *
  * @param <T> The upgrade that this class can serialise and deserialise.
- * @see TurtleUpgradeSerialiser
- * @see PocketUpgradeSerialiser
+ * @see ITurtleUpgrade
+ * @see IPocketUpgrade
  */
 public interface UpgradeSerialiser<T extends UpgradeBase> {
     /**
@@ -49,4 +68,30 @@ public interface UpgradeSerialiser<T extends UpgradeBase> {
      */
     void toNetwork(FriendlyByteBuf buffer, T upgrade);
 
+    /**
+     * Create an upgrade serialiser for a simple upgrade. This is similar to a {@link SimpleCraftingRecipeSerializer},
+     * but for upgrades.
+     * <p>
+     * If you might want to vary the item, it's suggested you use {@link #simpleWithCustomItem(BiFunction)} instead.
+     *
+     * @param factory Generate a new upgrade with a specific ID.
+     * @param <T>     The type of the generated upgrade.
+     * @return The serialiser for this upgrade
+     */
+    static <T extends UpgradeBase> UpgradeSerialiser<T> simple(Function<ResourceLocation, T> factory) {
+        return new SimpleSerialiser<>(factory);
+    }
+
+    /**
+     * Create an upgrade serialiser for a simple upgrade whose crafting item can be specified.
+     *
+     * @param factory Generate a new upgrade with a specific ID and crafting item. The returned upgrade's
+     *                {@link UpgradeBase#getCraftingItem()} <strong>MUST</strong> equal the provided item.
+     * @param <T>     The type of the generated upgrade.
+     * @return The serialiser for this upgrade.
+     * @see #simple(Function)  For upgrades whose crafting stack should not vary.
+     */
+    static <T extends UpgradeBase> UpgradeSerialiser<T> simpleWithCustomItem(BiFunction<ResourceLocation, ItemStack, T> factory) {
+        return new SerialiserWithCraftingItem<>(factory);
+    }
 }

projects/common-api/src/main/java/dan200/computercraft/impl/ComputerCraftAPIService.java

@@ -15,10 +15,11 @@ import dan200.computercraft.api.media.MediaProvider;
 import dan200.computercraft.api.network.PacketNetwork;
 import dan200.computercraft.api.network.wired.WiredElement;
 import dan200.computercraft.api.network.wired.WiredNode;
-import dan200.computercraft.api.pocket.PocketUpgradeSerialiser;
+import dan200.computercraft.api.pocket.IPocketUpgrade;
 import dan200.computercraft.api.redstone.BundledRedstoneProvider;
+import dan200.computercraft.api.turtle.ITurtleUpgrade;
 import dan200.computercraft.api.turtle.TurtleRefuelHandler;
-import dan200.computercraft.api.turtle.TurtleUpgradeSerialiser;
+import dan200.computercraft.api.upgrades.UpgradeSerialiser;
 import net.minecraft.core.BlockPos;
 import net.minecraft.core.Direction;
 import net.minecraft.core.Registry;
@@ -67,9 +68,9 @@ public interface ComputerCraftAPIService {
 
     void registerRefuelHandler(TurtleRefuelHandler handler);
 
-    ResourceKey<Registry<TurtleUpgradeSerialiser<?>>> turtleUpgradeRegistryId();
+    ResourceKey<Registry<UpgradeSerialiser<? extends ITurtleUpgrade>>> turtleUpgradeRegistryId();
 
-    ResourceKey<Registry<PocketUpgradeSerialiser<?>>> pocketUpgradeRegistryId();
+    ResourceKey<Registry<UpgradeSerialiser<? extends IPocketUpgrade>>> pocketUpgradeRegistryId();
 
     DetailRegistry<ItemStack> getItemStackDetailRegistry();
 

projects/common-api/src/main/java/dan200/computercraft/impl/PlatformHelper.java

@@ -6,11 +6,6 @@ package dan200.computercraft.impl;
 
 import com.google.gson.JsonObject;
 import dan200.computercraft.api.upgrades.UpgradeDataProvider;
-import net.minecraft.core.Registry;
-import net.minecraft.nbt.CompoundTag;
-import net.minecraft.resources.ResourceKey;
-import net.minecraft.resources.ResourceLocation;
-import net.minecraft.world.item.ItemStack;
 import org.jetbrains.annotations.ApiStatus;
 
 import javax.annotation.Nullable;
@@ -32,39 +27,6 @@ public interface PlatformHelper {
         return instance == null ? Services.raise(PlatformHelper.class, Instance.ERROR) : instance;
     }
 
-    /**
-     * Get the unique ID for a registered object.
-     *
-     * @param registry The registry to look up this object in.
-     * @param object   The object to look up.
-     * @param <T>      The type of object the registry stores.
-     * @return The registered object's ID.
-     * @throws IllegalArgumentException If the registry or object are not registered.
-     */
-    <T> ResourceLocation getRegistryKey(ResourceKey<Registry<T>> registry, T object);
-
-    /**
-     * Look up an ID in a registry, returning the registered object.
-     *
-     * @param registry The registry to look up this object in.
-     * @param id       The ID to look up.
-     * @param <T>      The type of object the registry stores.
-     * @return The resolved registry object.
-     * @throws IllegalArgumentException If the registry or object are not registered.
-     */
-    <T> T getRegistryObject(ResourceKey<Registry<T>> registry, ResourceLocation id);
-
-    /**
-     * Get the subset of an {@link ItemStack}'s {@linkplain ItemStack#getTag() tag} which is synced to the client.
-     *
-     * @param item The stack.
-     * @return The item's tag.
-     */
-    @Nullable
-    default CompoundTag getShareTag(ItemStack item) {
-        return item.getTag();
-    }
-
     /**
      * Add a resource condition which requires a mod to be loaded. This should be used by data providers such as
      * {@link UpgradeDataProvider}.

projects/common-api/src/main/java/dan200/computercraft/impl/RegistryHelper.java

@@ -0,0 +1,49 @@
+// SPDX-FileCopyrightText: 2023 The CC: Tweaked Developers
+//
+// SPDX-License-Identifier: MPL-2.0
+
+package dan200.computercraft.impl;
+
+import net.minecraft.core.Registry;
+import net.minecraft.core.registries.BuiltInRegistries;
+import net.minecraft.resources.ResourceKey;
+import net.minecraft.resources.ResourceLocation;
+import org.jetbrains.annotations.ApiStatus;
+
+/**
+ * Additioanl functions for working with {@linkplain Registry registries}.
+ */
+@ApiStatus.Internal
+public final class RegistryHelper {
+    private RegistryHelper() {
+    }
+
+    /**
+     * Find a registry from a {@link ResourceKey}, throwing if it does not exist.
+     *
+     * @param id  The id of the registry.
+     * @param <T> The contents of the registry
+     * @return The associated registry.
+     */
+    @SuppressWarnings("unchecked")
+    public static <T> Registry<T> getRegistry(ResourceKey<Registry<T>> id) {
+        var registry = (Registry<T>) BuiltInRegistries.REGISTRY.get(id.location());
+        if (registry == null) throw new IllegalArgumentException("Unknown registry " + id);
+        return registry;
+    }
+
+    /**
+     * Get the key of a registry entry, throwing if it is not registered.
+     *
+     * @param registry The registry to look up in.
+     * @param object   The object to look up.
+     * @param <T>      The type of this registry.
+     * @return The ID of this object
+     * @see Registry#getResourceKey(Object)
+     */
+    public static <T> ResourceLocation getKeyOrThrow(Registry<T> registry, T object) {
+        var key = registry.getResourceKey(object);
+        if (key.isEmpty()) throw new IllegalArgumentException(object + " was not registered in " + registry.key());
+        return key.get().location();
+    }
+}

projects/common-api/src/main/java/dan200/computercraft/impl/upgrades/SerialiserWithCraftingItem.java

@@ -23,27 +23,27 @@ import java.util.function.BiFunction;
  * @param <T> The upgrade that this class can serialise and deserialise.
  */
 @ApiStatus.Internal
-public abstract class SerialiserWithCraftingItem<T extends UpgradeBase> implements UpgradeSerialiser<T> {
+public final class SerialiserWithCraftingItem<T extends UpgradeBase> implements UpgradeSerialiser<T> {
     private final BiFunction<ResourceLocation, ItemStack, T> factory;
 
-    protected SerialiserWithCraftingItem(BiFunction<ResourceLocation, ItemStack, T> factory) {
+    public SerialiserWithCraftingItem(BiFunction<ResourceLocation, ItemStack, T> factory) {
         this.factory = factory;
     }
 
     @Override
-    public final T fromJson(ResourceLocation id, JsonObject object) {
+    public T fromJson(ResourceLocation id, JsonObject object) {
         var item = GsonHelper.getAsItem(object, "item");
         return factory.apply(id, new ItemStack(item));
     }
 
     @Override
-    public final T fromNetwork(ResourceLocation id, FriendlyByteBuf buffer) {
+    public T fromNetwork(ResourceLocation id, FriendlyByteBuf buffer) {
         var item = buffer.readItem();
         return factory.apply(id, item);
     }
 
     @Override
-    public final void toNetwork(FriendlyByteBuf buffer, T upgrade) {
+    public void toNetwork(FriendlyByteBuf buffer, T upgrade) {
         buffer.writeItem(upgrade.getCraftingItem());
     }
 }

projects/common-api/src/main/java/dan200/computercraft/impl/upgrades/SimpleSerialiser.java

@@ -21,7 +21,7 @@ import java.util.function.Function;
  * @param <T> The upgrade that this class can serialise and deserialise.
  */
 @ApiStatus.Internal
-public abstract class SimpleSerialiser<T extends UpgradeBase> implements UpgradeSerialiser<T> {
+public final class SimpleSerialiser<T extends UpgradeBase> implements UpgradeSerialiser<T> {
     private final Function<ResourceLocation, T> constructor;
 
     public SimpleSerialiser(Function<ResourceLocation, T> constructor) {
@@ -29,16 +29,16 @@ public abstract class SimpleSerialiser<T extends UpgradeBase> implements Upgrade
     }
 
     @Override
-    public final T fromJson(ResourceLocation id, JsonObject object) {
+    public T fromJson(ResourceLocation id, JsonObject object) {
         return constructor.apply(id);
     }
 
     @Override
-    public final T fromNetwork(ResourceLocation id, FriendlyByteBuf buffer) {
+    public T fromNetwork(ResourceLocation id, FriendlyByteBuf buffer) {
         return constructor.apply(id);
     }
 
     @Override
-    public final void toNetwork(FriendlyByteBuf buffer, T upgrade) {
+    public void toNetwork(FriendlyByteBuf buffer, T upgrade) {
     }
 }

projects/common/build.gradle.kts

@@ -2,14 +2,13 @@
 //
 // SPDX-License-Identifier: MPL-2.0
 
-import cc.tweaked.gradle.annotationProcessorEverywhere
-import cc.tweaked.gradle.clientClasses
-import cc.tweaked.gradle.commonClasses
+import cc.tweaked.gradle.*
 
 plugins {
-    id("cc-tweaked.publishing")
     id("cc-tweaked.vanilla")
     id("cc-tweaked.gametest")
+    id("cc-tweaked.illuaminate")
+    id("cc-tweaked.publishing")
 }
 
 minecraft {
@@ -19,6 +18,18 @@ minecraft {
     )
 }
 
+configurations {
+    register("cctJavadoc")
+}
+
+repositories {
+    maven("https://maven.minecraftforge.net/") {
+        content {
+            includeModule("org.spongepowered", "mixin")
+        }
+    }
+}
+
 dependencies {
     // Pull in our other projects. See comments in MinecraftConfigurations on this nastiness.
     implementation(project(":core"))
@@ -28,7 +39,6 @@ dependencies {
     compileOnly(libs.bundles.externalMods.common)
     clientCompileOnly(variantOf(libs.emi) { classifier("api") })
 
-    compileOnly(libs.mixin)
     annotationProcessorEverywhere(libs.autoService)
     testFixturesAnnotationProcessor(libs.autoService)
 
@@ -36,7 +46,59 @@ dependencies {
     testImplementation(libs.bundles.test)
     testRuntimeOnly(libs.bundles.testRuntime)
 
+    testModCompileOnly(libs.mixin)
     testModImplementation(testFixtures(project(":core")))
     testModImplementation(testFixtures(project(":common")))
     testModImplementation(libs.bundles.kotlin)
+
+    testFixturesImplementation(testFixtures(project(":core")))
+
+    "cctJavadoc"(libs.cctJavadoc)
+}
+
+illuaminate {
+    version.set(libs.versions.illuaminate)
+}
+
+val luaJavadoc by tasks.registering(Javadoc::class) {
+    description = "Generates documentation for Java-side Lua functions."
+    group = JavaBasePlugin.DOCUMENTATION_GROUP
+
+    val sourceSets = listOf(sourceSets.main.get(), project(":core").sourceSets.main.get())
+    for (sourceSet in sourceSets) {
+        source(sourceSet.java)
+        classpath += sourceSet.compileClasspath
+    }
+
+    destinationDir = layout.buildDirectory.dir("docs/luaJavadoc").get().asFile
+
+    val options = options as StandardJavadocDocletOptions
+    options.docletpath = configurations["cctJavadoc"].files.toList()
+    options.doclet = "cc.tweaked.javadoc.LuaDoclet"
+    options.addStringOption("project-root", rootProject.file(".").absolutePath)
+    options.noTimestamp(false)
+
+    javadocTool.set(
+        javaToolchains.javadocToolFor {
+            languageVersion.set(CCTweakedPlugin.JAVA_VERSION)
+        },
+    )
+}
+
+val lintLua by tasks.registering(IlluaminateExec::class) {
+    group = JavaBasePlugin.VERIFICATION_GROUP
+    description = "Lint Lua (and Lua docs) with illuaminate"
+
+    // Config files
+    inputs.file(rootProject.file("illuaminate.sexp")).withPropertyName("illuaminate.sexp")
+    // Sources
+    inputs.files(rootProject.fileTree("doc")).withPropertyName("docs")
+    inputs.files(project(":core").fileTree("src/main/resources/data/computercraft/lua")).withPropertyName("lua rom")
+    inputs.files(luaJavadoc)
+
+    args = listOf("lint")
+    workingDir = rootProject.projectDir
+
+    doFirst { if (System.getenv("GITHUB_ACTIONS") != null) println("::add-matcher::.github/matchers/illuaminate.json") }
+    doLast { if (System.getenv("GITHUB_ACTIONS") != null) println("::remove-matcher owner=illuaminate::") }
 }

projects/common/src/client/java/dan200/computercraft/client/ClientHooks.java

@@ -17,8 +17,6 @@ import dan200.computercraft.client.render.monitor.MonitorRenderState;
 import dan200.computercraft.client.sound.SpeakerManager;
 import dan200.computercraft.shared.CommonHooks;
 import dan200.computercraft.shared.ModRegistry;
-import dan200.computercraft.shared.command.CommandComputerCraft;
-import dan200.computercraft.shared.computer.core.ServerContext;
 import dan200.computercraft.shared.media.items.PrintoutItem;
 import dan200.computercraft.shared.peripheral.modem.wired.CableBlock;
 import dan200.computercraft.shared.peripheral.modem.wired.CableModemVariant;
@@ -28,7 +26,6 @@ import dan200.computercraft.shared.pocket.items.PocketComputerItem;
 import dan200.computercraft.shared.turtle.blocks.TurtleBlockEntity;
 import dan200.computercraft.shared.util.PauseAwareTimer;
 import dan200.computercraft.shared.util.WorldUtil;
-import net.minecraft.Util;
 import net.minecraft.client.Camera;
 import net.minecraft.client.Minecraft;
 import net.minecraft.client.renderer.MultiBufferSource;
@@ -43,7 +40,6 @@ import net.minecraft.world.phys.BlockHitResult;
 import net.minecraft.world.phys.HitResult;
 
 import javax.annotation.Nullable;
-import java.io.File;
 import java.util.function.Consumer;
 
 /**
@@ -71,10 +67,6 @@ public final class ClientHooks {
         ClientPocketComputers.reset();
     }
 
-    public static boolean onChatMessage(String message) {
-        return handleOpenComputerCommand(message);
-    }
-
     public static boolean drawHighlight(PoseStack transform, MultiBufferSource bufferSource, Camera camera, BlockHitResult hit) {
         return CableHighlightRenderer.drawHighlight(transform, bufferSource, camera, hit)
             || MonitorHighlightRenderer.drawHighlight(transform, bufferSource, camera, hit);
@@ -109,34 +101,6 @@ public final class ClientHooks {
         SpeakerManager.onPlayStreaming(engine, channel, stream);
     }
 
-    /**
-     * Handle the {@link CommandComputerCraft#OPEN_COMPUTER} "clientside command". This isn't a true command, as we
-     * don't want it to actually be visible to the user.
-     *
-     * @param message The current chat message.
-     * @return Whether to cancel sending this message.
-     */
-    private static boolean handleOpenComputerCommand(String message) {
-        if (!message.startsWith(CommandComputerCraft.OPEN_COMPUTER)) return false;
-
-        var server = Minecraft.getInstance().getSingleplayerServer();
-        if (server == null) return false;
-
-        var idStr = message.substring(CommandComputerCraft.OPEN_COMPUTER.length()).trim();
-        int id;
-        try {
-            id = Integer.parseInt(idStr);
-        } catch (NumberFormatException ignore) {
-            return false;
-        }
-
-        var file = new File(ServerContext.get(server).storageDir().toFile(), "computer/" + id);
-        if (!file.isDirectory()) return false;
-
-        Util.getPlatform().openFile(file);
-        return true;
-    }
-
     /**
      * Add additional information about the currently targeted block to the debug screen.
      *
@@ -144,7 +108,7 @@ public final class ClientHooks {
      */
     public static void addBlockDebugInfo(Consumer<String> addText) {
         var minecraft = Minecraft.getInstance();
-        if (!minecraft.options.renderDebug || minecraft.level == null) return;
+        if (!minecraft.getDebugOverlay().showDebugScreen() || minecraft.level == null) return;
         if (minecraft.hitResult == null || minecraft.hitResult.getType() != HitResult.Type.BLOCK) return;
 
         var tile = minecraft.level.getBlockEntity(((BlockHitResult) minecraft.hitResult).getBlockPos());
@@ -174,7 +138,7 @@ public final class ClientHooks {
      * @param addText A callback which adds a single line of text.
      */
     public static void addGameDebugInfo(Consumer<String> addText) {
-        if (MonitorBlockEntityRenderer.hasRenderedThisFrame() && Minecraft.getInstance().options.renderDebug) {
+        if (MonitorBlockEntityRenderer.hasRenderedThisFrame() && Minecraft.getInstance().getDebugOverlay().showDebugScreen()) {
             addText.accept("[CC:T] Monitor renderer: " + MonitorBlockEntityRenderer.currentRenderer());
         }
     }

projects/common/src/client/java/dan200/computercraft/client/ClientRegistry.java

@@ -4,8 +4,12 @@
 
 package dan200.computercraft.client;
 
+import com.mojang.brigadier.CommandDispatcher;
+import com.mojang.brigadier.arguments.IntegerArgumentType;
+import com.mojang.brigadier.builder.LiteralArgumentBuilder;
+import com.mojang.brigadier.builder.RequiredArgumentBuilder;
 import dan200.computercraft.api.ComputerCraftAPI;
-import dan200.computercraft.api.client.ComputerCraftAPIClient;
+import dan200.computercraft.api.client.turtle.RegisterTurtleUpgradeModeller;
 import dan200.computercraft.api.client.turtle.TurtleUpgradeModeller;
 import dan200.computercraft.client.gui.*;
 import dan200.computercraft.client.pocket.ClientPocketComputers;
@@ -16,27 +20,38 @@ import dan200.computercraft.client.turtle.TurtleModemModeller;
 import dan200.computercraft.client.turtle.TurtleUpgradeModellers;
 import dan200.computercraft.core.util.Colour;
 import dan200.computercraft.shared.ModRegistry;
+import dan200.computercraft.shared.command.CommandComputerCraft;
 import dan200.computercraft.shared.common.IColouredItem;
+import dan200.computercraft.shared.computer.core.ServerContext;
 import dan200.computercraft.shared.computer.inventory.AbstractComputerMenu;
 import dan200.computercraft.shared.computer.inventory.ViewComputerMenu;
 import dan200.computercraft.shared.media.items.DiskItem;
 import dan200.computercraft.shared.media.items.TreasureDiskItem;
+import net.minecraft.Util;
+import net.minecraft.client.Minecraft;
 import net.minecraft.client.color.item.ItemColor;
 import net.minecraft.client.gui.screens.MenuScreens;
+import net.minecraft.client.gui.screens.Screen;
+import net.minecraft.client.gui.screens.inventory.MenuAccess;
 import net.minecraft.client.multiplayer.ClientLevel;
 import net.minecraft.client.renderer.ShaderInstance;
 import net.minecraft.client.renderer.blockentity.BlockEntityRendererProvider;
 import net.minecraft.client.renderer.blockentity.BlockEntityRenderers;
 import net.minecraft.client.renderer.item.ClampedItemPropertyFunction;
 import net.minecraft.client.renderer.item.ItemProperties;
+import net.minecraft.network.chat.Component;
 import net.minecraft.resources.ResourceLocation;
+import net.minecraft.server.packs.resources.PreparableReloadListener;
 import net.minecraft.server.packs.resources.ResourceProvider;
 import net.minecraft.world.entity.LivingEntity;
+import net.minecraft.world.inventory.AbstractContainerMenu;
+import net.minecraft.world.inventory.MenuType;
 import net.minecraft.world.item.Item;
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.level.ItemLike;
 
 import javax.annotation.Nullable;
+import java.io.File;
 import java.io.IOException;
 import java.util.function.BiConsumer;
 import java.util.function.Consumer;
@@ -58,18 +73,6 @@ public final class ClientRegistry {
      * Register any client-side objects which don't have to be done on the main thread.
      */
     public static void register() {
-        ComputerCraftAPIClient.registerTurtleUpgradeModeller(ModRegistry.TurtleSerialisers.SPEAKER.get(), TurtleUpgradeModeller.sided(
-            new ResourceLocation(ComputerCraftAPI.MOD_ID, "block/turtle_speaker_left"),
-            new ResourceLocation(ComputerCraftAPI.MOD_ID, "block/turtle_speaker_right")
-        ));
-        ComputerCraftAPIClient.registerTurtleUpgradeModeller(ModRegistry.TurtleSerialisers.WORKBENCH.get(), TurtleUpgradeModeller.sided(
-            new ResourceLocation(ComputerCraftAPI.MOD_ID, "block/turtle_crafting_table_left"),
-            new ResourceLocation(ComputerCraftAPI.MOD_ID, "block/turtle_crafting_table_right")
-        ));
-        ComputerCraftAPIClient.registerTurtleUpgradeModeller(ModRegistry.TurtleSerialisers.WIRELESS_MODEM_NORMAL.get(), new TurtleModemModeller(false));
-        ComputerCraftAPIClient.registerTurtleUpgradeModeller(ModRegistry.TurtleSerialisers.WIRELESS_MODEM_ADVANCED.get(), new TurtleModemModeller(true));
-        ComputerCraftAPIClient.registerTurtleUpgradeModeller(ModRegistry.TurtleSerialisers.TOOL.get(), TurtleUpgradeModeller.flatItem());
-
         BlockEntityRenderers.register(ModRegistry.BlockEntities.MONITOR_NORMAL.get(), MonitorBlockEntityRenderer::new);
         BlockEntityRenderers.register(ModRegistry.BlockEntities.MONITOR_ADVANCED.get(), MonitorBlockEntityRenderer::new);
         BlockEntityRenderers.register(ModRegistry.BlockEntities.TURTLE_NORMAL.get(), TurtleBlockEntityRenderer::new);
@@ -80,17 +83,6 @@ public final class ClientRegistry {
      * Register any client-side objects which must be done on the main thread.
      */
     public static void registerMainThread() {
-        MenuScreens.<AbstractComputerMenu, ComputerScreen<AbstractComputerMenu>>register(ModRegistry.Menus.COMPUTER.get(), ComputerScreen::new);
-        MenuScreens.<AbstractComputerMenu, ComputerScreen<AbstractComputerMenu>>register(ModRegistry.Menus.POCKET_COMPUTER.get(), ComputerScreen::new);
-        MenuScreens.<AbstractComputerMenu, NoTermComputerScreen<AbstractComputerMenu>>register(ModRegistry.Menus.POCKET_COMPUTER_NO_TERM.get(), NoTermComputerScreen::new);
-        MenuScreens.register(ModRegistry.Menus.TURTLE.get(), TurtleScreen::new);
-
-        MenuScreens.register(ModRegistry.Menus.PRINTER.get(), PrinterScreen::new);
-        MenuScreens.register(ModRegistry.Menus.DISK_DRIVE.get(), DiskDriveScreen::new);
-        MenuScreens.register(ModRegistry.Menus.PRINTOUT.get(), PrintoutScreen::new);
-
-        MenuScreens.<ViewComputerMenu, ComputerScreen<ViewComputerMenu>>register(ModRegistry.Menus.VIEW_COMPUTER.get(), ComputerScreen::new);
-
         registerItemProperty("state",
             new UnclampedPropertyFunction((stack, world, player, random) -> ClientPocketComputers.get(stack).getState().ordinal()),
             ModRegistry.Items.POCKET_COMPUTER_NORMAL, ModRegistry.Items.POCKET_COMPUTER_ADVANCED
@@ -101,12 +93,47 @@ public final class ClientRegistry {
         );
     }
 
+    public static void registerMenuScreens(RegisterMenuScreen register) {
+        register.<AbstractComputerMenu, ComputerScreen<AbstractComputerMenu>>register(ModRegistry.Menus.COMPUTER.get(), ComputerScreen::new);
+        register.<AbstractComputerMenu, ComputerScreen<AbstractComputerMenu>>register(ModRegistry.Menus.POCKET_COMPUTER.get(), ComputerScreen::new);
+        register.<AbstractComputerMenu, NoTermComputerScreen<AbstractComputerMenu>>register(ModRegistry.Menus.POCKET_COMPUTER_NO_TERM.get(), NoTermComputerScreen::new);
+        register.register(ModRegistry.Menus.TURTLE.get(), TurtleScreen::new);
+
+        register.register(ModRegistry.Menus.PRINTER.get(), PrinterScreen::new);
+        register.register(ModRegistry.Menus.DISK_DRIVE.get(), DiskDriveScreen::new);
+        register.register(ModRegistry.Menus.PRINTOUT.get(), PrintoutScreen::new);
+
+        register.<ViewComputerMenu, ComputerScreen<ViewComputerMenu>>register(ModRegistry.Menus.VIEW_COMPUTER.get(), ComputerScreen::new);
+    }
+
+    public interface RegisterMenuScreen {
+        <M extends AbstractContainerMenu, U extends Screen & MenuAccess<M>> void register(MenuType<? extends M> type, MenuScreens.ScreenConstructor<M, U> factory);
+    }
+
+    public static void registerTurtleModellers(RegisterTurtleUpgradeModeller register) {
+        register.register(ModRegistry.TurtleSerialisers.SPEAKER.get(), TurtleUpgradeModeller.sided(
+            new ResourceLocation(ComputerCraftAPI.MOD_ID, "block/turtle_speaker_left"),
+            new ResourceLocation(ComputerCraftAPI.MOD_ID, "block/turtle_speaker_right")
+        ));
+        register.register(ModRegistry.TurtleSerialisers.WORKBENCH.get(), TurtleUpgradeModeller.sided(
+            new ResourceLocation(ComputerCraftAPI.MOD_ID, "block/turtle_crafting_table_left"),
+            new ResourceLocation(ComputerCraftAPI.MOD_ID, "block/turtle_crafting_table_right")
+        ));
+        register.register(ModRegistry.TurtleSerialisers.WIRELESS_MODEM_NORMAL.get(), new TurtleModemModeller(false));
+        register.register(ModRegistry.TurtleSerialisers.WIRELESS_MODEM_ADVANCED.get(), new TurtleModemModeller(true));
+        register.register(ModRegistry.TurtleSerialisers.TOOL.get(), TurtleUpgradeModeller.flatItem());
+    }
+
     @SafeVarargs
     private static void registerItemProperty(String name, ClampedItemPropertyFunction getter, Supplier<? extends Item>... items) {
         var id = new ResourceLocation(ComputerCraftAPI.MOD_ID, name);
         for (var item : items) ItemProperties.register(item.get(), id, getter);
     }
 
+    public static void registerReloadListeners(Consumer<PreparableReloadListener> register, Minecraft minecraft) {
+        register.accept(GuiSprites.initialise(minecraft.getTextureManager()));
+    }
+
     private static final String[] EXTRA_MODELS = new String[]{
         "block/turtle_colour",
         "block/turtle_elf_overlay",
@@ -173,4 +200,45 @@ public final class ClientRegistry {
             return function.unclampedCall(stack, level, entity, layer);
         }
     }
+
+    /**
+     * Register client-side commands.
+     *
+     * @param dispatcher The dispatcher to register the commands to.
+     * @param sendError  A function to send an error message.
+     * @param <T>        The type of the client-side command context.
+     */
+    public static <T> void registerClientCommands(CommandDispatcher<T> dispatcher, BiConsumer<T, Component> sendError) {
+        dispatcher.register(LiteralArgumentBuilder.<T>literal(CommandComputerCraft.CLIENT_OPEN_FOLDER)
+            .requires(x -> Minecraft.getInstance().getSingleplayerServer() != null)
+            .then(RequiredArgumentBuilder.<T, Integer>argument("computer_id", IntegerArgumentType.integer(0))
+                .executes(c -> handleOpenComputerCommand(c.getSource(), sendError, c.getArgument("computer_id", Integer.class)))
+            ));
+    }
+
+    /**
+     * Handle the {@link CommandComputerCraft#CLIENT_OPEN_FOLDER} command.
+     *
+     * @param context   The command context.
+     * @param sendError A function to send an error message.
+     * @param id        The computer's id.
+     * @param <T>       The type of the client-side command context.
+     * @return {@code 1} if a folder was opened, {@code 0} otherwise.
+     */
+    private static <T> int handleOpenComputerCommand(T context, BiConsumer<T, Component> sendError, int id) {
+        var server = Minecraft.getInstance().getSingleplayerServer();
+        if (server == null) {
+            sendError.accept(context, Component.literal("Not on a single-player server"));
+            return 0;
+        }
+
+        var file = new File(ServerContext.get(server).storageDir().toFile(), "computer/" + id);
+        if (!file.isDirectory()) {
+            sendError.accept(context, Component.literal("Computer's folder does not exist"));
+            return 0;
+        }
+
+        Util.getPlatform().openFile(file);
+        return 1;
+    }
 }

projects/common/src/client/java/dan200/computercraft/client/gui/AbstractComputerScreen.java

@@ -7,7 +7,7 @@ package dan200.computercraft.client.gui;
 import dan200.computercraft.client.gui.widgets.ComputerSidebar;
 import dan200.computercraft.client.gui.widgets.DynamicImageButton;
 import dan200.computercraft.client.gui.widgets.TerminalWidget;
-import dan200.computercraft.client.platform.ClientPlatformHelper;
+import dan200.computercraft.client.network.ClientNetworking;
 import dan200.computercraft.core.terminal.Terminal;
 import dan200.computercraft.shared.computer.core.ComputerFamily;
 import dan200.computercraft.shared.computer.core.InputHandler;
@@ -19,6 +19,7 @@ import dan200.computercraft.shared.network.server.UploadFileMessage;
 import net.minecraft.ChatFormatting;
 import net.minecraft.Util;
 import net.minecraft.client.gui.GuiGraphics;
+import net.minecraft.client.gui.components.events.GuiEventListener;
 import net.minecraft.client.gui.screens.inventory.AbstractContainerScreen;
 import net.minecraft.network.chat.Component;
 import net.minecraft.world.entity.player.Inventory;
@@ -33,7 +34,6 @@ import java.nio.ByteBuffer;
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.util.ArrayList;
-import java.util.Collections;
 import java.util.List;
 import java.util.concurrent.TimeUnit;
 
@@ -125,7 +125,6 @@ public abstract class AbstractComputerScreen<T extends AbstractComputerMenu> ext
 
     @Override
     public void render(GuiGraphics graphics, int mouseX, int mouseY, float partialTicks) {
-        renderBackground(graphics);
         super.render(graphics, mouseX, mouseY, partialTicks);
         renderTooltip(graphics, mouseX, mouseY);
     }
@@ -145,6 +144,11 @@ public abstract class AbstractComputerScreen<T extends AbstractComputerMenu> ext
             || super.mouseDragged(x, y, button, deltaX, deltaY);
     }
 
+    @Override
+    public void setFocused(@Nullable GuiEventListener listener) {
+        // Don't clear and re-focus if we're already focused.
+        if (listener != getFocused()) super.setFocused(listener);
+    }
 
     @Override
     protected void renderLabels(GuiGraphics graphics, int mouseX, int mouseY) {
@@ -202,7 +206,7 @@ public abstract class AbstractComputerScreen<T extends AbstractComputerMenu> ext
             return;
         }
 
-        if (toUpload.size() > 0) UploadFileMessage.send(menu, toUpload, ClientPlatformHelper.get()::sendToServer);
+        if (toUpload.size() > 0) UploadFileMessage.send(menu, toUpload, ClientNetworking::sendToServer);
     }
 
     public void uploadResult(UploadResult result, @Nullable Component message) {
@@ -219,7 +223,7 @@ public abstract class AbstractComputerScreen<T extends AbstractComputerMenu> ext
 
     private void alert(Component title, Component message) {
         OptionScreen.show(minecraft, title, message,
-            Collections.singletonList(OptionScreen.newButton(OK, b -> minecraft.setScreen(this))),
+            List.of(OptionScreen.newButton(OK, b -> minecraft.setScreen(this))),
             () -> minecraft.setScreen(this)
         );
     }

projects/common/src/client/java/dan200/computercraft/client/gui/ClientInputHandler.java

@@ -4,7 +4,7 @@
 
 package dan200.computercraft.client.gui;
 
-import dan200.computercraft.client.platform.ClientPlatformHelper;
+import dan200.computercraft.client.network.ClientNetworking;
 import dan200.computercraft.shared.computer.core.InputHandler;
 import dan200.computercraft.shared.computer.menu.ComputerMenu;
 import dan200.computercraft.shared.network.server.ComputerActionServerMessage;
@@ -29,51 +29,51 @@ public final class ClientInputHandler implements InputHandler {
 
     @Override
     public void turnOn() {
-        ClientPlatformHelper.get().sendToServer(new ComputerActionServerMessage(menu, ComputerActionServerMessage.Action.TURN_ON));
+        ClientNetworking.sendToServer(new ComputerActionServerMessage(menu, ComputerActionServerMessage.Action.TURN_ON));
     }
 
     @Override
     public void shutdown() {
-        ClientPlatformHelper.get().sendToServer(new ComputerActionServerMessage(menu, ComputerActionServerMessage.Action.SHUTDOWN));
+        ClientNetworking.sendToServer(new ComputerActionServerMessage(menu, ComputerActionServerMessage.Action.SHUTDOWN));
     }
 
     @Override
     public void reboot() {
-        ClientPlatformHelper.get().sendToServer(new ComputerActionServerMessage(menu, ComputerActionServerMessage.Action.REBOOT));
+        ClientNetworking.sendToServer(new ComputerActionServerMessage(menu, ComputerActionServerMessage.Action.REBOOT));
     }
 
     @Override
     public void queueEvent(String event, @Nullable Object[] arguments) {
-        ClientPlatformHelper.get().sendToServer(new QueueEventServerMessage(menu, event, arguments));
+        ClientNetworking.sendToServer(new QueueEventServerMessage(menu, event, arguments));
     }
 
     @Override
     public void keyDown(int key, boolean repeat) {
-        ClientPlatformHelper.get().sendToServer(new KeyEventServerMessage(menu, repeat ? KeyEventServerMessage.TYPE_REPEAT : KeyEventServerMessage.TYPE_DOWN, key));
+        ClientNetworking.sendToServer(new KeyEventServerMessage(menu, repeat ? KeyEventServerMessage.TYPE_REPEAT : KeyEventServerMessage.TYPE_DOWN, key));
     }
 
     @Override
     public void keyUp(int key) {
-        ClientPlatformHelper.get().sendToServer(new KeyEventServerMessage(menu, KeyEventServerMessage.TYPE_UP, key));
+        ClientNetworking.sendToServer(new KeyEventServerMessage(menu, KeyEventServerMessage.TYPE_UP, key));
     }
 
     @Override
     public void mouseClick(int button, int x, int y) {
-        ClientPlatformHelper.get().sendToServer(new MouseEventServerMessage(menu, MouseEventServerMessage.TYPE_CLICK, button, x, y));
+        ClientNetworking.sendToServer(new MouseEventServerMessage(menu, MouseEventServerMessage.TYPE_CLICK, button, x, y));
     }
 
     @Override
     public void mouseUp(int button, int x, int y) {
-        ClientPlatformHelper.get().sendToServer(new MouseEventServerMessage(menu, MouseEventServerMessage.TYPE_UP, button, x, y));
+        ClientNetworking.sendToServer(new MouseEventServerMessage(menu, MouseEventServerMessage.TYPE_UP, button, x, y));
     }
 
     @Override
     public void mouseDrag(int button, int x, int y) {
-        ClientPlatformHelper.get().sendToServer(new MouseEventServerMessage(menu, MouseEventServerMessage.TYPE_DRAG, button, x, y));
+        ClientNetworking.sendToServer(new MouseEventServerMessage(menu, MouseEventServerMessage.TYPE_DRAG, button, x, y));
     }
 
     @Override
     public void mouseScroll(int direction, int x, int y) {
-        ClientPlatformHelper.get().sendToServer(new MouseEventServerMessage(menu, MouseEventServerMessage.TYPE_SCROLL, direction, x, y));
+        ClientNetworking.sendToServer(new MouseEventServerMessage(menu, MouseEventServerMessage.TYPE_SCROLL, direction, x, y));
     }
 }

projects/common/src/client/java/dan200/computercraft/client/gui/ComputerScreen.java

@@ -7,13 +7,14 @@ package dan200.computercraft.client.gui;
 import dan200.computercraft.client.gui.widgets.ComputerSidebar;
 import dan200.computercraft.client.gui.widgets.TerminalWidget;
 import dan200.computercraft.client.render.ComputerBorderRenderer;
+import dan200.computercraft.client.render.RenderTypes;
+import dan200.computercraft.client.render.SpriteRenderer;
 import dan200.computercraft.shared.computer.inventory.AbstractComputerMenu;
 import net.minecraft.client.gui.GuiGraphics;
 import net.minecraft.network.chat.Component;
 import net.minecraft.world.entity.player.Inventory;
 
 import static dan200.computercraft.client.render.ComputerBorderRenderer.BORDER;
-import static dan200.computercraft.client.render.RenderTypes.FULL_BRIGHT_LIGHTMAP;
 
 /**
  * A GUI for computers which renders the terminal (and border), but with no UI elements.
@@ -39,11 +40,14 @@ public final class ComputerScreen<T extends AbstractComputerMenu> extends Abstra
     public void renderBg(GuiGraphics graphics, float partialTicks, int mouseX, int mouseY) {
         // Draw a border around the terminal
         var terminal = getTerminal();
-        var texture = ComputerBorderRenderer.getTexture(family);
+        var spriteRenderer = SpriteRenderer.createForGui(graphics, RenderTypes.GUI_SPRITES);
+        var computerTextures = GuiSprites.getComputerTextures(family);
+
         ComputerBorderRenderer.render(
-            graphics.pose().last().pose(), texture, terminal.getX(), terminal.getY(),
-            FULL_BRIGHT_LIGHTMAP, terminal.getWidth(), terminal.getHeight()
+            spriteRenderer, computerTextures,
+            terminal.getX(), terminal.getY(), terminal.getWidth(), terminal.getHeight(), false
         );
-        ComputerSidebar.renderBackground(graphics, texture, leftPos, topPos + sidebarYOffset);
+        ComputerSidebar.renderBackground(spriteRenderer, computerTextures, leftPos, topPos + sidebarYOffset);
+        graphics.flush(); // Flush to ensure background textures are drawn before foreground.
     }
 }

projects/common/src/client/java/dan200/computercraft/client/gui/DiskDriveScreen.java

@@ -28,7 +28,6 @@ public class DiskDriveScreen extends AbstractContainerScreen<DiskDriveMenu> {
 
     @Override
     public void render(GuiGraphics graphics, int mouseX, int mouseY, float partialTicks) {
-        renderBackground(graphics);
         super.render(graphics, mouseX, mouseY, partialTicks);
         renderTooltip(graphics, mouseX, mouseY);
     }