Update build.gradle to more closely match CC:T's

- Adds cct-javadoc fun and renables checkstyle (yay?) - Fixes a few javadoc and formatting issues - Cherry pick the docs so illuaminate doesn't complain
2025-08-27 16:02:17 +00:00 · 2021-11-27 09:32:25 +00:00 · 2021-11-27 09:32:25 +00:00 · 70a24d371d
commit 70a24d371d
parent 73e3e237ad
55 changed files with 1530 additions and 71 deletions
--- a/.github/workflows/main-ci.yml
+++ b/.github/workflows/main-ci.yml
@ -9,8 +9,8 @@ jobs:

    steps:
    - uses: actions/checkout@v2
-    - name: Checkout submodules
-      run: git submodule update --init --recursive
+      with:
+        submodules: true

    - name: Set up Java 16
      uses: actions/setup-java@v1
--- a/build.gradle
+++ b/build.gradle
@ -1,47 +1,68 @@
 plugins {
-    id 'fabric-loom' version '0.9-SNAPSHOT'
-    id 'maven-publish'
-    //id "checkstyle"
+    id "checkstyle"
+    id "jacoco"
+    id "maven-publish"
    id "com.github.hierynomus.license" version "0.16.1"
+    id "org.jetbrains.kotlin.jvm" version "1.5.21"
+    id 'fabric-loom' version '0.10-SNAPSHOT'
 }

+def javaVersion = JavaLanguageVersion.of(16)
 java {
    toolchain {
-        languageVersion = JavaLanguageVersion.of(16)
+        languageVersion = javaVersion
+    }
+
+    withSourcesJar()
+    withJavadocJar()
+}
+
+tasks.withType(JavaExec).configureEach {
+    javaLauncher = javaToolchains.launcherFor {
+        languageVersion = javaVersion
    }
 }

 version = mod_version

 group = "dan200.computercraft"
-archivesBaseName = "cc-restiched"
+archivesBaseName = "cc-restitched"

-repositories {
-    mavenCentral()
-    maven { url 'https://jitpack.io' }
-    maven { url 'https://api.modrinth.com/maven'}
-    maven { url "https://maven.shedaniel.me/" }
-    maven { url "https://maven.terraformersmc.com/" }
-    maven {
-        name "SquidDev"
-        url "https://squiddev.cc/maven"
+sourceSets {
+    main.resources {
+        srcDir 'src/generated/resources'
    }
+
+    testMod {}
 }

 loom {
    accessWidenerPath = file("src/main/resources/cc.accesswidener")
 }

+repositories {
+    mavenCentral()
+    maven {
+        name "SquidDev"
+        url "https://squiddev.cc/maven"
+    }
+
+    // TODO: Limit these to a set of groups.
+    maven { url "https://maven.shedaniel.me/" }
+    maven { url "https://maven.terraformersmc.com/" }
+}
+
 configurations {
+    shade
    implementation.extendsFrom shade
+    cctJavadoc
 }

 dependencies {
-    //checkstyle 'com.puppycrawl.tools:checkstyle:8.45.1'
+    checkstyle "com.puppycrawl.tools:checkstyle:8.45"

    minecraft "com.mojang:minecraft:${mc_version}"
-    //mappings "net.fabricmc:yarn:${mc_version}+build.${mappings_version}:v2"
-    mappings(minecraft.officialMojangMappings())
+    mappings loom.officialMojangMappings()
    modImplementation "net.fabricmc:fabric-loader:${fabric_loader_version}"
    modImplementation "net.fabricmc.fabric-api:fabric-api:${fabric_api_version}"

@ -52,7 +73,8 @@ dependencies {
    modImplementation "me.shedaniel.cloth.api:cloth-utils-v1:${cloth_api_version}"

    implementation 'com.electronwill.night-config:toml:3.6.3'
-    implementation 'com.google.code.findbugs:jsr305:3.0.2'
+
+    compileOnly 'com.google.code.findbugs:jsr305:3.0.2'

    shade 'org.squiddev:Cobalt:0.5.2-SNAPSHOT'

@ -61,39 +83,114 @@ dependencies {
    include 'com.electronwill.night-config:toml:3.6.3'
    include "me.shedaniel.cloth:cloth-config-fabric:${cloth_config_version}"

-    modRuntime "me.shedaniel:RoughlyEnoughItems-api-fabric:6.0.254-alpha"
-    modRuntime "me.shedaniel:RoughlyEnoughItems-fabric:6.0.254-alpha"
+    modRuntimeOnly "me.shedaniel:RoughlyEnoughItems-api-fabric:6.0.254-alpha"
+    modRuntimeOnly "me.shedaniel:RoughlyEnoughItems-fabric:6.0.254-alpha"
+
+    testImplementation 'org.junit.jupiter:junit-jupiter-api:5.7.0'
+    testImplementation 'org.junit.jupiter:junit-jupiter-params:5.7.0'
+    testRuntimeOnly 'org.junit.jupiter:junit-jupiter-engine:5.7.0'
+    testImplementation 'org.hamcrest:hamcrest:2.2'
+    testImplementation 'org.jetbrains.kotlin:kotlin-stdlib-jdk8:1.5.21'
+    testImplementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.1'
+
+    cctJavadoc 'cc.tweaked:cct-javadoc:1.4.1'
 }

 processResources {
    inputs.property "version", project.version

-	filesMatching("fabric.mod.json") {
-		expand "version": project.version
-	}
+    def hash = 'none'
+    Set<String> contributors = []
+    try {
+        hash = ["git", "-C", projectDir, "rev-parse", "HEAD"].execute().text.trim()
+
+        def blacklist = ['GitHub', 'dan200', 'Daniel Ratcliffe']
+        ["git", "-C", projectDir, "log", "--format=tformat:%an%n%cn"].execute().text.split('\n').each {
+            if (!blacklist.contains(it)) contributors.add(it)
+        }
+    } catch (Exception e) {
+        e.printStackTrace()
+    }
+    inputs.property "commithash", hash
+    duplicatesStrategy = DuplicatesStrategy.INCLUDE
+
+    filesMatching(["fabric.mod.json", "data/computercraft/lua/rom/help/credits.txt"]) {
+        expand(
+            'version': mod_version,
+            'mcversion': mc_version,
+            'gitcontributors': contributors.sort(false, String.CASE_INSENSITIVE_ORDER).join('\n')
+        )
+    }
 }

-// ensure that the encoding is set to UTF-8, no matter what the system default is
-// this fixes some edge cases with special characters not displaying correctly
-// see http://yodaconditions.net/blog/fix-for-java-file-encoding-problems-with-gradle.html
 tasks.withType(JavaCompile) {
    options.encoding = "UTF-8"
 }

-// Loom will automatically attach sourcesJar to a RemapSourcesJar task and to the "build" task
-// if it is present.
-// If you remove this task, sources will not be generated.
-task sourcesJar(type: Jar, dependsOn: classes) {
-    classifier = "sources"
-    from sourceSets.main.allSource
+javadoc {
+    include "dan200/computercraft/api/**/*.java"
+}
+
+task luaJavadoc(type: Javadoc) {
+    description "Generates documentation for Java-side Lua functions."
+    group "documentation"
+
+    source = sourceSets.main.allJava
+    destinationDir = file("${project.docsDir}/luaJavadoc")
+    classpath = sourceSets.main.compileClasspath
+
+    options.docletpath = configurations.cctJavadoc.files as List
+    options.doclet = "cc.tweaked.javadoc.LuaDoclet"
+    options.noTimestamp = false
+
+    javadocTool = javaToolchains.javadocToolFor {
+        languageVersion = javaVersion
+    }
 }

 jar {
    from "LICENSE"
+    manifest {
+        attributes([
+            "Specification-Title"     : "computercraft",
+            "Specification-Version"   : "1",
+            "Implementation-Title"    : "CC: Restitched",
+            "Implementation-Version"  : "${mod_version}",
+            "Implementation-Timestamp": new Date().format("yyyy-MM-dd'T'HH:mm:ssZ")
+        ])
+    }

    from configurations.shade.collect { it.isDirectory() ? it : zipTree(it) }
 }

+[compileJava, compileTestJava].forEach {
+    it.configure {
+        options.compilerArgs << "-Xlint" << "-Xlint:-processing"
+    }
+}
+
+sourcesJar {
+    duplicatesStrategy = DuplicatesStrategy.INCLUDE
+}
+
+// Check tasks
+
+test {
+    useJUnitPlatform()
+    testLogging {
+        events "skipped", "failed"
+    }
+}
+
+jacocoTestReport {
+    dependsOn('test')
+    reports {
+        xml.required = true
+        html.required = true
+    }
+}
+
+check.dependsOn jacocoTestReport

 import com.hierynomus.gradle.license.tasks.LicenseCheck
 import com.hierynomus.gradle.license.tasks.LicenseFormat
@ -113,7 +210,7 @@ license {
    }
 }

-[licenseTest, licenseFormatTest].forEach {
+[licenseTest, licenseFormatTest, licenseTestMod, licenseFormatTestMod].forEach {
    it.configure {
        include("**/*.java")
        header file('config/license/main.txt')
@ -126,9 +223,8 @@ gradle.projectsEvaluated {
    }
 }

-
-task licenseAPI(type: LicenseCheck);
-task licenseFormatAPI(type: LicenseFormat);
+task licenseAPI(type: LicenseCheck)
+task licenseFormatAPI(type: LicenseFormat)
 [licenseAPI, licenseFormatAPI].forEach {
    it.configure {
        source = sourceSets.main.java
--- a/config/checkstyle/checkstyle.xml
+++ b/config/checkstyle/checkstyle.xml
@ -58,13 +58,20 @@
        <module name="SimplifyBooleanExpression" />
        <module name="SimplifyBooleanReturn" />
        <module name="StringLiteralEquality" />
-        <!-- <module name="UnnecessaryParentheses" /> -->
+        <module name="UnnecessaryParentheses">
+            <!-- Default minus LAND. -->
+            <property name="tokens" value="EXPR,IDENT,NUM_DOUBLE,NUM_FLOAT,NUM_INT,NUM_LONG,STRING_LITERAL,LITERAL_NULL,LITERAL_FALSE,LITERAL_TRUE,ASSIGN,BAND_ASSIGN,BOR_ASSIGN,BSR_ASSIGN,BXOR_ASSIGN,DIV_ASSIGN,MINUS_ASSIGN,MOD_ASSIGN,PLUS_ASSIGN,SL_ASSIGN,SR_ASSIGN,STAR_ASSIGN,LAMBDA,TEXT_BLOCK_LITERAL_BEGIN,LITERAL_INSTANCEOF,GT,LT,GE,LE,EQUAL,NOT_EQUAL,UNARY_MINUS,UNARY_PLUS,INC,DEC,LNOT,BNOT,POST_INC,POST_DEC" />
+        </module>
        <module name="UnnecessarySemicolonAfterTypeMemberDeclaration" />
        <module name="UnnecessarySemicolonInTryWithResources" />
        <module name="UnnecessarySemicolonInEnumeration" />

        <!-- Imports -->
-        <!--<module name="CustomImportOrder" />-->
+        <module name="CustomImportOrder">
+            <property name="customImportOrderRules"
+                value="THIRD_PARTY_PACKAGE###STANDARD_JAVA_PACKAGE###STATIC"
+            />
+        </module>
        <module name="IllegalImport" />
        <module name="RedundantImport" />
        <module name="UnusedImports" />
@ -149,8 +156,13 @@
            <property name="tokens" value="COMMA" />
        </module>
        <module name="WhitespaceAround">
-            <property name="allowEmptyConstructors" value="true" />
            <property name="ignoreEnhancedForColon" value="false" />
+            <!-- Allow empty functions -->
+            <property name="allowEmptyLambdas" value="true" />
+            <property name="allowEmptyMethods" value="true" />
+            <property name="allowEmptyConstructors" value="true" />
+            <property name="allowEmptyTypes" value="true" />
+
            <property name="tokens" value="ASSIGN,BAND,BAND_ASSIGN,BOR,BOR_ASSIGN,BSR,BSR_ASSIGN,BXOR,BXOR_ASSIGN,COLON,DIV,DIV_ASSIGN,EQUAL,GE,GT,LAMBDA,LAND,LCURLY,LE,LITERAL_RETURN,LOR,LT,MINUS,MINUS_ASSIGN,MOD,MOD_ASSIGN,NOT_EQUAL,PLUS,PLUS_ASSIGN,QUESTION,RCURLY,SL,SLIST,SL_ASSIGN,SR,SR_ASSIGN,STAR,STAR_ASSIGN,LITERAL_ASSERT,TYPE_EXTENSION_AND" />
        </module>
    </module>
--- a/config/pre-commit/config.yml
+++ b/config/pre-commit/config.yml
@ -2,7 +2,7 @@
 # See https://pre-commit.com/hooks.html for more hooks
 repos:
 - repo: https://github.com/pre-commit/pre-commit-hooks
-  rev: v3.2.0
+  rev: v4.0.1
  hooks:
  - id: trailing-whitespace
  - id: end-of-file-fixer
@ -16,7 +16,7 @@ repos:
    exclude: "tsconfig\\.json$"

 - repo: https://github.com/editorconfig-checker/editorconfig-checker.python
-  rev: 2.3.5
+  rev: 2.3.54
  hooks:
  - id: editorconfig-checker
    args: ['-disable-indentation']
@ -38,6 +38,13 @@ repos:
    entry: ./gradlew licenseFormat
    pass_filenames: false
    require_serial: true
+  - id: illuaminate
+    name: Check Lua code
+    files: ".*\\.(lua|java|md)"
+    language: script
+    entry: config/pre-commit/illuaminate-lint.sh
+    pass_filenames: false
+    require_serial: true

 exclude: |
  (?x)^(
--- a/doc/events/alarm.md
+++ b/doc/events/alarm.md
@ -0,0 +1,21 @@
+---
+module: [kind=event] alarm
+see: os.setAlarm To start an alarm.
+---
+
+The @{timer} 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.
+
+## Example
+Starts a timer and then prints its ID:
+```lua
+local alarmID = os.setAlarm(os.time() + 0.05)
+local event, id
+repeat
+    event, id = os.pullEvent("alarm")
+until id == alarmID
+print("Alarm with ID " .. id .. " was fired")
+```
--- a/doc/events/char.md
+++ b/doc/events/char.md
@ -0,0 +1,24 @@
+---
+module: [kind=event] char
+see: key To listen to any key press.
+---
+
+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
+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.
+
+## Return values
+1. @{string}: The event name.
+2. @{string}: The string representing the character that was pressed.
+
+
+## Example
+Prints each character the user presses:
+```lua
+while true do
+  local event, character = os.pullEvent("char")
+  print(character .. " was pressed.")
+end
+```
--- a/doc/events/computer_command.md
+++ b/doc/events/computer_command.md
@ -0,0 +1,18 @@
+---
+module: [kind=event] computer_command
+---
+
+The @{computer_command} event is fired when the `/computercraft queue` command is run for the current computer.
+
+## Return Values
+1. @{string}: The event name.
+... @{string}: The arguments passed to the command.
+
+## Example
+Prints the contents of messages sent:
+```lua
+while true do
+  local event = {os.pullEvent("computer_command")}
+  print("Received message:", table.unpack(event, 2))
+end
+```
--- a/doc/events/disk.md
+++ b/doc/events/disk.md
@ -0,0 +1,19 @@
+---
+module: [kind=event] disk
+see: disk_eject For the event sent when a disk is removed.
+---
+
+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.
+
+## Example
+Prints a message when a disk is inserted:
+```lua
+while true do
+  local event, side = os.pullEvent("disk")
+  print("Inserted a disk on side " .. side)
+end
+```
--- a/doc/events/disk_eject.md
+++ b/doc/events/disk_eject.md
@ -0,0 +1,19 @@
+---
+module: [kind=event] disk_eject
+see: disk For the event sent when a disk is inserted.
+---
+
+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.
+
+## Example
+Prints a message when a disk is removed:
+```lua
+while true do
+  local event, side = os.pullEvent("disk_eject")
+  print("Removed a disk on side " .. side)
+end
+```
--- a/doc/events/http_check.md
+++ b/doc/events/http_check.md
@ -0,0 +1,14 @@
+---
+module: [kind=event] http_check
+see: http.checkURLAsync To check a URL asynchronously.
+---
+
+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}.
+
+## Return Values
+1. @{string}: The event name.
+2. @{string}: The URL requested to be checked.
+3. @{boolean}: Whether the check succeeded.
+4. @{string|nil}: If the check failed, a reason explaining why the check failed.
--- a/doc/events/http_failure.md
+++ b/doc/events/http_failure.md
@ -0,0 +1,39 @@
+---
+module: [kind=event] http_failure
+see: http.request To send an HTTP request.
+---
+
+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}.
+
+## Return Values
+1. @{string}: The event name.
+2. @{string}: The URL of the site requested.
+3. @{string}: An error describing the failure.
+4. @{http.Response|nil}: A response handle if the connection succeeded, but the server's response indicated failure.
+
+## Example
+Prints an error why the website cannot be contacted:
+```lua
+local myURL = "https://does.not.exist.tweaked.cc"
+http.request(myURL)
+local event, url, err
+repeat
+    event, url, err = os.pullEvent("http_failure")
+until url == myURL
+print("The URL " .. url .. " could not be reached: " .. err)
+```
+
+Prints the contents of a webpage that does not exist:
+```lua
+local myURL = "https://tweaked.cc/this/does/not/exist"
+http.request(myURL)
+local event, url, err, handle
+repeat
+    event, url, err, handle = os.pullEvent("http_failure")
+until url == myURL
+print("The URL " .. url .. " could not be reached: " .. err)
+print(handle.getResponseCode())
+handle.close()
+```
--- a/doc/events/http_success.md
+++ b/doc/events/http_success.md
@ -0,0 +1,27 @@
+---
+module: [kind=event] http_success
+see: http.request To make an HTTP request.
+---
+
+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}.
+
+## Return Values
+1. @{string}: The event name.
+2. @{string}: The URL of the site requested.
+3. @{http.Response}: The handle for the response text.
+
+## Example
+Prints the content of a website (this may fail if the request fails):
+```lua
+local myURL = "https://tweaked.cc/"
+http.request(myURL)
+local event, url, handle
+repeat
+    event, url, handle = os.pullEvent("http_success")
+until url == myURL
+print("Contents of " .. url .. ":")
+print(handle.readAll())
+handle.close()
+```
--- a/doc/events/key.md
+++ b/doc/events/key.md
@ -0,0 +1,26 @@
+---
+module: [kind=event] key
+---
+
+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.
+
+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}).
+
+## Example
+Prints each key when the user presses it, and if the key is being held.
+
+```lua
+while true do
+  local event, key, is_held = os.pullEvent("key")
+  print(("%s held=%s"):format(keys.getName(key), is_held))
+end
+```
--- a/doc/events/key_up.md
+++ b/doc/events/key_up.md
@ -0,0 +1,24 @@
+---
+module: [kind=event] key_up
+see: keys For a lookup table of the given keys.
+---
+
+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.
+
+## Return values
+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.
+
+```lua
+while true do
+  local event, key = os.pullEvent("key_up")
+  local name = keys.getName(key) or "unknown key"
+  print(name .. " was released.")
+end
+```
--- a/doc/events/modem_message.md
+++ b/doc/events/modem_message.md
@ -0,0 +1,22 @@
+---
+module: [kind=event] modem_message
+---
+
+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. @{number}: The distance between the sender and the receiver, in blocks (decimal).
+
+## Example
+Prints a message when one is sent:
+```lua
+while true do
+  local event, side, channel, replyChannel, message, distance = os.pullEvent("modem_message")
+  print(("Message received on side %s on channel %d (reply to %d) from %f blocks away with message %s"):format(side, channel, replyChannel, distance, tostring(message)))
+end
+```
--- a/doc/events/monitor_resize.md
+++ b/doc/events/monitor_resize.md
@ -0,0 +1,18 @@
+---
+module: [kind=event] monitor_resize
+---
+
+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 resized.
+
+## Example
+Prints a message when a monitor is resized:
+```lua
+while true do
+  local event, side = os.pullEvent("monitor_resize")
+  print("The monitor on side " .. side .. " was resized.")
+end
+```
--- a/doc/events/monitor_touch.md
+++ b/doc/events/monitor_touch.md
@ -0,0 +1,20 @@
+---
+module: [kind=event] monitor_touch
+---
+
+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.
+
+## Example
+Prints a message when a monitor is touched:
+```lua
+while true do
+  local event, side, x, y = os.pullEvent("monitor_touch")
+  print("The monitor on side " .. side .. " was touched at (" .. x .. ", " .. y .. ")")
+end
+```
--- a/doc/events/mouse_click.md
+++ b/doc/events/mouse_click.md
@ -0,0 +1,34 @@
+---
+module: [kind=event] mouse_click
+---
+
+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.
+
+## Mouse buttons
+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.
+
+<table class="pretty-table">
+    <!-- Our markdown parser doesn't work on tables!? Guess I'll have to roll my own soonish :/. -->
+    <tr><th>Button code</th><th>Mouse button</th></tr>
+    <tr><td align="right">1</td><td>Left button</td></tr>
+    <tr><td align="right">2</td><td>Middle button</td></tr>
+    <tr><td align="right">3</td><td>Right button</td></tr>
+</table>
+
+## Example
+Print the button and the coordinates whenever the mouse is clicked.
+
+```lua
+while true do
+  local event, button, x, y = os.pullEvent("mouse_click")
+  print(("The mouse button %s was pressed at %d, %d"):format(button, x, y))
+end
+```
--- a/doc/events/mouse_drag.md
+++ b/doc/events/mouse_drag.md
@ -0,0 +1,22 @@
+---
+module: [kind=event] mouse_drag
+see: mouse_click For when a mouse button is initially pressed.
+---
+
+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.
+
+## Example
+Print the button and the coordinates whenever the mouse is dragged.
+
+```lua
+while true do
+  local event, button, x, y = os.pullEvent("mouse_drag")
+  print(("The mouse button %s was dragged at %d, %d"):format(button, x, y))
+end
+```
--- a/doc/events/mouse_scroll.md
+++ b/doc/events/mouse_scroll.md
@ -0,0 +1,21 @@
+---
+module: [kind=event] mouse_scroll
+---
+
+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.
+
+## Example
+Prints the direction of each scroll, and the position of the mouse at the time.
+
+```lua
+while true do
+  local event, dir, x, y = os.pullEvent("mouse_scroll")
+  print(("The mouse was scrolled in direction %s at %d, %d"):format(dir, x, y))
+end
+```
--- a/doc/events/mouse_up.md
+++ b/doc/events/mouse_up.md
@ -0,0 +1,21 @@
+---
+module: [kind=event] mouse_up
+---
+
+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.
+
+## Example
+Prints the coordinates and button number whenever the mouse is released.
+
+```lua
+while true do
+  local event, button, x, y = os.pullEvent("mouse_up")
+  print(("The mouse button %s was released at %d, %d"):format(button, x, y))
+end
+```
--- a/doc/events/paste.md
+++ b/doc/events/paste.md
@ -0,0 +1,18 @@
+---
+module: [kind=event] paste
+---
+
+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.
+
+## Example
+Prints pasted text:
+```lua
+while true do
+  local event, text = os.pullEvent("paste")
+  print('"' .. text .. '" was pasted')
+end
+```
--- a/doc/events/peripheral.md
+++ b/doc/events/peripheral.md
@ -0,0 +1,19 @@
+---
+module: [kind=event] peripheral
+see: peripheral_detach For the event fired when a peripheral is detached.
+---
+
+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.
+
+## Example
+Prints a message when a peripheral is attached:
+```lua
+while true do
+  local event, side = os.pullEvent("peripheral")
+  print("A peripheral was attached on side " .. side)
+end
+```
--- a/doc/events/peripheral_detach.md
+++ b/doc/events/peripheral_detach.md
@ -0,0 +1,19 @@
+---
+module: [kind=event] peripheral_detach
+see: peripheral For the event fired when a peripheral is attached.
+---
+
+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.
+
+## Example
+Prints a message when a peripheral is detached:
+```lua
+while true do
+  local event, side = os.pullEvent("peripheral_detach")
+  print("A peripheral was detached on side " .. side)
+end
+```
--- a/doc/events/rednet_message.md
+++ b/doc/events/rednet_message.md
@ -0,0 +1,30 @@
+---
+module: [kind=event] rednet_message
+see: modem_message For raw modem messages sent outside of Rednet.
+see: rednet.receive To wait for a Rednet message with an optional timeout and protocol filter.
+---
+
+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.
+
+@{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. @{string|nil}: The protocol of the message, if provided.
+
+## Example
+Prints a message when one is sent:
+```lua
+while true do
+  local event, sender, message, protocol = os.pullEvent("rednet_message")
+  if protocol ~= nil then
+    print("Received message from " .. sender .. " with protocol " .. protocol .. " and message " .. tostring(message))
+  else
+    print("Received message from " .. sender .. " with message " .. tostring(message))
+  end
+end
+```
--- a/doc/events/redstone.md
+++ b/doc/events/redstone.md
@ -0,0 +1,14 @@
+---
+module: [kind=event] redstone
+---
+
+The @{redstone} event is fired whenever any redstone inputs on the computer change.
+
+## Example
+Prints a message when a redstone input changes:
+```lua
+while true do
+  os.pullEvent("redstone")
+  print("A redstone input has changed!")
+end
+```
--- a/doc/events/task_complete.md
+++ b/doc/events/task_complete.md
@ -0,0 +1,28 @@
+---
+module: [kind=event] task_complete
+see: commands.execAsync To run a command which fires a task_complete event.
+---
+
+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.)
+...: Any parameters returned from the command.
+
+## Example
+Prints the results of an asynchronous command:
+```lua
+local taskID = commands.execAsync("say Hello")
+local event
+repeat
+    event = {os.pullEvent("task_complete")}
+until event[2] == taskID
+if event[3] == true then
+  print("Task " .. event[2] .. " succeeded:", table.unpack(event, 4))
+else
+  print("Task " .. event[2] .. " failed: " .. event[4])
+end
+```
--- a/doc/events/term_resize.md
+++ b/doc/events/term_resize.md
@ -0,0 +1,15 @@
+---
+module: [kind=event] term_resize
+---
+
+The @{term_resize} event is fired when the main terminal is resized, mainly when a new tab is opened or closed in @{multishell}.
+
+## Example
+Prints :
+```lua
+while true do
+  os.pullEvent("term_resize")
+  local w, h = term.getSize()
+  print("The term was resized to (" .. w .. ", " .. h .. ")")
+end
+```
--- a/doc/events/terminate.md
+++ b/doc/events/terminate.md
@ -0,0 +1,25 @@
+---
+module: [kind=event] terminate
+---
+
+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.
+
+@{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}.
+
+## Example
+Prints a message when Ctrl-T is held:
+```lua
+while true do
+  local event = os.pullEventRaw("terminate")
+  if event == "terminate" then print("Terminate requested!") end
+end
+```
+
+Exits when Ctrl-T is held:
+```lua
+while true do
+  os.pullEvent()
+end
+```
--- a/doc/events/timer.md
+++ b/doc/events/timer.md
@ -0,0 +1,21 @@
+---
+module: [kind=event] timer
+see: os.startTimer To start a timer.
+---
+
+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.
+
+## Example
+Starts a timer and then prints its ID:
+```lua
+local timerID = os.startTimer(2)
+local event, id
+repeat
+    event, id = os.pullEvent("timer")
+until id == timerID
+print("Timer with ID " .. id .. " was fired")
+```
--- a/doc/events/turtle_inventory.md
+++ b/doc/events/turtle_inventory.md
@ -0,0 +1,14 @@
+---
+module: [kind=event] turtle_inventory
+---
+
+The @{turtle_inventory} event is fired when a turtle's inventory is changed.
+
+## Example
+Prints a message when the inventory is changed:
+```lua
+while true do
+  os.pullEvent("turtle_inventory")
+  print("The inventory was changed.")
+end
+```
--- a/doc/events/websocket_closed.md
+++ b/doc/events/websocket_closed.md
@ -0,0 +1,21 @@
+---
+module: [kind=event] websocket_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.
+
+## Example
+Prints a message when a WebSocket is closed (this may take a minute):
+```lua
+local myURL = "wss://example.tweaked.cc/echo"
+local ws = http.websocket(myURL)
+local event, url
+repeat
+    event, url = os.pullEvent("websocket_closed")
+until url == myURL
+print("The WebSocket at " .. url .. " was closed.")
+```
--- a/doc/events/websocket_failure.md
+++ b/doc/events/websocket_failure.md
@ -0,0 +1,25 @@
+---
+module: [kind=event] websocket_failure
+see: http.websocketAsync To send an HTTP request.
+---
+
+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}.
+
+## Return Values
+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:
+```lua
+local myURL = "wss://example.tweaked.cc/not-a-websocket"
+http.websocketAsync(myURL)
+local event, url, err
+repeat
+    event, url, err = os.pullEvent("websocket_failure")
+until url == myURL
+print("The URL " .. url .. " could not be reached: " .. err)
+```
--- a/doc/events/websocket_message.md
+++ b/doc/events/websocket_message.md
@ -0,0 +1,27 @@
+---
+module: [kind=event] websocket_message
+---
+
+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.
+
+## 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.
+
+## Example
+Prints a message sent by a WebSocket:
+```lua
+local myURL = "wss://example.tweaked.cc/echo"
+local ws = http.websocket(myURL)
+ws.send("Hello!")
+local event, url, message
+repeat
+    event, url, message = os.pullEvent("websocket_message")
+until url == myURL
+print("Received message from " .. url .. " with contents " .. message)
+ws.close()
+```
--- a/doc/events/websocket_success.md
+++ b/doc/events/websocket_success.md
@ -0,0 +1,28 @@
+---
+module: [kind=event] websocket_success
+see: http.websocketAsync To open a WebSocket asynchronously.
+---
+
+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}.
+
+## Return Values
+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):
+```lua
+local myURL = "wss://example.tweaked.cc/echo"
+http.websocketAsync(myURL)
+local event, url, handle
+repeat
+    event, url, handle = os.pullEvent("websocket_success")
+until url == myURL
+print("Connected to " .. url)
+handle.send("Hello!")
+print(handle.receive())
+handle.close()
+```
--- a/doc/head.html
+++ b/doc/head.html
@ -0,0 +1 @@
+<meta name="theme-color" content="#c8d87c">
--- a/doc/images/basic-terminal.png
+++ b/doc/images/basic-terminal.png
--- a/doc/images/peripherals.png
+++ b/doc/images/peripherals.png
--- a/doc/images/turtle.png
+++ b/doc/images/turtle.png
--- a/doc/index.md
+++ b/doc/index.md
@ -0,0 +1,55 @@
+# ![CC: Tweaked](logo.png)
+CC: Tweaked is a mod for Minecraft which adds programmable computers, turtles and more to the game. A fork of the
+much-beloved [ComputerCraft], it continues its legacy with better performance, stability, and a wealth of new features.
+
+CC: Tweaked can be installed from [CurseForge] or [Modrinth]. It requires the [Minecraft Forge][forge] mod loader, but
+[versions are available for Fabric][ccrestitched].
+
+## Features
+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}
+
+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}
+
+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
+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}
+
+## Getting Started
+While ComputerCraft is lovely for both experienced programmers and for people who have never coded before, it can be a
+little daunting getting started. Thankfully, there's several fantastic tutorials out there:
+
+ - [Direwolf20's ComputerCraft tutorials](https://www.youtube.com/watch?v=wrUHUhfCY5A "ComputerCraft Tutorial Episode 1 - HELP! and Hello World")
+ - [Sethbling's ComputerCraft series](https://www.youtube.com/watch?v=DSsx4VSe-Uk "Programming Tutorial with Minecraft Turtles -- Ep. 1: Intro to Turtles and If-Then-Else_End")
+ - [Lyqyd's Computer Basics 1](http://www.computercraft.info/forums2/index.php?/topic/15033-computer-basics-i/ "Computer Basics I")
+
+Once you're a little more familiar with the mod, the sidebar and links below provide more detailed documentation on the
+various APIs and peripherals provided by the mod.
+
+If you get stuck, do pop in to the [Minecraft Computer Mod Discord guild][discord] or ComputerCraft's
+[IRC channel][irc].
+
+## Get Involved
+CC: Tweaked lives on [GitHub]. If you've got any ideas, feedback or bugs please do [create an issue][bug].
+
+[github]: https://github.com/cc-tweaked/CC-Tweaked/ "CC: Tweaked on GitHub"
+[bug]: https://github.com/cc-tweaked/CC-Tweaked/issues/new/choose
+[computercraft]: https://github.com/dan200/ComputerCraft "ComputerCraft on GitHub"
+[curseforge]: https://minecraft.curseforge.com/projects/cc-tweaked "Download CC: Tweaked from CurseForge"
+[modrinth]: https://modrinth.com/mod/gu7yAYhd "Download CC: Tweaked from Modrinth"
+[forge]: https://files.minecraftforge.net/ "Download Minecraft Forge."
+[ccrestitched]: https://www.curseforge.com/minecraft/mc-mods/cc-restitched "Download CC: Restitched from CurseForge"
+[lua]: https://www.lua.org/ "Lua's main website"
+[discord]: https://discord.computercraft.cc "The Minecraft Computer Mods Discord"
+[irc]: http://webchat.esper.net/?channels=computercraft "IRC webchat on EsperNet"
--- a/doc/logo.png
+++ b/doc/logo.png
--- a/doc/stub/fs.lua
+++ b/doc/stub/fs.lua
@ -0,0 +1,36 @@
+---  The FS API allows you to manipulate files and the filesystem.
+--
+-- @module fs
+
+--- Returns true if a path is mounted to the parent filesystem.
+--
+-- The root filesystem "/" is considered a mount, along with disk folders and
+-- the rom folder. Other programs (such as network shares) can exstend this to
+-- make other mount types by correctly assigning their return value for getDrive.
+--
+-- @tparam string path The path to check.
+-- @treturn boolean If the path is mounted, rather than a normal file/folder.
+-- @throws If the path does not exist.
+-- @see getDrive
+-- @since 1.87.0
+function isDriveRoot(path) end
+
+--[[- Provides completion for a file or directory name, suitable for use with
+@{_G.read}.
+
+When a directory is a possible candidate for completion, two entries are
+included - one with a trailing slash (indicating that entries within this
+directory exist) and one without it (meaning this entry is an immediate
+completion candidate). `include_dirs` can be set to @{false} to only include
+those with a trailing slash.
+
+@tparam string path The path to complete.
+@tparam string location The location where paths are resolved from.
+@tparam[opt] boolean include_files When @{false}, only directories will be
+included in the returned list.
+@tparam[opt] boolean include_dirs When @{false}, "raw" directories will not be
+included in the returned list.
+@treturn { string... } A list of possible completion candidates.
+@since 1.74
+]]
+function complete(path, location, include_files, include_dirs) end
--- a/doc/stub/global.lua
+++ b/doc/stub/global.lua
@ -0,0 +1,130 @@
+--[[-
+Functions in the global environment, defined in `bios.lua`. This does not
+include standard Lua functions.
+
+@module _G
+]]
+
+--[[- Pauses execution for the specified number of seconds.
+
+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
+thread, not the whole program.
+
+**Note** 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.
+
+**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 @{os.startTimer|timers},
+or the @{parallel|parallel API}.
+
+@tparam number time The number of seconds to sleep for, rounded up to the
+nearest multiple of 0.05.
+
+@see os.startTimer
+@usage Sleep for three seconds.
+
+    print("Sleeping for three seconds")
+    sleep(3)
+    print("Done!")
+]]
+function sleep(time) end
+
+--- Writes a line of text to the screen without a newline at the end, wrapping
+-- text if necessary.
+--
+-- @tparam string text The text to write to the string
+-- @treturn number The number of lines written
+-- @see print A wrapper around write that adds a newline and accepts multiple arguments
+-- @usage write("Hello, world")
+function write(text) end
+
+--- Prints the specified values to the screen separated by spaces, wrapping if
+-- necessary. After printing, the cursor is moved to the next line.
+--
+-- @param ... The values to print on the screen
+-- @treturn number The number of lines written
+-- @usage print("Hello, world!")
+function print(...) end
+
+--- Prints the specified values to the screen in red, separated by spaces,
+-- wrapping if necessary. After printing, the cursor is moved to the next line.
+--
+-- @param ... The values to print on the screen
+-- @usage printError("Something went wrong!")
+function printError(...) end
+
+--[[- Reads user input from the terminal, automatically handling arrow keys,
+pasting, character replacement, history scrollback, auto-completion, and
+default values.
+
+@tparam[opt] string replaceChar A character to replace each typed character with.
+This can be used for hiding passwords, for example.
+@tparam[opt] table history A table holding history items that can be scrolled
+back to with the up/down arrow keys. The oldest item is at index 1, while the
+newest item is at the highest index.
+@tparam[opt] function(partial: string):({ string... }|nil) completeFn A function
+to be used for completion. This function should take the partial text typed so
+far, and returns a list of possible completion options.
+@tparam[opt] string default Default text which should already be entered into
+the prompt.
+
+@treturn string The text typed in.
+
+@see cc.completion For functions to help with completion.
+@usage Read a string and echo it back to the user
+
+    write("> ")
+    local msg = read()
+    print(msg)
+
+@usage Prompt a user for a password.
+
+    while true do
+      write("Password> ")
+      local pwd = read("*")
+      if pwd == "let me in" then break end
+      print("Incorrect password, try again.")
+    end
+    print("Logged in!")
+
+@usage A complete example with completion, history and a default value.
+
+    local completion = require "cc.completion"
+    local history = { "potato", "orange", "apple" }
+    local choices = { "apple", "orange", "banana", "strawberry" }
+    write("> ")
+    local msg = read(nil, history, function(text) return completion.choice(text, choices) end, "app")
+    print(msg)
+
+@changed 1.74 Added `completeFn` parameter.
+@changed 1.80pr1 Added `default` parameter.
+]]
+function read(replaceChar, history, completeFn, default) end
+
+--- The ComputerCraft and Minecraft version of the current computer environment.
+--
+-- For example, `ComputerCraft 1.93.0 (Minecraft 1.15.2)`.
+-- @usage _HOST
+-- @since 1.76
+_HOST = _HOST
+
+--[[- The default computer settings as defined in the ComputerCraft
+configuration.
+
+This is a comma-separated list of settings pairs defined by the mod
+configuration or server owner. By default, it is empty.
+
+An example value to disable autocompletion:
+
+    shell.autocomplete=false,lua.autocomplete=false,edit.autocomplete=false
+
+@usage _CC_DEFAULT_SETTINGS
+@since 1.77
+]]
+_CC_DEFAULT_SETTINGS = _CC_DEFAULT_SETTINGS
--- a/doc/stub/http.lua
+++ b/doc/stub/http.lua
@ -0,0 +1,181 @@
+--- The http library allows communicating with web servers, sending and
+-- receiving data from them.
+--
+-- @module http
+-- @since 1.1
+
+--- Asynchronously make a HTTP request to the given url.
+--
+-- This returns immediately, a [`http_success`](#http-success-event) or
+-- [`http_failure`](#http-failure-event) will be queued once the request has
+-- completed.
+--
+-- @tparam      string url   The url to request
+-- @tparam[opt] string body  An optional string containing the body of the
+-- request. If specified, a `POST` request will be made instead.
+-- @tparam[opt] { [string] = string } headers Additional headers to send as part
+-- of this request.
+-- @tparam[opt] boolean binary Whether to make a binary HTTP request. If true,
+-- the body will not be UTF-8 encoded, and the received response will not be
+-- decoded.
+--
+-- @tparam[2] {
+--   url = string, body? = string, headers? = { [string] = string },
+--   binary? = boolean, method? = string, redirect? = boolean,
+-- } request Options for the request.
+--
+-- This table form is an expanded version of the previous syntax. All arguments
+-- from above are passed in as fields instead (for instance,
+-- `http.request("https://example.com")` becomes `http.request { url =
+-- "https://example.com" }`).
+--
+-- This table also accepts several additional options:
+--
+--  - `method`: Which HTTP method to use, for instance `"PATCH"` or `"DELETE"`.
+--  - `redirect`: Whether to follow HTTP redirects. Defaults to true.
+--
+-- @see http.get  For a synchronous way to make GET requests.
+-- @see http.post For a synchronous way to make POST requests.
+--
+-- @changed 1.63 Added argument for headers.
+-- @changed 1.80pr1 Added argument for binary handles.
+-- @changed 1.80pr1.6 Added support for table argument.
+-- @changed 1.86.0 Added PATCH and TRACE methods.
+function request(...) end
+
+--- Make a HTTP GET request to the given url.
+--
+-- @tparam string url   The url to request
+-- @tparam[opt] { [string] = string } headers Additional headers to send as part
+-- of this request.
+-- @tparam[opt] boolean binary Whether to make a binary HTTP request. If true,
+-- the body will not be UTF-8 encoded, and the received response will not be
+-- decoded.
+--
+-- @tparam[2] {
+--   url = string, headers? = { [string] = string },
+--   binary? = boolean, method? = string, redirect? = boolean,
+-- } request Options for the request. See @{http.request} for details on how
+-- these options behave.
+--
+-- @treturn Response The resulting http response, which can be read from.
+-- @treturn[2] nil When the http request failed, such as in the event of a 404
+-- error or connection timeout.
+-- @treturn string A message detailing why the request failed.
+-- @treturn Response|nil The failing http response, if available.
+--
+-- @changed 1.63 Added argument for headers.
+-- @changed 1.80pr1 Response handles are now returned on error if available.
+-- @changed 1.80pr1 Added argument for binary handles.
+-- @changed 1.80pr1.6 Added support for table argument.
+-- @changed 1.86.0 Added PATCH and TRACE methods.
+--
+-- @usage Make a request to [example.tweaked.cc](https://example.tweaked.cc),
+-- and print the returned page.
+-- ```lua
+-- local request = http.get("https://example.tweaked.cc")
+-- print(request.readAll())
+-- -- => HTTP is working!
+-- request.close()
+-- ```
+function get(...) end
+
+--- Make a HTTP POST request to the given url.
+--
+-- @tparam string url   The url to request
+-- @tparam string body  The body of the POST request.
+-- @tparam[opt] { [string] = string } headers Additional headers to send as part
+-- of this request.
+-- @tparam[opt] boolean binary Whether to make a binary HTTP request. If true,
+-- the body will not be UTF-8 encoded, and the received response will not be
+-- decoded.
+--
+-- @tparam[2] {
+--   url = string, body? = string, headers? = { [string] = string },
+--   binary? = boolean, method? = string, redirect? = boolean,
+-- } request Options for the request. See @{http.request} for details on how
+-- these options behave.
+--
+-- @treturn Response The resulting http response, which can be read from.
+-- @treturn[2] nil When the http request failed, such as in the event of a 404
+-- error or connection timeout.
+-- @treturn string A message detailing why the request failed.
+-- @treturn Response|nil The failing http response, if available.
+--
+-- @since 1.31
+-- @changed 1.63 Added argument for headers.
+-- @changed 1.80pr1 Response handles are now returned on error if available.
+-- @changed 1.80pr1 Added argument for binary handles.
+-- @changed 1.80pr1.6 Added support for table argument.
+-- @changed 1.86.0 Added PATCH and TRACE methods.
+function post(...) end
+
+--- Asynchronously determine whether a URL can be requested.
+--
+-- If this returns `true`, one should also listen for [`http_check`
+-- events](#http-check-event) which will container further information about
+-- whether the URL is allowed or not.
+--
+-- @tparam string url The URL to check.
+-- @treturn true When this url is not invalid. This does not imply that it is
+-- allowed - see the comment above.
+-- @treturn[2] false When this url is invalid.
+-- @treturn string A reason why this URL is not valid (for instance, if it is
+-- malformed, or blocked).
+--
+-- @see http.checkURL For a synchronous version.
+function checkURLAsync(url) end
+
+--- Determine whether a URL can be requested.
+--
+-- If this returns `true`, one should also listen for [`http_check`
+-- events](#http-check-event) which will container further information about
+-- whether the URL is allowed or not.
+--
+-- @tparam string url The URL to check.
+-- @treturn true When this url is valid and can be requested via @{http.request}.
+-- @treturn[2] false When this url is invalid.
+-- @treturn string A reason why this URL is not valid (for instance, if it is
+-- malformed, or blocked).
+--
+-- @see http.checkURLAsync For an asynchronous version.
+--
+-- @usage
+-- ```lua
+-- print(http.checkURL("https://example.tweaked.cc/"))
+-- -- => true
+-- print(http.checkURL("http://localhost/"))
+-- -- => false Domain not permitted
+-- print(http.checkURL("not a url"))
+-- -- => false URL malformed
+-- ```
+function checkURL(url) end
+
+--- Open a websocket.
+--
+-- @tparam string url The websocket url to connect to. This should have the
+-- `ws://` or `wss://` protocol.
+-- @tparam[opt] { [string] = string } headers Additional headers to send as part
+-- of the initial websocket connection.
+--
+-- @treturn Websocket The websocket connection.
+-- @treturn[2] false If the websocket connection failed.
+-- @treturn string An error message describing why the connection failed.
+-- @since 1.80pr1.1
+-- @changed 1.80pr1.3 No longer asynchronous.
+-- @changed 1.95.3 Added User-Agent to default headers.
+function websocket(url, headers) end
+
+--- Asynchronously open a websocket.
+--
+-- This returns immediately, a [`websocket_success`](#websocket-success-event)
+-- or [`websocket_failure`](#websocket-failure-event) will be queued once the
+-- request has completed.
+--
+-- @tparam string url The websocket url to connect to. This should have the
+-- `ws://` or `wss://` protocol.
+-- @tparam[opt] { [string] = string } headers Additional headers to send as part
+-- of the initial websocket connection.
+-- @since 1.80pr1.3
+-- @changed 1.95.3 Added User-Agent to default headers.
+function websocketAsync(url, headers) end
--- a/doc/stub/os.lua
+++ b/doc/stub/os.lua
@ -0,0 +1,128 @@
+-- Defined in bios.lua
+
+--[[- Loads the given API into the global environment.
+
+This function loads and executes the file at the given path, and all global
+variables and functions exported by it will by available through the use of
+`myAPI.<function name>`, where `myAPI` is the base name of the API file.
+
+@tparam string path The path of the API to load.
+@treturn boolean Whether or not the API was successfully loaded.
+@since 1.2
+
+@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.
+]]
+function loadAPI(path) end
+
+--- 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.
+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
+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"
+event, printing the error "Terminated".
+
+@tparam[opt] string filter Event to filter for.
+@treturn string event The name of the event that fired.
+@treturn any param... Optional additional parameters of the event.
+@usage Listen for `mouse_click` events.
+
+    while true do
+        local event, button, x, y = os.pullEvent("mouse_click")
+        print("Button", button, "was clicked at", x, ",", y)
+    end
+
+@usage Listen for multiple events.
+
+    while true do
+        local eventData = {os.pullEvent()}
+        local event = eventData[1]
+
+        if event == "mouse_click" then
+            print("Button", eventData[2], "was clicked at", eventData[3], ",", eventData[4])
+        elseif event == "key" then
+            print("Key code", eventData[2], "was pressed")
+        end
+    end
+
+@see os.pullEventRaw To pull the terminate event.
+@changed 1.3 Added filter argument.
+]]
+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
+the `terminate` event yourself - the program will not stop execution when
+<kbd>Ctrl+T</kbd> is pressed.
+
+@tparam[opt] string filter Event to filter for.
+@treturn string event The name of the event that fired.
+@treturn any param... Optional additional parameters of the event.
+@usage Listen for `terminate` events.
+
+    while true do
+        local event = os.pullEventRaw()
+        if event == "terminate" then
+            print("Caught terminate event!")
+        end
+    end
+
+@see os.pullEvent To pull events normally.
+]]
+function pullEventRaw(filter) end
+
+--- 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`).
+--
+-- This is defined by `bios.lua`. For the current version of CC:Tweaked, this
+-- should return `CraftOS 1.8`.
+--
+-- @treturn string The current CraftOS version.
+-- @usage os.version()
+function version() end
+
+--[[- Run the program at the given path with the specified environment and
+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.
+
+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}.
+
+@tparam table env The environment to run the program with.
+@tparam string path The exact path of the program to run.
+@param ... The arguments to pass to the program.
+@treturn boolean Whether or not the program ran successfully.
+@usage Run the default shell from within your program:
+
+    os.run({}, "/rom/programs/shell.lua")
+
+@see shell.run
+@see loadfile
+]]
+function run(env, path, ...) end
--- a/doc/stub/turtle.lua
+++ b/doc/stub/turtle.lua
@ -0,0 +1,14 @@
+--[[- Craft a recipe based on the turtle's inventory.
+
+The turtle's inventory should set up like a crafting grid. For instance, to
+craft sticks, slots 1 and 5 should contain planks. _All_ other slots should be
+empty, including those outside the crafting "grid".
+
+@tparam[opt=64] number limit The maximum number of crafting steps to run.
+@throws When limit is less than 1 or greater than 64.
+@treturn[1] true If crafting succeeds.
+@treturn[2] false If crafting fails.
+@treturn string A string describing why crafting failed.
+@since 1.4
+]]
+function craft(limit) end
--- a/gradle.properties
+++ b/gradle.properties
@ -6,12 +6,10 @@ mod_version=1.97.2

 # Minecraft properties
 mc_version=1.17.1
-#mappings_version=61
-
-# Dependencies
-cloth_config_version=5.0.34
-fabric_loader_version=0.11.7
 fabric_api_version=0.40.1+1.17
+fabric_loader_version=0.12.0
+
+cloth_api_version=2.0.54
+cloth_config_version=5.0.34
 jankson_version=1.2.0
 modmenu_version=2.0.2
-cloth_api_version=2.0.54
--- a/illuaminate.sexp
+++ b/illuaminate.sexp
@ -0,0 +1,115 @@
+; -*- mode: Lisp;-*-
+
+(sources
+  /doc/stub/
+  /doc/events/
+  /build/docs/luaJavadoc/
+  /src/main/resources/*/computercraft/lua/bios.lua
+  /src/main/resources/*/computercraft/lua/rom/
+  /src/test/resources/test-rom
+  /src/web/mount)
+
+
+(doc
+  (destination build/docs/lua)
+  (index doc/index.md)
+
+  (site
+    (title "CC: Tweaked")
+    (logo src/main/resources/pack.png)
+    (url https://tweaked.cc/)
+    (source-link https://github.com/cc-tweaked/CC-Tweaked/blob/${commit}/${path}#L${line})
+
+    (styles src/web/styles.css)
+    (scripts build/rollup/index.js)
+    (head doc/head.html))
+
+  (module-kinds
+    (peripheral Peripherals)
+    (generic_peripheral "Generic Peripherals")
+    (event Events))
+
+  (library-path
+    /doc/stub/
+    /build/docs/luaJavadoc/
+
+    /src/main/resources/*/computercraft/lua/rom/apis/
+    /src/main/resources/*/computercraft/lua/rom/apis/command/
+    /src/main/resources/*/computercraft/lua/rom/apis/turtle/
+
+    /src/main/resources/*/computercraft/lua/rom/modules/main/
+    /src/main/resources/*/computercraft/lua/rom/modules/command/
+    /src/main/resources/*/computercraft/lua/rom/modules/turtle/))
+
+(at /
+  (linters
+    syntax:string-index
+
+    ;; It'd be nice to avoid this, but right now there's a lot of instances of
+    ;; it.
+    -var:set-loop
+
+    ;; It's useful to name arguments for documentation, so we allow this. It'd
+    ;; be good to find a compromise in the future, but this works for now.
+    -var:unused-arg)
+
+  (lint
+    (bracket-spaces
+      (call no-space)
+      (function-args no-space)
+      (parens no-space)
+      (table space)
+      (index no-space))
+
+    (allow-clarifying-parens true)
+
+    ;; colours imports from colors, and we don't handle that right now.
+    ;; keys is entirely dynamic, so we skip it.
+    (dynamic-modules colours keys _G)
+
+    (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.
+(at
+  (/src/main/resources/*/computercraft/lua/bios.lua
+   /src/main/resources/*/computercraft/lua/rom/apis/)
+  (linters -var:unused-global)
+  (lint (allow-toplevel-global true)))
+
+;; Silence some variable warnings in documentation stubs.
+(at (/doc/stub/ /build/docs/luaJavadoc/)
+  (linters -var:unused-global)
+  (lint (allow-toplevel-global true)))
+
+;; Suppress warnings for currently undocumented modules.
+(at
+  (; Lua APIs
+   /src/main/resources/*/computercraft/lua/rom/apis/io.lua
+   /src/main/resources/*/computercraft/lua/rom/apis/window.lua)
+
+  (linters -doc:undocumented -doc:undocumented-arg -doc:undocumented-return))
+
+;; Suppress warnings for various APIs using its own deprecated members.
+(at
+  (/src/main/resources/*/computercraft/lua/bios.lua
+   /src/main/resources/*/computercraft/lua/rom/apis/turtle/turtle.lua)
+  (linters -var:deprecated))
+
+(at /src/test/resources/test-rom
+  ; We should still be able to test deprecated members.
+  (linters -var:deprecated)
+
+  (lint
+    (globals
+      :max sleep write
+      cct_test describe expect howlci fail it pending stub)))
+
+(at /src/web/mount/expr_template.lua (lint (globals :max __expr__)))
--- a/src/main/java/dan200/computercraft/api/IUpgradeBase.java
+++ b/src/main/java/dan200/computercraft/api/IUpgradeBase.java
@ -67,8 +67,6 @@ public interface IUpgradeBase
     * @param stack The stack to check. This is guaranteed to be non-empty and have the same item as
     *              {@link #getCraftingItem()}.
     * @return If this stack may be used to equip this upgrade.
-     * @see net.minecraftforge.common.crafting.NBTIngredient#test(ItemStack) For the implementation of the default
-     * check.
     */
    default boolean isItemSuitable( @Nonnull ItemStack stack )
    {
--- a/src/main/java/dan200/computercraft/api/lua/GenericSource.java
+++ b/src/main/java/dan200/computercraft/api/lua/GenericSource.java
@ -10,6 +10,7 @@ import dan200.computercraft.api.peripheral.IPeripheral;
 import dan200.computercraft.api.peripheral.IPeripheralProvider;
 import dan200.computercraft.core.asm.LuaMethod;
 import net.minecraft.resources.ResourceLocation;
+import net.minecraft.world.Container;

 import javax.annotation.Nonnull;

@ -18,20 +19,19 @@ import javax.annotation.Nonnull;
 *
 * Unlike normal objects ({@link IDynamicLuaObject} or {@link IPeripheral}), methods do not target this object but
 * instead are defined as {@code static} and accept their target as the first parameter. This allows you to inject
- * methods onto objects you do not own, as well as declaring methods for a specific "trait" (for instance, a
- * {@link Capability}).
+ * methods onto objects you do not own, as well as declaring methods for a specific "trait" (well, interface).
 *
 * Currently the "generic peripheral" system is incompatible with normal peripherals. Normal {@link IPeripheralProvider}
 * or {@link IPeripheral} implementations take priority. Tile entities which use this system are given a peripheral name
 * determined by their id, rather than any peripheral provider. This will hopefully change in the future, once a suitable
 * design has been established.
 *
- * For example, the main CC: Tweaked mod defines a generic source for inventories, which works on {@link IItemHandler}s:
+ * For example, the main CC: Tweaked mod defines a generic source for inventories, which works on {@link Container}s:
 *
 * <pre>{@code
 * public class InventoryMethods implements GenericSource {
 *     \@LuaFunction( mainThread = true )
- *     public static int size(IItemHandler inventory) {
+ *     public static int size(Container inventory) {
 *         return inventory.getSlots();
 *     }
 *
@ -40,8 +40,6 @@ import javax.annotation.Nonnull;
 * }</pre>
 *
 * @see ComputerCraftAPI#registerGenericSource(GenericSource)
- * @see ComputerCraftAPI#registerGenericCapability(Capability) New capabilities (those not built into Forge) must be
- * explicitly given to the generic peripheral system, as there is no way to enumerate all capabilities.
 */
 public interface GenericSource
 {
--- a/src/main/java/dan200/computercraft/shared/computer/blocks/BlockComputer.java
+++ b/src/main/java/dan200/computercraft/shared/computer/blocks/BlockComputer.java
@ -63,11 +63,11 @@ public class BlockComputer extends BlockComputerBase<TileComputer>
    public BlockEntityType<? extends TileComputer> getTypeByFamily( ComputerFamily family )
    {
        return switch( family )
-            {
-                case COMMAND -> ComputerCraftRegistry.ModTiles.COMPUTER_COMMAND;
-                case ADVANCED -> ComputerCraftRegistry.ModTiles.COMPUTER_ADVANCED;
-                default -> ComputerCraftRegistry.ModTiles.COMPUTER_NORMAL;
-            };
+        {
+            case COMMAND -> ComputerCraftRegistry.ModTiles.COMPUTER_COMMAND;
+            case ADVANCED -> ComputerCraftRegistry.ModTiles.COMPUTER_ADVANCED;
+            default -> ComputerCraftRegistry.ModTiles.COMPUTER_NORMAL;
+        };
    }

    @Nullable
--- a/src/main/java/dan200/computercraft/shared/integration/ModMenuIntegration.java
+++ b/src/main/java/dan200/computercraft/shared/integration/ModMenuIntegration.java
@ -42,7 +42,7 @@ public class ModMenuIntegration implements ModMenuApi

            client.addEntry( entryBuilder.startEnumSelector( new TextComponent( "Monitor Renderer" ), MonitorRenderer.class, ComputerCraft.monitorRenderer )
                .setDefaultValue( MonitorRenderer.BEST )
-                .setSaveConsumer( renderer -> {Config.clientConfig.set( "monitor_renderer", renderer );} )
+                .setSaveConsumer( renderer -> Config.clientConfig.set( "monitor_renderer", renderer ) )
                .setTooltip( Component.nullToEmpty( Config.clientConfig.getComment( "monitor_renderer" ) ) )
                .build() );

--- a/src/main/java/dan200/computercraft/shared/peripheral/modem/wireless/BlockWirelessModem.java
+++ b/src/main/java/dan200/computercraft/shared/peripheral/modem/wireless/BlockWirelessModem.java
@ -105,10 +105,10 @@ public class BlockWirelessModem extends BlockGeneric implements SimpleWaterlogge
    public BlockEntityType<? extends TileWirelessModem> getTypeByFamily( ComputerFamily family )
    {
        return switch( family )
-            {
-                case ADVANCED -> ComputerCraftRegistry.ModTiles.WIRELESS_MODEM_ADVANCED;
-                default -> ComputerCraftRegistry.ModTiles.WIRELESS_MODEM_NORMAL;
-            };
+        {
+            case ADVANCED -> ComputerCraftRegistry.ModTiles.WIRELESS_MODEM_ADVANCED;
+            default -> ComputerCraftRegistry.ModTiles.WIRELESS_MODEM_NORMAL;
+        };
    }

    @Nullable
--- a/src/main/java/dan200/computercraft/shared/turtle/apis/TurtleAPI.java
+++ b/src/main/java/dan200/computercraft/shared/turtle/apis/TurtleAPI.java
@ -18,6 +18,7 @@ import dan200.computercraft.core.apis.IAPIEnvironment;
 import dan200.computercraft.core.asm.TaskCallback;
 import dan200.computercraft.core.tracking.TrackingField;
 import dan200.computercraft.shared.peripheral.generic.data.ItemData;
+import dan200.computercraft.shared.peripheral.generic.methods.InventoryMethods;
 import dan200.computercraft.shared.turtle.core.*;
 import net.minecraft.world.item.ItemStack;

--- a/src/main/resources/cc.accesswidener
+++ b/src/main/resources/cc.accesswidener
@ -1,8 +1,4 @@
 accessWidener v1 named

 accessible class net/minecraft/client/renderer/RenderType$CompositeState
-accessible class net/minecraft/client/renderer/RenderType$CompositeStateBuilder
 accessible method net/minecraft/client/renderer/RenderType create (Ljava/lang/String;Lcom/mojang/blaze3d/vertex/VertexFormat;Lcom/mojang/blaze3d/vertex/VertexFormat$Mode;IZZLnet/minecraft/client/renderer/RenderType$CompositeState;)Lnet/minecraft/client/renderer/RenderType$CompositeRenderType;
-
-accessible class net/minecraft/client/render/RenderPhase$Shader
-accessible class net/minecraft/client/render/RenderPhase$Texture