mirror of
				https://github.com/SquidDev-CC/CC-Tweaked
				synced 2025-11-03 23:22:59 +00:00 
			
		
		
		
	Compare commits
	
		
			117 Commits
		
	
	
		
			v1.20.1-1.
			...
			v1.20.1-1.
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 
						 | 
					18f3426f1d | ||
| 
						 | 
					0ec46fe38e | ||
| 
						 | 
					569de7fafb | ||
| 
						 | 
					157ce4fa55 | ||
| 
						 | 
					b9ed66983d | ||
| 
						 | 
					d0fbec6c6b | ||
| 
						 | 
					a683697e8c | ||
| 
						 | 
					9e233a916f | ||
| 
						 | 
					5a9e21ccc3 | ||
| 
						 | 
					5f16909d4b | ||
| 
						 | 
					00475b9bb0 | ||
| 
						 | 
					018ce7c8a5 | ||
| 
						 | 
					44726827b4 | ||
| 
						 | 
					3cf914cb4c | ||
| 
						 | 
					180156ff1c | ||
| 
						 | 
					c6ba753568 | ||
| 
						 | 
					9f45c91925 | ||
| 
						 | 
					8344c0a5c2 | ||
| 
						 | 
					a292d33830 | ||
| 
						 | 
					341d1c7bc2 | ||
| 
						 | 
					531eacfac7 | ||
| 
						 | 
					1f3da5205c | ||
| 
						 | 
					798ceefafe | ||
| 
						 | 
					7c0f79fc3c | ||
| 
						 | 
					b35cefc5dd | ||
| 
						 | 
					69353a4fcf | ||
| 
						 | 
					ff363dca5a | ||
| 
						 | 
					1c51282426 | ||
| 
						 | 
					4a3a1c9275 | ||
| 
						 | 
					2557dd0af9 | ||
| 
						 | 
					b5c0c6e104 | ||
| 
						 | 
					876fd8ddb8 | ||
| 
						 | 
					ee3b1343b5 | ||
| 
						 | 
					b440b964b7 | ||
| 
						 | 
					5dfc401b45 | ||
| 
						 | 
					4344c3072f | ||
| 
						 | 
					947001104d | ||
| 
						 | 
					8711512769 | ||
| 
						 | 
					9c0ce27ce6 | ||
| 
						 | 
					c458360b18 | ||
| 
						 | 
					09ad6c1905 | ||
| 
						 | 
					0e1e8a72d3 | ||
| 
						 | 
					7c1e8e1951 | ||
| 
						 | 
					b03546a158 | ||
| 
						 | 
					582713467f | ||
| 
						 | 
					b6f41a0df5 | ||
| 
						 | 
					594738a022 | ||
| 
						 | 
					27f2ab364c | ||
| 
						 | 
					5a43273757 | ||
| 
						 | 
					97e28516fb | ||
| 
						 | 
					676fb5fb53 | ||
| 
						 | 
					63ba3fe274 | ||
| 
						 | 
					749b3df227 | ||
| 
						 | 
					b97634b717 | ||
| 
						 | 
					1b8344d0a3 | ||
| 
						 | 
					b42bc0a01a | ||
| 
						 | 
					0cff73e2fc | ||
| 
						 | 
					a892739f8e | ||
| 
						 | 
					f8785a092f | ||
| 
						 | 
					dd7e8fcefc | ||
| 
						 | 
					29c8f96912 | ||
| 
						 | 
					b9267ecbfc | ||
| 
						 | 
					9d2c2db22b | ||
| 
						 | 
					6660966320 | ||
| 
						 | 
					16324e1eac | ||
| 
						 | 
					32f5c38485 | ||
| 
						 | 
					01fe949b3e | ||
| 
						 | 
					c03fce275e | ||
| 
						 | 
					0998acaa82 | ||
| 
						 | 
					12a44fed6f | ||
| 
						 | 
					0a8d505323 | ||
| 
						 | 
					237a0ac3bb | ||
| 
						 | 
					b185d088b3 | ||
| 
						 | 
					051c70a731 | ||
| 
						 | 
					2e2f308ff3 | ||
| 
						 | 
					0f123b5efd | ||
| 
						 | 
					88cb03be6b | ||
| 
						 | 
					4360485880 | ||
| 
						 | 
					b69a44a927 | ||
| 
						 | 
					7d8f609c49 | ||
| 
						 | 
					e7f56c4d25 | ||
| 
						 | 
					fa2140d00b | ||
| 
						 | 
					03388149b1 | ||
| 
						 | 
					f212861370 | ||
| 
						 | 
					55edced9de | ||
| 
						 | 
					dc969c5a78 | ||
| 
						 | 
					94ad6dab0e | ||
| 
						 | 
					938eb38ad5 | ||
| 
						 | 
					6739c4c6c0 | ||
| 
						 | 
					d6749f8461 | ||
| 
						 | 
					5ba7f99326 | ||
| 
						 | 
					62c9e5b08f | ||
| 
						 | 
					2ca5850060 | ||
| 
						 | 
					ed631b05e7 | ||
| 
						 | 
					a2b9490d5c | ||
| 
						 | 
					8204944b5f | ||
| 
						 | 
					ef0af67e96 | ||
| 
						 | 
					9a914e75c4 | ||
| 
						 | 
					546577041b | ||
| 
						 | 
					f881c0ced0 | ||
| 
						 | 
					0b389e04b0 | ||
| 
						 | 
					d3a3ab3c21 | ||
| 
						 | 
					22e6c06e59 | ||
| 
						 | 
					3c46b8acd7 | ||
| 
						 | 
					d9fc1c3a80 | ||
| 
						 | 
					479aabdd09 | ||
| 
						 | 
					ad74893058 | ||
| 
						 | 
					2ba6d5815b | ||
| 
						 | 
					7e2f490626 | ||
| 
						 | 
					4dc649d5e5 | ||
| 
						 | 
					5bab415790 | ||
| 
						 | 
					9bbf3f3e1d | ||
| 
						 | 
					7c02979c22 | ||
| 
						 | 
					fdb65c9368 | ||
| 
						 | 
					ea670cc358 | ||
| 
						 | 
					1963e0160f | ||
| 
						 | 
					9a06904634 | 
@@ -18,11 +18,6 @@ ij_any_if_brace_force = if_multiline
 | 
			
		||||
ij_any_for_brace_force = if_multiline
 | 
			
		||||
ij_any_spaces_within_array_initializer_braces = true
 | 
			
		||||
 | 
			
		||||
ij_kotlin_allow_trailing_comma = true
 | 
			
		||||
ij_kotlin_allow_trailing_comma_on_call_site = true
 | 
			
		||||
ij_kotlin_method_parameters_wrap = off
 | 
			
		||||
ij_kotlin_call_parameters_wrap = off
 | 
			
		||||
 | 
			
		||||
[*.md]
 | 
			
		||||
trim_trailing_whitespace = false
 | 
			
		||||
 | 
			
		||||
@@ -31,3 +26,27 @@ indent_size = 2
 | 
			
		||||
 | 
			
		||||
[*.yml]
 | 
			
		||||
indent_size = 2
 | 
			
		||||
 | 
			
		||||
[*.{kt,kts}]
 | 
			
		||||
ij_kotlin_code_style_defaults = KOTLIN_OFFICIAL
 | 
			
		||||
ij_kotlin_continuation_indent_size = 4
 | 
			
		||||
ij_kotlin_spaces_around_equality_operators = true
 | 
			
		||||
 | 
			
		||||
ij_kotlin_allow_trailing_comma = true
 | 
			
		||||
ij_kotlin_allow_trailing_comma_on_call_site = true
 | 
			
		||||
 | 
			
		||||
# Prefer to handle these manually
 | 
			
		||||
ij_kotlin_method_parameters_wrap = off
 | 
			
		||||
ij_kotlin_call_parameters_wrap = off
 | 
			
		||||
ij_kotlin_extends_list_wrap = off
 | 
			
		||||
 | 
			
		||||
ktlint_code_style = intellij_idea
 | 
			
		||||
ktlint_standard_class-naming = disabled
 | 
			
		||||
ktlint_standard_class-signature = disabled
 | 
			
		||||
ktlint_standard_function-naming = disabled
 | 
			
		||||
ktlint_standard_no-wildcard-imports = disabled
 | 
			
		||||
 | 
			
		||||
# FIXME: These two are disable right now as they're over-eager in putting things
 | 
			
		||||
#  on the same line. We should set max_line_length and handle this properly.
 | 
			
		||||
ktlint_standard_function-signature = disabled
 | 
			
		||||
ktlint_standard_function-expression-body = disabled
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										6
									
								
								.github/ISSUE_TEMPLATE/bug_report.yaml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										6
									
								
								.github/ISSUE_TEMPLATE/bug_report.yaml
									
									
									
									
										vendored
									
									
								
							@@ -1,6 +1,7 @@
 | 
			
		||||
name: Bug report
 | 
			
		||||
description: Report some misbehaviour in the mod
 | 
			
		||||
labels: [ bug ]
 | 
			
		||||
type: bug
 | 
			
		||||
body:
 | 
			
		||||
- type: dropdown
 | 
			
		||||
  id: mc-version
 | 
			
		||||
@@ -10,7 +11,8 @@ body:
 | 
			
		||||
        What version of Minecraft are you using? If your version is not listed, please try to reproduce on one of the supported versions.
 | 
			
		||||
    options:
 | 
			
		||||
      - 1.20.1
 | 
			
		||||
      - 1.21.x
 | 
			
		||||
      - 1.21.1
 | 
			
		||||
      - 1.21.7
 | 
			
		||||
  validations:
 | 
			
		||||
    required: true
 | 
			
		||||
- type: input
 | 
			
		||||
@@ -29,3 +31,5 @@ body:
 | 
			
		||||
      Description of the bug. Please include the following:
 | 
			
		||||
      - Logs: These will be located in the `logs/` directory of your Minecraft instance. This is always useful, even if it doesn't include errors, so please upload this!
 | 
			
		||||
      - Detailed reproduction steps: sometimes I can spot a bug pretty easily, but often it's much more obscure. The more information I have to help reproduce it, the quicker it'll get fixed.
 | 
			
		||||
 | 
			
		||||
      
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										1
									
								
								.github/ISSUE_TEMPLATE/feature_request.md
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.github/ISSUE_TEMPLATE/feature_request.md
									
									
									
									
										vendored
									
									
								
							@@ -2,6 +2,7 @@
 | 
			
		||||
name: Feature request
 | 
			
		||||
about: Suggest an idea or improvement
 | 
			
		||||
labels: enhancement
 | 
			
		||||
type: feature
 | 
			
		||||
---
 | 
			
		||||
 | 
			
		||||
<!--
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										28
									
								
								.github/workflows/main-ci.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										28
									
								
								.github/workflows/main-ci.yml
									
									
									
									
										vendored
									
									
								
							@@ -14,7 +14,7 @@ jobs:
 | 
			
		||||
    - name: 📥 Set up Java
 | 
			
		||||
      uses: actions/setup-java@v4
 | 
			
		||||
      with:
 | 
			
		||||
        java-version: 17
 | 
			
		||||
        java-version: 21
 | 
			
		||||
        distribution: 'temurin'
 | 
			
		||||
 | 
			
		||||
    - name: 📥 Setup Gradle
 | 
			
		||||
@@ -30,6 +30,18 @@ jobs:
 | 
			
		||||
    - name: ⚒️ Build
 | 
			
		||||
      run: ./gradlew assemble || ./gradlew assemble
 | 
			
		||||
 | 
			
		||||
    - name: 📦 Prepare Jars
 | 
			
		||||
      run: |
 | 
			
		||||
        # Find the main jar and append the git hash onto it.
 | 
			
		||||
        mkdir -p jars
 | 
			
		||||
        find projects/forge/build/libs projects/fabric/build/libs -type f -regex '.*[0-9.]+\(-SNAPSHOT\)?\.jar$' -exec bash -c 'cp {} "jars/$(basename {} .jar)-$(git rev-parse HEAD).jar"' \;
 | 
			
		||||
 | 
			
		||||
    - name: 📤 Upload Jar
 | 
			
		||||
      uses: actions/upload-artifact@v4
 | 
			
		||||
      with:
 | 
			
		||||
        name: CC-Tweaked
 | 
			
		||||
        path: ./jars
 | 
			
		||||
 | 
			
		||||
    - name: Cache pre-commit
 | 
			
		||||
      uses: actions/cache@v4
 | 
			
		||||
      with:
 | 
			
		||||
@@ -54,18 +66,6 @@ jobs:
 | 
			
		||||
      run: ./tools/parse-reports.py
 | 
			
		||||
      if: ${{ failure() }}
 | 
			
		||||
 | 
			
		||||
    - name: 📦 Prepare Jars
 | 
			
		||||
      run: |
 | 
			
		||||
        # Find the main jar and append the git hash onto it.
 | 
			
		||||
        mkdir -p jars
 | 
			
		||||
        find projects/forge/build/libs projects/fabric/build/libs -type f -regex '.*[0-9.]+\(-SNAPSHOT\)?\.jar$' -exec bash -c 'cp {} "jars/$(basename {} .jar)-$(git rev-parse HEAD).jar"' \;
 | 
			
		||||
 | 
			
		||||
    - name: 📤 Upload Jar
 | 
			
		||||
      uses: actions/upload-artifact@v4
 | 
			
		||||
      with:
 | 
			
		||||
        name: CC-Tweaked
 | 
			
		||||
        path: ./jars
 | 
			
		||||
 | 
			
		||||
  build-core:
 | 
			
		||||
    strategy:
 | 
			
		||||
      fail-fast: false
 | 
			
		||||
@@ -87,7 +87,7 @@ jobs:
 | 
			
		||||
    - name: 📥 Set up Java
 | 
			
		||||
      uses: actions/setup-java@v4
 | 
			
		||||
      with:
 | 
			
		||||
        java-version: 17
 | 
			
		||||
        java-version: 21
 | 
			
		||||
        distribution: 'temurin'
 | 
			
		||||
 | 
			
		||||
    - name: 📥 Setup Gradle
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										2
									
								
								.github/workflows/make-doc.yml
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								.github/workflows/make-doc.yml
									
									
									
									
										vendored
									
									
								
							@@ -17,7 +17,7 @@ jobs:
 | 
			
		||||
    - name: 📥 Set up Java
 | 
			
		||||
      uses: actions/setup-java@v4
 | 
			
		||||
      with:
 | 
			
		||||
        java-version: 17
 | 
			
		||||
        java-version: 21
 | 
			
		||||
        distribution: 'temurin'
 | 
			
		||||
 | 
			
		||||
    - name: 📥 Setup Gradle
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										1
									
								
								.gitignore
									
									
									
									
										vendored
									
									
								
							@@ -27,6 +27,7 @@
 | 
			
		||||
*.iml
 | 
			
		||||
.idea
 | 
			
		||||
.gradle
 | 
			
		||||
.kotlin
 | 
			
		||||
*.DS_Store
 | 
			
		||||
 | 
			
		||||
/.classpath
 | 
			
		||||
 
 | 
			
		||||
@@ -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.4.0
 | 
			
		||||
  rev: v5.0.0
 | 
			
		||||
  hooks:
 | 
			
		||||
  - id: trailing-whitespace
 | 
			
		||||
  - id: end-of-file-fixer
 | 
			
		||||
@@ -27,7 +27,7 @@ repos:
 | 
			
		||||
    exclude: "^(.*\\.(bat)|LICENSE)$"
 | 
			
		||||
 | 
			
		||||
- repo: https://github.com/fsfe/reuse-tool
 | 
			
		||||
  rev: v4.0.3
 | 
			
		||||
  rev: v5.0.2
 | 
			
		||||
  hooks:
 | 
			
		||||
  - id: reuse
 | 
			
		||||
 | 
			
		||||
@@ -58,6 +58,7 @@ repos:
 | 
			
		||||
exclude: |
 | 
			
		||||
  (?x)^(
 | 
			
		||||
    projects/[a-z]+/src/generated|
 | 
			
		||||
    projects/[a-z]+/src/examples/generatedResources|
 | 
			
		||||
    projects/core/src/test/resources/test-rom/data/json-parsing/|
 | 
			
		||||
    .*\.dfpwm
 | 
			
		||||
  )
 | 
			
		||||
 
 | 
			
		||||
@@ -22,14 +22,13 @@ If you have a bug, suggestion, or other feedback, the best thing to do is [file
 | 
			
		||||
use the issue templates - they provide a useful hint on what information to provide.
 | 
			
		||||
 | 
			
		||||
## Translations
 | 
			
		||||
Translations are managed through [CrowdIn], an online interface for managing language strings. Translations may either
 | 
			
		||||
be contributed there, or directly via a pull request.
 | 
			
		||||
Translations are managed through [CrowdIn], an online interface for managing language strings.
 | 
			
		||||
 | 
			
		||||
## Setting up a development environment
 | 
			
		||||
In order to develop CC: Tweaked, you'll need to download the source code and then run it.
 | 
			
		||||
 | 
			
		||||
 - Make sure you've got the following software installed:
 | 
			
		||||
   - Java Development Kit 17 (JDK). This can be downloaded from [Adoptium].
 | 
			
		||||
   - Java Development Kit 21 (JDK). This can be downloaded from [Adoptium].
 | 
			
		||||
   - [Git](https://git-scm.com/).
 | 
			
		||||
   - [NodeJS 20 or later][node].
 | 
			
		||||
 | 
			
		||||
@@ -49,9 +48,12 @@ If you want to run CC:T in a normal Minecraft instance, run `./gradlew assemble`
 | 
			
		||||
`projects/forge/build/libs` (for Forge) or `projects/fabric/build/libs` (for Fabric).
 | 
			
		||||
 | 
			
		||||
## Developing CC: Tweaked
 | 
			
		||||
Before making any major changes to CC: Tweaked, I'd recommend you have a read of the [the architecture
 | 
			
		||||
document][architecture] first. While it's not a comprehensive document, it gives a good hint of where you should start
 | 
			
		||||
looking to make your changes. As always, if you're not sure, [do ask the community][community]!
 | 
			
		||||
Before making any major changes to CC: Tweaked, I'd recommend starting opening an issue or starting a discussion on
 | 
			
		||||
GitHub first. It's often helpful to discuss features before spending time developing them!
 | 
			
		||||
 | 
			
		||||
Once you're ready to start programming, have a read of the [the architecture document][architecture] first. While it's
 | 
			
		||||
not a comprehensive document, it gives a good hint of where you should start looking to make your changes. As always, if
 | 
			
		||||
you're not sure, [do ask the community][community]!
 | 
			
		||||
 | 
			
		||||
### Testing
 | 
			
		||||
When making larger changes, it may be useful to write a test to make sure your code works as expected.
 | 
			
		||||
@@ -86,8 +88,8 @@ You'll first need to [set up a development environment as above](#setting-up-a-d
 | 
			
		||||
 | 
			
		||||
Once this is set up, you can now run `./gradlew docWebsite`. This generates documentation from our Lua and Java code,
 | 
			
		||||
writing the resulting HTML into `./projects/web/build/site`, which can then be opened in a browser. When iterating on
 | 
			
		||||
documentation, you can instead run `./gradlew docWebsite -t`, which will rebuild documentation every time you change a
 | 
			
		||||
file.
 | 
			
		||||
documentation, you can instead run `./gradlew :web:assemble -x :web:compileTeaVM -t`, which will rebuild documentation
 | 
			
		||||
every time you change a file.
 | 
			
		||||
 | 
			
		||||
Documentation is built using [illuaminate] which, while not currently documented (somewhat ironic), is largely the same
 | 
			
		||||
as [ldoc][ldoc]. Documentation comments are written in Markdown, though note that we do not support many GitHub-specific
 | 
			
		||||
@@ -99,7 +101,7 @@ 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"
 | 
			
		||||
[Adoptium]: https://adoptium.net/temurin/releases?version=21 "Download OpenJDK 21"
 | 
			
		||||
[illuaminate]: https://github.com/SquidDev/illuaminate/ "Illuaminate on GitHub"
 | 
			
		||||
[docs]: https://tweaked.cc/ "CC: Tweaked documentation"
 | 
			
		||||
[ldoc]: http://stevedonovan.github.io/ldoc/ "ldoc, a Lua documentation generator."
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										13
									
								
								README.md
									
									
									
									
									
								
							
							
						
						
									
										13
									
								
								README.md
									
									
									
									
									
								
							@@ -61,19 +61,6 @@ dependencies {
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
When using ForgeGradle, you may also need to add the following:
 | 
			
		||||
 | 
			
		||||
```groovy
 | 
			
		||||
minecraft {
 | 
			
		||||
    runs {
 | 
			
		||||
        configureEach {
 | 
			
		||||
            property 'mixin.env.remapRefMap', 'true'
 | 
			
		||||
            property 'mixin.env.refMapRemappingFile', "${buildDir}/createSrgToMcp/output.srg"
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
```
 | 
			
		||||
 | 
			
		||||
You should also be careful to only use classes within the `dan200.computercraft.api` package. Non-API classes are
 | 
			
		||||
subject to change at any point. If you depend on functionality outside the API (or need to mixin to CC:T), please file
 | 
			
		||||
an issue to let me know!
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										32
									
								
								REUSE.toml
									
									
									
									
									
								
							
							
						
						
									
										32
									
								
								REUSE.toml
									
									
									
									
									
								
							@@ -8,18 +8,23 @@ SPDX-PackageSupplier = "Jonathan Coates <git@squiddev.cc>"
 | 
			
		||||
SPDX-PackageDownloadLocation = "https://github.com/cc-tweaked/cc-tweaked"
 | 
			
		||||
 | 
			
		||||
[[annotations]]
 | 
			
		||||
# Generated/data files are CC0.
 | 
			
		||||
SPDX-FileCopyrightText = "The CC: Tweaked Developers"
 | 
			
		||||
SPDX-License-Identifier = "CC0-1.0"
 | 
			
		||||
path = [
 | 
			
		||||
    # Generated/data files are CC0.
 | 
			
		||||
    "gradle/gradle-daemon-jvm.properties",
 | 
			
		||||
    "projects/common/src/main/resources/assets/computercraft/sounds.json",
 | 
			
		||||
    "projects/common/src/main/resources/assets/computercraft/sounds/empty.ogg",
 | 
			
		||||
    "projects/common/src/testMod/resources/data/cctest/computercraft/turtle_upgrades/**",
 | 
			
		||||
    "projects/common/src/testMod/resources/data/cctest/structures/**",
 | 
			
		||||
    "projects/**/src/generated/**",
 | 
			
		||||
    "projects/*/src/generated/**",
 | 
			
		||||
    "projects/web/src/htmlTransform/export/index.json",
 | 
			
		||||
    "projects/web/src/htmlTransform/export/items/minecraft/**",
 | 
			
		||||
    # GitHub build scripts are CC0. While we could add a header to each file,
 | 
			
		||||
    # it's unclear if it will break actions or issue templates in some way.
 | 
			
		||||
    ".github/**",
 | 
			
		||||
    # Example mod is CC0.
 | 
			
		||||
    "projects/*/src/examples/**"
 | 
			
		||||
]
 | 
			
		||||
 | 
			
		||||
[[annotations]]
 | 
			
		||||
@@ -30,23 +35,15 @@ path = [
 | 
			
		||||
    "doc/images/**",
 | 
			
		||||
    "package.json",
 | 
			
		||||
    "package-lock.json",
 | 
			
		||||
    "projects/common/src/client/resources/computercraft-client.mixins.json",
 | 
			
		||||
    "projects/*/src/*/resources/*.mixins.json",
 | 
			
		||||
    "projects/fabric/src/*/resources/fabric.mod.json",
 | 
			
		||||
    "projects/common/src/main/resources/assets/minecraft/shaders/core/computercraft/monitor_tbo.json",
 | 
			
		||||
    "projects/common/src/main/resources/computercraft.mixins.json",
 | 
			
		||||
    "projects/common/src/testMod/resources/computercraft-gametest.mixins.json",
 | 
			
		||||
    "projects/common/src/testMod/resources/data/computercraft/loot_tables/treasure_disk.json",
 | 
			
		||||
    "projects/common/src/testMod/resources/pack.mcmeta",
 | 
			
		||||
    "projects/core/src/main/resources/data/computercraft/lua/rom/modules/command/.ignoreme",
 | 
			
		||||
    "projects/core/src/main/resources/data/computercraft/lua/rom/modules/main/.ignoreme",
 | 
			
		||||
    "projects/core/src/main/resources/data/computercraft/lua/rom/modules/turtle/.ignoreme",
 | 
			
		||||
    "projects/core/src/main/resources/data/computercraft/lua/rom/motd.txt",
 | 
			
		||||
    "projects/fabric-api/src/main/modJson/fabric.mod.json",
 | 
			
		||||
    "projects/fabric/src/client/resources/computercraft-client.fabric.mixins.json",
 | 
			
		||||
    "projects/fabric/src/main/resources/computercraft.fabric.mixins.json",
 | 
			
		||||
    "projects/fabric/src/main/resources/fabric.mod.json",
 | 
			
		||||
    "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/frontend/mount/.settings",
 | 
			
		||||
    "projects/web/src/frontend/mount/example.nfp",
 | 
			
		||||
    "projects/web/src/frontend/mount/example.nft",
 | 
			
		||||
@@ -73,7 +70,7 @@ path = [
 | 
			
		||||
]
 | 
			
		||||
 | 
			
		||||
[[annotations]]
 | 
			
		||||
# Community-contributed license files
 | 
			
		||||
# Community-contributed language files
 | 
			
		||||
SPDX-FileCopyrightText = "2017 The CC: Tweaked Developers"
 | 
			
		||||
SPDX-License-Identifier = "LicenseRef-CCPL"
 | 
			
		||||
path = [
 | 
			
		||||
@@ -87,18 +84,11 @@ path = [
 | 
			
		||||
]
 | 
			
		||||
 | 
			
		||||
[[annotations]]
 | 
			
		||||
# Community-contributed license files
 | 
			
		||||
# Community-contributed language files
 | 
			
		||||
SPDX-FileCopyrightText = "2017 The CC: Tweaked Developers"
 | 
			
		||||
SPDX-License-Identifier = "MPL-2.0"
 | 
			
		||||
path = "projects/common/src/main/resources/assets/computercraft/lang/**"
 | 
			
		||||
 | 
			
		||||
[[annotations]]
 | 
			
		||||
# GitHub build scripts are CC0. While we could add a header to each file,
 | 
			
		||||
# it's unclear if it will break actions or issue templates in some way.
 | 
			
		||||
SPDX-FileCopyrightText = "Jonathan Coates <git@squiddev.cc>"
 | 
			
		||||
SPDX-License-Identifier = "CC0-1.0"
 | 
			
		||||
path = ".github/**"
 | 
			
		||||
 | 
			
		||||
[[annotations]]
 | 
			
		||||
path = ["gradle/wrapper/**"]
 | 
			
		||||
SPDX-FileCopyrightText = "Gradle Inc"
 | 
			
		||||
 
 | 
			
		||||
@@ -4,13 +4,11 @@
 | 
			
		||||
 | 
			
		||||
import cc.tweaked.gradle.JUnitExt
 | 
			
		||||
import net.fabricmc.loom.api.LoomGradleExtensionAPI
 | 
			
		||||
import net.fabricmc.loom.util.gradle.SourceSetHelper
 | 
			
		||||
import org.jetbrains.gradle.ext.*
 | 
			
		||||
import org.jetbrains.gradle.ext.Application
 | 
			
		||||
 | 
			
		||||
plugins {
 | 
			
		||||
    publishing
 | 
			
		||||
    alias(libs.plugins.taskTree)
 | 
			
		||||
    alias(libs.plugins.githubRelease)
 | 
			
		||||
    alias(libs.plugins.gradleVersions)
 | 
			
		||||
    alias(libs.plugins.versionCatalogUpdate)
 | 
			
		||||
@@ -24,21 +22,19 @@ val mcVersion: String by extra
 | 
			
		||||
 | 
			
		||||
githubRelease {
 | 
			
		||||
    token(findProperty("githubApiKey") as String? ?: "")
 | 
			
		||||
    owner.set("cc-tweaked")
 | 
			
		||||
    repo.set("CC-Tweaked")
 | 
			
		||||
    targetCommitish.set(cct.gitBranch)
 | 
			
		||||
    owner = "cc-tweaked"
 | 
			
		||||
    repo = "CC-Tweaked"
 | 
			
		||||
    targetCommitish = cct.gitBranch
 | 
			
		||||
 | 
			
		||||
    tagName.set("v$mcVersion-$modVersion")
 | 
			
		||||
    releaseName.set("[$mcVersion] $modVersion")
 | 
			
		||||
    body.set(
 | 
			
		||||
        provider {
 | 
			
		||||
            "## " + project(":core").file("src/main/resources/data/computercraft/lua/rom/help/whatsnew.md")
 | 
			
		||||
                .readLines()
 | 
			
		||||
                .takeWhile { it != "Type \"help changelog\" to see the full version history." }
 | 
			
		||||
                .joinToString("\n").trim()
 | 
			
		||||
        },
 | 
			
		||||
    )
 | 
			
		||||
    prerelease.set(isUnstable)
 | 
			
		||||
    tagName = "v$mcVersion-$modVersion"
 | 
			
		||||
    releaseName = "[$mcVersion] $modVersion"
 | 
			
		||||
    body = provider {
 | 
			
		||||
        "## " + project(":core").file("src/main/resources/data/computercraft/lua/rom/help/whatsnew.md")
 | 
			
		||||
            .readLines()
 | 
			
		||||
            .takeWhile { it != "Type \"help changelog\" to see the full version history." }
 | 
			
		||||
            .joinToString("\n").trim()
 | 
			
		||||
    }
 | 
			
		||||
    prerelease = isUnstable
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
tasks.publish { dependsOn(tasks.githubRelease) }
 | 
			
		||||
@@ -72,7 +68,7 @@ idea.project.settings.runConfigurations {
 | 
			
		||||
        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 }
 | 
			
		||||
                modSettings.modFiles.joinToString(File.pathSeparator) { it.absolutePath }
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
        vmParameters = "-ea -Dfabric.classPathGroups=$classPathGroup"
 | 
			
		||||
@@ -117,8 +113,12 @@ idea.project.settings.compiler.javac {
 | 
			
		||||
        .toMap()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
versionCatalogUpdate {
 | 
			
		||||
    sortByKey.set(false)
 | 
			
		||||
    pin { versions.addAll("fastutil", "guava", "netty", "slf4j") }
 | 
			
		||||
    keep { keepUnusedLibraries.set(true) }
 | 
			
		||||
repositories() {
 | 
			
		||||
    mavenCentral()
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
versionCatalogUpdate {
 | 
			
		||||
    sortByKey = false
 | 
			
		||||
    pin { versions.addAll("fastutil", "guava", "netty", "slf4j") }
 | 
			
		||||
    keep { keepUnusedVersions = true }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -14,18 +14,10 @@ repositories {
 | 
			
		||||
    mavenCentral()
 | 
			
		||||
    gradlePluginPortal()
 | 
			
		||||
 | 
			
		||||
    maven("https://maven.minecraftforge.net") {
 | 
			
		||||
        name = "Forge"
 | 
			
		||||
    maven("https://maven.neoforged.net") {
 | 
			
		||||
        name = "NeoForge"
 | 
			
		||||
        content {
 | 
			
		||||
            includeGroup("net.minecraftforge")
 | 
			
		||||
            includeGroup("net.minecraftforge.gradle")
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    maven("https://maven.parchmentmc.org") {
 | 
			
		||||
        name = "Librarian"
 | 
			
		||||
        content {
 | 
			
		||||
            includeGroupByRegex("^org\\.parchmentmc.*")
 | 
			
		||||
            includeGroup("net.neoforged")
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
@@ -33,6 +25,7 @@ repositories {
 | 
			
		||||
        name = "Fabric"
 | 
			
		||||
        content {
 | 
			
		||||
            includeGroup("net.fabricmc")
 | 
			
		||||
            includeGroup("net.fabricmc.unpick")
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
@@ -50,10 +43,9 @@ dependencies {
 | 
			
		||||
    implementation(libs.spotless)
 | 
			
		||||
 | 
			
		||||
    implementation(libs.fabric.loom)
 | 
			
		||||
    implementation(libs.forgeGradle)
 | 
			
		||||
    implementation(libs.ideaExt)
 | 
			
		||||
    implementation(libs.librarian)
 | 
			
		||||
    implementation(libs.minotaur)
 | 
			
		||||
    implementation(libs.modDevGradle)
 | 
			
		||||
    implementation(libs.vanillaExtract)
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
@@ -77,7 +69,7 @@ gradlePlugin {
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
versionCatalogUpdate {
 | 
			
		||||
    sortByKey.set(false)
 | 
			
		||||
    keep { keepUnusedLibraries.set(true) }
 | 
			
		||||
    catalogFile.set(file("../gradle/libs.versions.toml"))
 | 
			
		||||
    sortByKey = false
 | 
			
		||||
    keep { keepUnusedVersions = true }
 | 
			
		||||
    catalogFile = file("../gradle/libs.versions.toml")
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -4,10 +4,7 @@
 | 
			
		||||
 | 
			
		||||
/** Default configuration for Fabric projects. */
 | 
			
		||||
 | 
			
		||||
import cc.tweaked.gradle.CCTweakedExtension
 | 
			
		||||
import cc.tweaked.gradle.CCTweakedPlugin
 | 
			
		||||
import cc.tweaked.gradle.IdeaRunConfigurations
 | 
			
		||||
import cc.tweaked.gradle.MinecraftConfigurations
 | 
			
		||||
import cc.tweaked.gradle.*
 | 
			
		||||
 | 
			
		||||
plugins {
 | 
			
		||||
    `java-library`
 | 
			
		||||
@@ -30,7 +27,7 @@ repositories {
 | 
			
		||||
 | 
			
		||||
loom {
 | 
			
		||||
    splitEnvironmentSourceSets()
 | 
			
		||||
    splitModDependencies.set(true)
 | 
			
		||||
    splitModDependencies = true
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
MinecraftConfigurations.setup(project)
 | 
			
		||||
@@ -67,3 +64,19 @@ dependencies {
 | 
			
		||||
tasks.ideaSyncTask {
 | 
			
		||||
    doLast { IdeaRunConfigurations(project).patch() }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
tasks.named("checkDependencyConsistency", DependencyCheck::class.java) {
 | 
			
		||||
    val libs = project.extensions.getByType<VersionCatalogsExtension>().named("libs")
 | 
			
		||||
    // Minecraft depends on lwjgl, but Fabric forces it to a more recent version
 | 
			
		||||
    for (lwjgl in listOf(
 | 
			
		||||
        "lwjgl",
 | 
			
		||||
        "lwjgl-glfw",
 | 
			
		||||
        "lwjgl-jemalloc",
 | 
			
		||||
        "lwjgl-openal",
 | 
			
		||||
        "lwjgl-opengl",
 | 
			
		||||
        "lwjgl-stb",
 | 
			
		||||
        "lwjgl-tinyfd",
 | 
			
		||||
    )) {
 | 
			
		||||
        override("org.lwjgl", lwjgl, "3.3.2")
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -6,25 +6,25 @@
 | 
			
		||||
 | 
			
		||||
import cc.tweaked.gradle.CCTweakedExtension
 | 
			
		||||
import cc.tweaked.gradle.CCTweakedPlugin
 | 
			
		||||
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.moddev.legacyforge")
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
plugins.apply(CCTweakedPlugin::class.java)
 | 
			
		||||
 | 
			
		||||
val mcVersion: String by extra
 | 
			
		||||
 | 
			
		||||
minecraft {
 | 
			
		||||
legacyForge {
 | 
			
		||||
    val libs = project.extensions.getByType<VersionCatalogsExtension>().named("libs")
 | 
			
		||||
    mappings("parchment", "${libs.findVersion("parchmentMc").get()}-${libs.findVersion("parchment").get()}-$mcVersion")
 | 
			
		||||
    version = "$mcVersion-${libs.findVersion("forge").get()}"
 | 
			
		||||
 | 
			
		||||
    accessTransformer(project(":forge").file("src/main/resources/META-INF/accesstransformer.cfg"))
 | 
			
		||||
    parchment {
 | 
			
		||||
        minecraftVersion = libs.findVersion("parchmentMc").get().toString()
 | 
			
		||||
        mappingsVersion = libs.findVersion("parchment").get().toString()
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
MinecraftConfigurations.setup(project)
 | 
			
		||||
@@ -32,13 +32,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() }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -17,6 +17,8 @@ plugins {
 | 
			
		||||
    checkstyle
 | 
			
		||||
    id("com.diffplug.spotless")
 | 
			
		||||
    id("net.ltgt.errorprone")
 | 
			
		||||
    // Required for cross-project dependencies in Fabric
 | 
			
		||||
    id("net.fabricmc.fabric-loom-companion")
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
val modVersion: String by extra
 | 
			
		||||
@@ -28,9 +30,9 @@ version = modVersion
 | 
			
		||||
base.archivesName.convention("cc-tweaked-$mcVersion-${project.name}")
 | 
			
		||||
 | 
			
		||||
java {
 | 
			
		||||
    toolchain {
 | 
			
		||||
        languageVersion.set(CCTweakedPlugin.JAVA_VERSION)
 | 
			
		||||
    }
 | 
			
		||||
    toolchain { languageVersion = CCTweakedPlugin.JDK_VERSION }
 | 
			
		||||
    sourceCompatibility = CCTweakedPlugin.JAVA_VERSION
 | 
			
		||||
    targetCompatibility = CCTweakedPlugin.JAVA_VERSION
 | 
			
		||||
 | 
			
		||||
    withSourcesJar()
 | 
			
		||||
}
 | 
			
		||||
@@ -44,13 +46,6 @@ repositories {
 | 
			
		||||
 | 
			
		||||
    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")
 | 
			
		||||
            // Things we mirror
 | 
			
		||||
@@ -86,19 +81,31 @@ dependencies {
 | 
			
		||||
// Configure default JavaCompile tasks with our arguments.
 | 
			
		||||
sourceSets.all {
 | 
			
		||||
    tasks.named(compileJavaTaskName, JavaCompile::class.java) {
 | 
			
		||||
        // Processing just gives us "No processor claimed any of these annotations", so skip that!
 | 
			
		||||
        options.compilerArgs.addAll(listOf("-Xlint", "-Xlint:-processing"))
 | 
			
		||||
        // Explicitly set release, as that limits the APIs we can use to the right version of Java.
 | 
			
		||||
        options.release = CCTweakedPlugin.JAVA_TARGET.asInt()
 | 
			
		||||
 | 
			
		||||
        options.compilerArgs.addAll(
 | 
			
		||||
            listOf(
 | 
			
		||||
                "-Xlint",
 | 
			
		||||
                // Processing just gives us "No processor claimed any of these annotations", so skip that!
 | 
			
		||||
                "-Xlint:-processing",
 | 
			
		||||
                // We violate this pattern too often for it to be a helpful warning. Something to improve one day!
 | 
			
		||||
                "-Xlint:-this-escape",
 | 
			
		||||
            ),
 | 
			
		||||
        )
 | 
			
		||||
 | 
			
		||||
        options.errorprone {
 | 
			
		||||
            check("InvalidBlockTag", CheckSeverity.OFF) // Broken by @cc.xyz
 | 
			
		||||
            check("InvalidParam", CheckSeverity.OFF) // Broken by records.
 | 
			
		||||
            check("InlineMeSuggester", CheckSeverity.OFF) // Minecraft uses @Deprecated liberally
 | 
			
		||||
            // Too many false positives right now. Maybe we need an indirection for it later on.
 | 
			
		||||
            check("AssignmentExpression", CheckSeverity.OFF) // I'm a bad person.
 | 
			
		||||
            check("ReferenceEquality", CheckSeverity.OFF)
 | 
			
		||||
            check("EnumOrdinal", CheckSeverity.OFF) // For now. We could replace most of these with EnumMap.
 | 
			
		||||
            check("OperatorPrecedence", CheckSeverity.OFF) // For now.
 | 
			
		||||
            check("NonOverridingEquals", CheckSeverity.OFF) // Peripheral.equals makes this hard to avoid
 | 
			
		||||
            check("FutureReturnValueIgnored", CheckSeverity.OFF) // Too many false positives with Netty
 | 
			
		||||
            check("InvalidInlineTag", CheckSeverity.OFF) // Triggered by @snippet. Can be removed on Java 21.
 | 
			
		||||
            option("UnusedMethod:ExemptingMethodAnnotations", "dan200.computercraft.api.lua.LuaFunction")
 | 
			
		||||
 | 
			
		||||
            check("NullAway", CheckSeverity.ERROR)
 | 
			
		||||
            option(
 | 
			
		||||
@@ -121,7 +128,6 @@ tasks.compileTestJava {
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
tasks.withType(JavaCompile::class.java).configureEach {
 | 
			
		||||
    options.encoding = "UTF-8"
 | 
			
		||||
}
 | 
			
		||||
@@ -155,7 +161,7 @@ tasks.javadoc {
 | 
			
		||||
    options {
 | 
			
		||||
        val stdOptions = this as StandardJavadocDocletOptions
 | 
			
		||||
        stdOptions.addBooleanOption("Xdoclint:all,-missing", true)
 | 
			
		||||
        stdOptions.links("https://docs.oracle.com/en/java/javase/17/docs/api/")
 | 
			
		||||
        stdOptions.links("https://docs.oracle.com/en/java/javase/21/docs/api/")
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
@@ -169,8 +175,8 @@ tasks.test {
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
tasks.withType(JacocoReport::class.java).configureEach {
 | 
			
		||||
    reports.xml.required.set(true)
 | 
			
		||||
    reports.html.required.set(true)
 | 
			
		||||
    reports.xml.required = true
 | 
			
		||||
    reports.html.required = true
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
project.plugins.withType(CCTweakedPlugin::class.java) {
 | 
			
		||||
@@ -194,30 +200,23 @@ spotless {
 | 
			
		||||
    fun FormatExtension.defaults() {
 | 
			
		||||
        endWithNewline()
 | 
			
		||||
        trimTrailingWhitespace()
 | 
			
		||||
        indentWithSpaces(4)
 | 
			
		||||
        leadingTabsToSpaces(4)
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    java {
 | 
			
		||||
        defaults()
 | 
			
		||||
        importOrder("", "javax|java", "\\#")
 | 
			
		||||
        removeUnusedImports()
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    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",
 | 
			
		||||
    )
 | 
			
		||||
 | 
			
		||||
    kotlinGradle {
 | 
			
		||||
        defaults()
 | 
			
		||||
        ktlint().editorConfigOverride(ktlintConfig)
 | 
			
		||||
        ktlint()
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    kotlin {
 | 
			
		||||
        defaults()
 | 
			
		||||
        ktlint().editorConfigOverride(ktlintConfig)
 | 
			
		||||
        ktlint()
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
@@ -226,6 +225,5 @@ idea.module {
 | 
			
		||||
 | 
			
		||||
    // Force Gradle to write to inherit the output directory from the parent, instead of writing to out/xxx/classes.
 | 
			
		||||
    // This is required for Loom, and we patch Forge's run configurations to work there.
 | 
			
		||||
    // TODO: Submit a patch to Forge to support ProjectRootManager.
 | 
			
		||||
    inheritOutputDirs = true
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -1,25 +0,0 @@
 | 
			
		||||
// SPDX-FileCopyrightText: 2022 The CC: Tweaked Developers
 | 
			
		||||
//
 | 
			
		||||
// SPDX-License-Identifier: MPL-2.0
 | 
			
		||||
 | 
			
		||||
import cc.tweaked.gradle.CCTweakedPlugin
 | 
			
		||||
import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
 | 
			
		||||
 | 
			
		||||
plugins {
 | 
			
		||||
    kotlin("jvm")
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
kotlin {
 | 
			
		||||
    jvmToolchain {
 | 
			
		||||
        languageVersion.set(CCTweakedPlugin.JAVA_VERSION)
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
tasks.withType(KotlinCompile::class.java).configureEach {
 | 
			
		||||
    // So technically we shouldn't need to do this as the toolchain sets it above. However, the option only appears
 | 
			
		||||
    // to be set when the task executes, so doesn't get picked up by IDEs.
 | 
			
		||||
    kotlinOptions.jvmTarget = when {
 | 
			
		||||
        CCTweakedPlugin.JAVA_VERSION.asInt() > 8 -> CCTweakedPlugin.JAVA_VERSION.toString()
 | 
			
		||||
        else -> "1.${CCTweakedPlugin.JAVA_VERSION.asInt()}"
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -24,16 +24,16 @@ val modVersion: String by extra
 | 
			
		||||
val mcVersion: String by extra
 | 
			
		||||
 | 
			
		||||
modrinth {
 | 
			
		||||
    token.set(findProperty("modrinthApiKey") as String? ?: "")
 | 
			
		||||
    projectId.set("gu7yAYhd")
 | 
			
		||||
    versionNumber.set(modVersion)
 | 
			
		||||
    versionName.set(modVersion)
 | 
			
		||||
    versionType.set(if (isUnstable) "alpha" else "release")
 | 
			
		||||
    token = findProperty("modrinthApiKey") as String? ?: ""
 | 
			
		||||
    projectId = "gu7yAYhd"
 | 
			
		||||
    versionNumber = modVersion
 | 
			
		||||
    versionName = modVersion
 | 
			
		||||
    versionType = if (isUnstable) "alpha" else "release"
 | 
			
		||||
    uploadFile.setProvider(modPublishing.output)
 | 
			
		||||
    gameVersions.add(mcVersion)
 | 
			
		||||
    changelog.set("Release notes can be found on the [GitHub repository](https://github.com/cc-tweaked/CC-Tweaked/releases/tag/v$mcVersion-$modVersion).")
 | 
			
		||||
    changelog = "Release notes can be found on the [GitHub repository](https://github.com/cc-tweaked/CC-Tweaked/releases/tag/v$mcVersion-$modVersion)."
 | 
			
		||||
 | 
			
		||||
    syncBodyFrom.set(provider { rootProject.file("doc/mod-page.md").readText() })
 | 
			
		||||
    syncBodyFrom = provider { rootProject.file("doc/mod-page.md").readText() }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
tasks.publish { dependsOn(tasks.modrinth) }
 | 
			
		||||
 
 | 
			
		||||
@@ -2,44 +2,35 @@
 | 
			
		||||
//
 | 
			
		||||
// SPDX-License-Identifier: MPL-2.0
 | 
			
		||||
 | 
			
		||||
import cc.tweaked.gradle.clientClasses
 | 
			
		||||
import cc.tweaked.gradle.commonClasses
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Sets up the configurations for writing game tests.
 | 
			
		||||
 *
 | 
			
		||||
 * See notes in [cc.tweaked.gradle.MinecraftConfigurations] for the general design behind these cursed ideas.
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
import cc.tweaked.gradle.CCTweakedPlugin
 | 
			
		||||
import cc.tweaked.gradle.MinecraftConfigurations
 | 
			
		||||
import cc.tweaked.gradle.clientClasses
 | 
			
		||||
import cc.tweaked.gradle.commonClasses
 | 
			
		||||
 | 
			
		||||
plugins {
 | 
			
		||||
    id("cc-tweaked.kotlin-convention")
 | 
			
		||||
    kotlin("jvm")
 | 
			
		||||
    id("cc-tweaked.java-convention")
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
val main = sourceSets["main"]
 | 
			
		||||
val client = sourceSets["client"]
 | 
			
		||||
 | 
			
		||||
// Both testMod and testFixtures inherit from the main and client classpath, just so we have access to Minecraft classes.
 | 
			
		||||
val testMod by sourceSets.creating {
 | 
			
		||||
    compileClasspath += main.compileClasspath + client.compileClasspath
 | 
			
		||||
    runtimeClasspath += main.runtimeClasspath + client.runtimeClasspath
 | 
			
		||||
}
 | 
			
		||||
MinecraftConfigurations.createDerivedConfiguration(project, MinecraftConfigurations.DATAGEN)
 | 
			
		||||
MinecraftConfigurations.createDerivedConfiguration(project, MinecraftConfigurations.EXAMPLES)
 | 
			
		||||
MinecraftConfigurations.createDerivedConfiguration(project, MinecraftConfigurations.TEST_MOD)
 | 
			
		||||
 | 
			
		||||
configurations {
 | 
			
		||||
    named(testMod.compileClasspathConfigurationName) {
 | 
			
		||||
        shouldResolveConsistentlyWith(compileClasspath.get())
 | 
			
		||||
    }
 | 
			
		||||
// Set up generated resources
 | 
			
		||||
sourceSets.main { resources.srcDir("src/generated/resources") }
 | 
			
		||||
sourceSets.named("examples") { resources.srcDir("src/examples/generatedResources") }
 | 
			
		||||
 | 
			
		||||
    named(testMod.runtimeClasspathConfigurationName) {
 | 
			
		||||
        shouldResolveConsistentlyWith(runtimeClasspath.get())
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// Like the main test configurations, we're safe to depend on source set outputs.
 | 
			
		||||
dependencies {
 | 
			
		||||
    add(testMod.implementationConfigurationName, main.output)
 | 
			
		||||
    add(testMod.implementationConfigurationName, client.output)
 | 
			
		||||
}
 | 
			
		||||
// Make sure our examples compile.
 | 
			
		||||
tasks.check { dependsOn(tasks.named("compileExamplesJava")) }
 | 
			
		||||
 | 
			
		||||
// Similar to java-test-fixtures, but tries to avoid putting the obfuscated jar on the classpath.
 | 
			
		||||
 | 
			
		||||
@@ -62,3 +53,5 @@ dependencies {
 | 
			
		||||
 | 
			
		||||
    testImplementation(testFixtures(project))
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
kotlin.compilerOptions.jvmTarget = CCTweakedPlugin.KOTLIN_TARGET
 | 
			
		||||
@@ -12,25 +12,26 @@ publishing {
 | 
			
		||||
        register<MavenPublication>("maven") {
 | 
			
		||||
            artifactId = base.archivesName.get()
 | 
			
		||||
            from(components["java"])
 | 
			
		||||
            suppressAllPomMetadataWarnings()
 | 
			
		||||
 | 
			
		||||
            pom {
 | 
			
		||||
                name.set("CC: Tweaked")
 | 
			
		||||
                description.set("CC: Tweaked is a fork of ComputerCraft, adding programmable computers, turtles and more to Minecraft.")
 | 
			
		||||
                url.set("https://github.com/cc-tweaked/CC-Tweaked")
 | 
			
		||||
                name = "CC: Tweaked"
 | 
			
		||||
                description = "CC: Tweaked is a fork of ComputerCraft, adding programmable computers, turtles and more to Minecraft."
 | 
			
		||||
                url = "https://github.com/cc-tweaked/CC-Tweaked"
 | 
			
		||||
 | 
			
		||||
                scm {
 | 
			
		||||
                    url.set("https://github.com/cc-tweaked/CC-Tweaked.git")
 | 
			
		||||
                    url = "https://github.com/cc-tweaked/CC-Tweaked.git"
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                issueManagement {
 | 
			
		||||
                    system.set("github")
 | 
			
		||||
                    url.set("https://github.com/cc-tweaked/CC-Tweaked/issues")
 | 
			
		||||
                    system = "github"
 | 
			
		||||
                    url = "https://github.com/cc-tweaked/CC-Tweaked/issues"
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                licenses {
 | 
			
		||||
                    license {
 | 
			
		||||
                        name.set("ComputerCraft Public License, Version 1.0")
 | 
			
		||||
                        url.set("https://github.com/cc-tweaked/CC-Tweaked/blob/HEAD/LICENSE")
 | 
			
		||||
                        name = "ComputerCraft Public License, Version 1.0"
 | 
			
		||||
                        url = "https://github.com/cc-tweaked/CC-Tweaked/blob/HEAD/LICENSE"
 | 
			
		||||
                    }
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
 
 | 
			
		||||
@@ -10,14 +10,9 @@ 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
 | 
			
		||||
import org.gradle.api.tasks.SourceSet
 | 
			
		||||
import org.gradle.api.tasks.bundling.Jar
 | 
			
		||||
import org.gradle.api.tasks.compile.JavaCompile
 | 
			
		||||
@@ -25,7 +20,6 @@ import org.gradle.api.tasks.javadoc.Javadoc
 | 
			
		||||
import org.gradle.language.base.plugins.LifecycleBasePlugin
 | 
			
		||||
import org.gradle.language.jvm.tasks.ProcessResources
 | 
			
		||||
import org.gradle.process.JavaForkOptions
 | 
			
		||||
import org.gradle.testing.jacoco.plugins.JacocoCoverageReport
 | 
			
		||||
import org.gradle.testing.jacoco.plugins.JacocoPluginExtension
 | 
			
		||||
import org.gradle.testing.jacoco.plugins.JacocoTaskExtension
 | 
			
		||||
import org.gradle.testing.jacoco.tasks.JacocoReport
 | 
			
		||||
@@ -36,54 +30,40 @@ import java.io.IOException
 | 
			
		||||
import java.net.URI
 | 
			
		||||
import java.util.regex.Pattern
 | 
			
		||||
 | 
			
		||||
abstract class CCTweakedExtension(
 | 
			
		||||
    private val project: Project,
 | 
			
		||||
    private val fs: FileSystemOperations,
 | 
			
		||||
) {
 | 
			
		||||
abstract class CCTweakedExtension(private val project: Project) {
 | 
			
		||||
    /** Get the hash of the latest git commit. */
 | 
			
		||||
    val gitHash: Provider<String> = gitProvider(project, "<no git hash>") {
 | 
			
		||||
        ProcessHelpers.captureOut("git", "-C", project.rootProject.projectDir.absolutePath, "rev-parse", "HEAD").trim()
 | 
			
		||||
    }
 | 
			
		||||
    val gitHash: Provider<String> =
 | 
			
		||||
        gitProvider("<no git commit>", listOf("rev-parse", "HEAD")) { it.trim() }
 | 
			
		||||
 | 
			
		||||
    /** Get the current git branch. */
 | 
			
		||||
    val gitBranch: Provider<String> = gitProvider(project, "<no git branch>") {
 | 
			
		||||
        ProcessHelpers.captureOut("git", "-C", project.rootProject.projectDir.absolutePath, "rev-parse", "--abbrev-ref", "HEAD")
 | 
			
		||||
            .trim()
 | 
			
		||||
    }
 | 
			
		||||
    val gitBranch: Provider<String> =
 | 
			
		||||
        gitProvider("<no git branch>", listOf("rev-parse", "--abbrev-ref", "HEAD")) { it.trim() }
 | 
			
		||||
 | 
			
		||||
    /** Get a list of all contributors to the project. */
 | 
			
		||||
    val gitContributors: Provider<List<String>> = gitProvider(project, listOf()) {
 | 
			
		||||
        ProcessHelpers.captureLines(
 | 
			
		||||
            "git", "-C", project.rootProject.projectDir.absolutePath, "shortlog", "-ns",
 | 
			
		||||
            "--group=author", "--group=trailer:co-authored-by", "HEAD",
 | 
			
		||||
        )
 | 
			
		||||
            .asSequence()
 | 
			
		||||
            .map {
 | 
			
		||||
                val matcher = COMMIT_COUNTS.matcher(it)
 | 
			
		||||
                matcher.find()
 | 
			
		||||
                matcher.group(1)
 | 
			
		||||
            }
 | 
			
		||||
            .filter { !IGNORED_USERS.contains(it) }
 | 
			
		||||
            .toList()
 | 
			
		||||
            .sortedWith(String.CASE_INSENSITIVE_ORDER)
 | 
			
		||||
    }
 | 
			
		||||
    val gitContributors: Provider<List<String>> =
 | 
			
		||||
        gitProvider(listOf(), listOf("shortlog", "-ns", "--group=author", "--group=trailer:co-authored-by", "HEAD")) { input ->
 | 
			
		||||
            input.lineSequence()
 | 
			
		||||
                .filter { it.isNotEmpty() }
 | 
			
		||||
                .map {
 | 
			
		||||
                    val matcher = COMMIT_COUNTS.matcher(it)
 | 
			
		||||
                    matcher.find()
 | 
			
		||||
                    matcher.group(1)
 | 
			
		||||
                }
 | 
			
		||||
                .filter { !IGNORED_USERS.contains(it) }
 | 
			
		||||
                .toList()
 | 
			
		||||
                .sortedWith(String.CASE_INSENSITIVE_ORDER)
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * References to other sources
 | 
			
		||||
     */
 | 
			
		||||
    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() }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
@@ -109,14 +89,13 @@ abstract class CCTweakedExtension(
 | 
			
		||||
        val otherJava = otherProject.extensions.getByType(JavaPluginExtension::class.java)
 | 
			
		||||
        val main = otherJava.sourceSets.getByName("main")
 | 
			
		||||
        val client = otherJava.sourceSets.getByName("client")
 | 
			
		||||
        val testMod = otherJava.sourceSets.findByName("testMod")
 | 
			
		||||
        val testFixtures = otherJava.sourceSets.findByName("testFixtures")
 | 
			
		||||
 | 
			
		||||
        // Pull in sources from the other project.
 | 
			
		||||
        extendSourceSet(otherProject, main)
 | 
			
		||||
        extendSourceSet(otherProject, client)
 | 
			
		||||
        if (testMod != null) extendSourceSet(otherProject, testMod)
 | 
			
		||||
        if (testFixtures != null) extendSourceSet(otherProject, testFixtures)
 | 
			
		||||
        for (sourceSet in listOf(MinecraftConfigurations.DATAGEN, MinecraftConfigurations.EXAMPLES, MinecraftConfigurations.TEST_MOD, "testFixtures")) {
 | 
			
		||||
            otherJava.sourceSets.findByName(sourceSet)?.let { extendSourceSet(otherProject, it) }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        // The extra source-processing tasks should include these files too.
 | 
			
		||||
        project.tasks.named(main.javadocTaskName, Javadoc::class.java) { source(main.allJava, client.allJava) }
 | 
			
		||||
@@ -179,23 +158,19 @@ abstract class CCTweakedExtension(
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    fun <T> jacoco(task: NamedDomainObjectProvider<T>) where T : Task, T : JavaForkOptions {
 | 
			
		||||
        val classDump = project.layout.buildDirectory.dir("jacocoClassDump/${task.name}")
 | 
			
		||||
        val reportTaskName = "jacoco${task.name.capitalise()}Report"
 | 
			
		||||
 | 
			
		||||
        val jacoco = project.extensions.getByType(JacocoPluginExtension::class.java)
 | 
			
		||||
        task.configure {
 | 
			
		||||
            finalizedBy(reportTaskName)
 | 
			
		||||
 | 
			
		||||
            doFirst("Clean class dump directory") { fs.delete { delete(classDump) } }
 | 
			
		||||
 | 
			
		||||
            jacoco.applyTo(this)
 | 
			
		||||
 | 
			
		||||
            extensions.configure(JacocoTaskExtension::class.java) {
 | 
			
		||||
                includes = listOf("dan200.computercraft.*")
 | 
			
		||||
                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.
 | 
			
		||||
                isIncludeNoLocationClasses = true
 | 
			
		||||
                excludes = listOf(
 | 
			
		||||
                    "dan200.computercraft.mixin.*", // Exclude mixins, as they're not executed at runtime.
 | 
			
		||||
                    "dan200.computercraft.shared.Capabilities$*", // Exclude capability tokens, as Forge rewrites them.
 | 
			
		||||
                )
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
@@ -204,15 +179,11 @@ abstract class CCTweakedExtension(
 | 
			
		||||
            description = "Generates code coverage report for the ${task.name} task."
 | 
			
		||||
 | 
			
		||||
            executionData(task.get())
 | 
			
		||||
            classDirectories.from(classDump)
 | 
			
		||||
 | 
			
		||||
            // Don't want to use sourceSets(...) here as we have a custom class directory.
 | 
			
		||||
            for (ref in sourceSets.get()) sourceDirectories.from(ref.allSource.sourceDirectories)
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        project.extensions.configure(ReportingExtension::class.java) {
 | 
			
		||||
            reports.register("${task.name}CodeCoverageReport", JacocoCoverageReport::class.java) {
 | 
			
		||||
                testType.set(TestSuiteType.INTEGRATION_TEST)
 | 
			
		||||
            // Don't want to use sourceSets(...) here as we don't use all class directories.
 | 
			
		||||
            for (ref in this@CCTweakedExtension.sourceDirectories.get()) {
 | 
			
		||||
                sourceDirectories.from(ref.sourceSet.allSource.sourceDirectories)
 | 
			
		||||
                if (ref.classes) classDirectories.from(ref.sourceSet.output)
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
@@ -252,18 +223,23 @@ abstract class CCTweakedExtension(
 | 
			
		||||
        ).resolve().single()
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Exclude a dependency from being published in Maven.
 | 
			
		||||
     */
 | 
			
		||||
    fun exclude(dep: Dependency) {
 | 
			
		||||
        excludedDeps.add(dep)
 | 
			
		||||
    }
 | 
			
		||||
    private fun <T: Any> gitProvider(default: T, command: List<String>, process: (String) -> T): Provider<T> {
 | 
			
		||||
        val baseResult = project.providers.exec {
 | 
			
		||||
            commandLine = listOf("git", "-C", project.rootDir.absolutePath) + command
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Configure a [MavenDependencySpec].
 | 
			
		||||
     */
 | 
			
		||||
    fun configureExcludes(spec: MavenDependencySpec) {
 | 
			
		||||
        for (dep in excludedDeps.get()) spec.exclude(dep)
 | 
			
		||||
        return project.provider {
 | 
			
		||||
            val res = try {
 | 
			
		||||
                baseResult.standardOutput.asText.get()
 | 
			
		||||
            } catch (e: IOException) {
 | 
			
		||||
                project.logger.error("Cannot read Git repository: ${e.message}", e)
 | 
			
		||||
                return@provider default
 | 
			
		||||
            } catch (e: GradleException) {
 | 
			
		||||
                project.logger.error("Cannot read Git repository: ${e.message}", e)
 | 
			
		||||
                return@provider default
 | 
			
		||||
            }
 | 
			
		||||
            process(res)
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    companion object {
 | 
			
		||||
@@ -272,20 +248,6 @@ abstract class CCTweakedExtension(
 | 
			
		||||
            "GitHub", "Daniel Ratcliffe", "NotSquidDev", "Weblate",
 | 
			
		||||
        )
 | 
			
		||||
 | 
			
		||||
        private fun <T> gitProvider(project: Project, default: T, supplier: () -> T): Provider<T> {
 | 
			
		||||
            return project.provider {
 | 
			
		||||
                try {
 | 
			
		||||
                    supplier()
 | 
			
		||||
                } catch (e: IOException) {
 | 
			
		||||
                    project.logger.error("Cannot read Git repository: ${e.message}")
 | 
			
		||||
                    default
 | 
			
		||||
                } catch (e: GradleException) {
 | 
			
		||||
                    project.logger.error("Cannot read Git repository: ${e.message}")
 | 
			
		||||
                    default
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        private val isIdeSync: Boolean
 | 
			
		||||
            get() = java.lang.Boolean.parseBoolean(System.getProperty("idea.sync.active", "false"))
 | 
			
		||||
    }
 | 
			
		||||
 
 | 
			
		||||
@@ -4,6 +4,7 @@
 | 
			
		||||
 | 
			
		||||
package cc.tweaked.gradle
 | 
			
		||||
 | 
			
		||||
import org.gradle.api.JavaVersion
 | 
			
		||||
import org.gradle.api.Plugin
 | 
			
		||||
import org.gradle.api.Project
 | 
			
		||||
import org.gradle.api.plugins.JavaPlugin
 | 
			
		||||
@@ -13,6 +14,7 @@ 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
 | 
			
		||||
import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Configures projects to match a shared configuration.
 | 
			
		||||
@@ -42,6 +44,17 @@ class CCTweakedPlugin : Plugin<Project> {
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    companion object {
 | 
			
		||||
        val JAVA_VERSION = JavaLanguageVersion.of(17)
 | 
			
		||||
        /**
 | 
			
		||||
         * The version we run with. We use Java 21 here, as our Gradle build requires that.
 | 
			
		||||
         */
 | 
			
		||||
        val JDK_VERSION = JavaLanguageVersion.of(21)
 | 
			
		||||
 | 
			
		||||
        /**
 | 
			
		||||
         * The Java version we target. Should be the same as what Minecraft uses.
 | 
			
		||||
         */
 | 
			
		||||
        val JAVA_TARGET = JavaLanguageVersion.of(17)
 | 
			
		||||
 | 
			
		||||
        val JAVA_VERSION = JavaVersion.toVersion(JAVA_TARGET.asInt())
 | 
			
		||||
        val KOTLIN_TARGET = JvmTarget.fromTarget(JAVA_TARGET.toString())
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -22,19 +22,19 @@ import org.gradle.language.base.plugins.LifecycleBasePlugin
 | 
			
		||||
 | 
			
		||||
abstract class DependencyCheck : DefaultTask() {
 | 
			
		||||
    @get:Input
 | 
			
		||||
    abstract val configuration: ListProperty<Configuration>
 | 
			
		||||
    protected abstract val dependencies: ListProperty<DependencyResult>
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * A mapping of module coordinates (`group:module`) to versions, overriding the requested version.
 | 
			
		||||
     */
 | 
			
		||||
    @get:Input
 | 
			
		||||
    abstract val overrides: MapProperty<String, String>
 | 
			
		||||
    protected abstract val overrides: MapProperty<String, String>
 | 
			
		||||
 | 
			
		||||
    init {
 | 
			
		||||
        description = "Check :core's dependencies are consistent with Minecraft's."
 | 
			
		||||
        group = LifecycleBasePlugin.VERIFICATION_GROUP
 | 
			
		||||
 | 
			
		||||
        configuration.finalizeValueOnRead()
 | 
			
		||||
        dependencies.finalizeValueOnRead()
 | 
			
		||||
        overrides.finalizeValueOnRead()
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
@@ -45,13 +45,23 @@ abstract class DependencyCheck : DefaultTask() {
 | 
			
		||||
        overrides.putAll(project.provider { mutableMapOf(module.get().module.toString() to version) })
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    fun override(group: String, module: String, version: String) {
 | 
			
		||||
        overrides.put("$group:$module", version)
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Add a configuration to check.
 | 
			
		||||
     */
 | 
			
		||||
    fun configuration(configuration: Provider<Configuration>) {
 | 
			
		||||
        // We can't store the Configuration in the cache, so store the resolved dependencies instead.
 | 
			
		||||
        dependencies.addAll(configuration.map { it.incoming.resolutionResult.allDependencies })
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @TaskAction
 | 
			
		||||
    fun run() {
 | 
			
		||||
        var ok = true
 | 
			
		||||
        for (configuration in configuration.get()) {
 | 
			
		||||
            configuration.incoming.resolutionResult.allDependencies {
 | 
			
		||||
                if (!check(this@allDependencies)) ok = false
 | 
			
		||||
            }
 | 
			
		||||
        for (configuration in dependencies.get()) {
 | 
			
		||||
            if (!check(configuration)) ok = false
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        if (!ok) {
 | 
			
		||||
 
 | 
			
		||||
@@ -5,10 +5,8 @@
 | 
			
		||||
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
 | 
			
		||||
import java.io.File
 | 
			
		||||
 | 
			
		||||
abstract class ExecToDir : AbstractExecTask<ExecToDir>(ExecToDir::class.java) {
 | 
			
		||||
    @get:OutputDirectory
 | 
			
		||||
 
 | 
			
		||||
@@ -124,7 +124,7 @@ class CloseScope : AutoCloseable {
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/** Proxy method to avoid overload ambiguity. */
 | 
			
		||||
fun <T> Property<T>.setProvider(provider: Provider<out T>) = set(provider)
 | 
			
		||||
fun <T: Any> 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
 | 
			
		||||
 
 | 
			
		||||
@@ -1,26 +0,0 @@
 | 
			
		||||
// SPDX-FileCopyrightText: 2023 The CC: Tweaked Developers
 | 
			
		||||
//
 | 
			
		||||
// SPDX-License-Identifier: MPL-2.0
 | 
			
		||||
 | 
			
		||||
package cc.tweaked.gradle
 | 
			
		||||
 | 
			
		||||
import net.minecraftforge.gradle.common.util.RunConfig
 | 
			
		||||
import net.minecraftforge.gradle.common.util.runs.setRunConfigInternal
 | 
			
		||||
import org.gradle.api.plugins.JavaPluginExtension
 | 
			
		||||
import org.gradle.api.tasks.JavaExec
 | 
			
		||||
import org.gradle.jvm.toolchain.JavaToolchainService
 | 
			
		||||
import java.nio.file.Files
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Set [JavaExec] task to run a given [RunConfig].
 | 
			
		||||
 */
 | 
			
		||||
fun JavaExec.setRunConfig(config: RunConfig) {
 | 
			
		||||
    dependsOn("prepareRuns")
 | 
			
		||||
    setRunConfigInternal(project, this, config)
 | 
			
		||||
    doFirst("Create working directory") { Files.createDirectories(workingDir.toPath()) }
 | 
			
		||||
 | 
			
		||||
    javaLauncher.set(
 | 
			
		||||
        project.extensions.getByType(JavaToolchainService::class.java)
 | 
			
		||||
            .launcherFor(project.extensions.getByType(JavaPluginExtension::class.java).toolchain),
 | 
			
		||||
    )
 | 
			
		||||
}
 | 
			
		||||
@@ -25,7 +25,6 @@ import javax.xml.xpath.XPathFactory
 | 
			
		||||
 * Would be good to PR some (or all) of these changes upstream at some point.
 | 
			
		||||
 *
 | 
			
		||||
 * @see net.fabricmc.loom.configuration.ide.idea.IdeaSyncTask
 | 
			
		||||
 * @see net.minecraftforge.gradle.common.util.runs.IntellijRunGenerator
 | 
			
		||||
 */
 | 
			
		||||
internal class IdeaRunConfigurations(project: Project) {
 | 
			
		||||
    private val rootProject = project.rootProject
 | 
			
		||||
@@ -35,22 +34,6 @@ internal class IdeaRunConfigurations(project: Project) {
 | 
			
		||||
    private val writer = TransformerFactory.newInstance().newTransformer()
 | 
			
		||||
 | 
			
		||||
    private val ideaDir = rootProject.file(".idea/")
 | 
			
		||||
    private val buildDir: Lazy<String?> = lazy {
 | 
			
		||||
        val ideaMisc = ideaDir.resolve("misc.xml")
 | 
			
		||||
 | 
			
		||||
        try {
 | 
			
		||||
            val doc = Files.newBufferedReader(ideaMisc.toPath()).use {
 | 
			
		||||
                documentBuilder.parse(InputSource(it))
 | 
			
		||||
            }
 | 
			
		||||
            val node =
 | 
			
		||||
                xpath.evaluate("//component[@name=\"ProjectRootManager\"]/output", doc, XPathConstants.NODE) as Node
 | 
			
		||||
            val attr = node.attributes.getNamedItem("url") as Attr
 | 
			
		||||
            attr.value.removePrefix("file://")
 | 
			
		||||
        } catch (e: Exception) {
 | 
			
		||||
            LOGGER.error("Failed to find root directory", e)
 | 
			
		||||
            null
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    fun patch() = synchronized(LOCK) {
 | 
			
		||||
        val runConfigDir = ideaDir.resolve("runConfigurations")
 | 
			
		||||
@@ -58,10 +41,9 @@ internal class IdeaRunConfigurations(project: Project) {
 | 
			
		||||
 | 
			
		||||
        Files.list(runConfigDir.toPath()).use {
 | 
			
		||||
            for (configuration in it) {
 | 
			
		||||
                val filename = configuration.fileName.toString();
 | 
			
		||||
                val filename = configuration.fileName.toString()
 | 
			
		||||
                when {
 | 
			
		||||
                    filename.endsWith("_fabric.xml") -> patchFabric(configuration)
 | 
			
		||||
                    filename.startsWith("forge_") && filename.endsWith(".xml") -> patchForge(configuration)
 | 
			
		||||
                    else -> {}
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
@@ -72,65 +54,6 @@ internal class IdeaRunConfigurations(project: Project) {
 | 
			
		||||
        setXml("//configuration", "folderName") { "Fabric" }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private fun patchForge(path: Path) = withXml(path) {
 | 
			
		||||
        val configId = path.fileName.toString().removePrefix("forge_").removeSuffix(".xml")
 | 
			
		||||
        val sourceSet = forgeConfigs[configId]
 | 
			
		||||
        if (sourceSet == null) {
 | 
			
		||||
            LOGGER.error("[{}] Cannot map run configuration to a known source set", path)
 | 
			
		||||
            return@withXml
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        setXml("//configuration", "folderName") { "Forge" }
 | 
			
		||||
        setXml("//configuration/module", "name") { "${rootProject.name}.forge.$sourceSet" }
 | 
			
		||||
 | 
			
		||||
        if (buildDir.value == null) return@withXml
 | 
			
		||||
        setXml("//configuration/envs/env[@name=\"MOD_CLASSES\"]", "value") { classpath ->
 | 
			
		||||
            val classes = classpath!!.split(':')
 | 
			
		||||
            val newClasses = mutableListOf<String>()
 | 
			
		||||
            fun appendUnique(x: String) {
 | 
			
		||||
                if (!newClasses.contains(x)) newClasses.add(x)
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            for (entry in classes) {
 | 
			
		||||
                if (!entry.contains("/out/")) {
 | 
			
		||||
                    appendUnique(entry)
 | 
			
		||||
                    continue
 | 
			
		||||
                }
 | 
			
		||||
 | 
			
		||||
                val match = CLASSPATH_ENTRY.matchEntire(entry)
 | 
			
		||||
                if (match != null) {
 | 
			
		||||
                    val modId = match.groups["modId"]!!.value
 | 
			
		||||
                    val proj = match.groups["proj"]!!.value
 | 
			
		||||
                    var component = match.groups["component"]!!.value
 | 
			
		||||
                    if (component == "production") component = "main"
 | 
			
		||||
 | 
			
		||||
                    appendUnique(forgeModEntry(modId, proj, component))
 | 
			
		||||
                } else {
 | 
			
		||||
                    LOGGER.warn("[{}] Unknown classpath entry {}", path, entry)
 | 
			
		||||
                    appendUnique(entry)
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Ensure common code is on the classpath
 | 
			
		||||
            for (proj in listOf("common", "common-api")) {
 | 
			
		||||
                for (component in listOf("main", "client")) {
 | 
			
		||||
                    appendUnique(forgeModEntry("computercraft", proj, component))
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            if (newClasses.any { it.startsWith("cctest%%") }) {
 | 
			
		||||
                appendUnique(forgeModEntry("cctest", "core", "testFixtures"))
 | 
			
		||||
                appendUnique(forgeModEntry("cctest", "common", "testFixtures"))
 | 
			
		||||
                appendUnique(forgeModEntry("cctest", "common", "testMod"))
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            newClasses.joinToString(":")
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private fun forgeModEntry(mod: String, project: String, component: String) =
 | 
			
		||||
        "$mod%%${buildDir.value}/production/${rootProject.name}.$project.$component"
 | 
			
		||||
 | 
			
		||||
    private fun LocatedDocument.setXml(xpath: String, attribute: String, value: (String?) -> String) {
 | 
			
		||||
        val node = this@IdeaRunConfigurations.xpath.evaluate(xpath, document, XPathConstants.NODE) as Node?
 | 
			
		||||
        if (node == null) {
 | 
			
		||||
@@ -159,16 +82,5 @@ internal class IdeaRunConfigurations(project: Project) {
 | 
			
		||||
    companion object {
 | 
			
		||||
        private val LOGGER = Logging.getLogger(IdeaRunConfigurations::class.java)
 | 
			
		||||
        private val LOCK = Any()
 | 
			
		||||
 | 
			
		||||
        private val CLASSPATH_ENTRY =
 | 
			
		||||
            Regex("(?<modId>[a-z]+)%%\\\$PROJECT_DIR\\\$/projects/(?<proj>[a-z-]+)/out/(?<component>\\w+)/(?<type>[a-z]+)\$")
 | 
			
		||||
 | 
			
		||||
        private val forgeConfigs = mapOf(
 | 
			
		||||
            "runClient" to "client",
 | 
			
		||||
            "runData" to "main",
 | 
			
		||||
            "runGameTestServer" to "testMod",
 | 
			
		||||
            "runServer" to "main",
 | 
			
		||||
            "runTestClient" to "testMod",
 | 
			
		||||
        )
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -1,73 +0,0 @@
 | 
			
		||||
// SPDX-FileCopyrightText: 2022 The CC: Tweaked Developers
 | 
			
		||||
//
 | 
			
		||||
// SPDX-License-Identifier: MPL-2.0
 | 
			
		||||
 | 
			
		||||
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
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * A dependency in a POM file.
 | 
			
		||||
 */
 | 
			
		||||
data class MavenDependency(val groupId: String?, val artifactId: String?, val version: String?, val scope: String?)
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * A spec specifying which dependencies to include/exclude.
 | 
			
		||||
 */
 | 
			
		||||
class MavenDependencySpec {
 | 
			
		||||
    private val excludeSpecs = mutableListOf<Spec<MavenDependency>>()
 | 
			
		||||
 | 
			
		||||
    fun exclude(spec: Spec<MavenDependency>) {
 | 
			
		||||
        excludeSpecs.add(spec)
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    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) &&
 | 
			
		||||
                (name.isNullOrEmpty() || name == it.artifactId) &&
 | 
			
		||||
                (dep.version.isNullOrEmpty() || dep.version == it.version)
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    fun exclude(dep: MinimalExternalModuleDependency) {
 | 
			
		||||
        exclude {
 | 
			
		||||
            dep.module.group == it.groupId && dep.module.name == it.artifactId
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    fun isIncluded(dep: MavenDependency) = !excludeSpecs.any { it.isSatisfiedBy(dep) }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Configure dependencies present in this publication's POM file.
 | 
			
		||||
 *
 | 
			
		||||
 * While this approach is very ugly, it's the easiest way to handle it!
 | 
			
		||||
 */
 | 
			
		||||
fun MavenPublication.mavenDependencies(action: MavenDependencySpec.() -> Unit) {
 | 
			
		||||
    val spec = MavenDependencySpec()
 | 
			
		||||
    action(spec)
 | 
			
		||||
 | 
			
		||||
    pom.withXml {
 | 
			
		||||
        val dependencies = XmlUtil.findChild(asNode(), "dependencies") ?: return@withXml
 | 
			
		||||
        dependencies.children().map { it as groovy.util.Node }.forEach {
 | 
			
		||||
            val dep = MavenDependency(
 | 
			
		||||
                groupId = XmlUtil.findChild(it, "groupId")?.text(),
 | 
			
		||||
                artifactId = XmlUtil.findChild(it, "artifactId")?.text(),
 | 
			
		||||
                version = XmlUtil.findChild(it, "version")?.text(),
 | 
			
		||||
                scope = XmlUtil.findChild(it, "scope")?.text(),
 | 
			
		||||
            )
 | 
			
		||||
 | 
			
		||||
            if (!spec.isIncluded(dep)) it.parent().remove(it)
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -24,7 +24,6 @@ class MinecraftConfigurations private constructor(private val project: Project)
 | 
			
		||||
    private val java = project.extensions.getByType(JavaPluginExtension::class.java)
 | 
			
		||||
    private val sourceSets = java.sourceSets
 | 
			
		||||
    private val configurations = project.configurations
 | 
			
		||||
    private val objects = project.objects
 | 
			
		||||
 | 
			
		||||
    private val main = sourceSets[SourceSet.MAIN_SOURCE_SET_NAME]
 | 
			
		||||
    private val test = sourceSets[SourceSet.TEST_SOURCE_SET_NAME]
 | 
			
		||||
@@ -37,17 +36,10 @@ class MinecraftConfigurations private constructor(private val project: Project)
 | 
			
		||||
        val client = sourceSets.maybeCreate("client")
 | 
			
		||||
 | 
			
		||||
        // Ensure the client classpaths behave the same as the main ones.
 | 
			
		||||
        configurations.named(client.compileClasspathConfigurationName) {
 | 
			
		||||
            shouldResolveConsistentlyWith(configurations[main.compileClasspathConfigurationName])
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        configurations.named(client.runtimeClasspathConfigurationName) {
 | 
			
		||||
            shouldResolveConsistentlyWith(configurations[main.runtimeClasspathConfigurationName])
 | 
			
		||||
        }
 | 
			
		||||
        consistentWithMain(client)
 | 
			
		||||
 | 
			
		||||
        // Set up an API configuration for clients (to ensure it's consistent with the main source set).
 | 
			
		||||
        val clientApi = configurations.maybeCreate(client.apiConfigurationName).apply {
 | 
			
		||||
            isVisible = false
 | 
			
		||||
            isCanBeConsumed = false
 | 
			
		||||
            isCanBeResolved = false
 | 
			
		||||
        }
 | 
			
		||||
@@ -85,6 +77,16 @@ class MinecraftConfigurations private constructor(private val project: Project)
 | 
			
		||||
        setupBasic()
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private fun consistentWithMain(sourceSet: SourceSet) {
 | 
			
		||||
        configurations.named(sourceSet.compileClasspathConfigurationName) {
 | 
			
		||||
            shouldResolveConsistentlyWith(configurations[main.compileClasspathConfigurationName])
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        configurations.named(sourceSet.runtimeClasspathConfigurationName) {
 | 
			
		||||
            shouldResolveConsistentlyWith(configurations[main.runtimeClasspathConfigurationName])
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private fun setupBasic() {
 | 
			
		||||
        val client = sourceSets["client"]
 | 
			
		||||
 | 
			
		||||
@@ -96,13 +98,30 @@ class MinecraftConfigurations private constructor(private val project: 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))
 | 
			
		||||
                configuration(configurations.named(main.runtimeClasspathConfigurationName))
 | 
			
		||||
                configuration(configurations.named(client.runtimeClasspathConfigurationName))
 | 
			
		||||
            }
 | 
			
		||||
        project.tasks.named("check") { dependsOn(checkDependencyConsistency) }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Create a new configuration that pulls in the main and client classes from the mod.
 | 
			
		||||
     */
 | 
			
		||||
    private fun createDerivedConfiguration(name: String) {
 | 
			
		||||
        val client = sourceSets["client"]
 | 
			
		||||
        val sourceSet = sourceSets.create(name)
 | 
			
		||||
        sourceSet.compileClasspath += main.compileClasspath + client.compileClasspath
 | 
			
		||||
        sourceSet.runtimeClasspath += main.runtimeClasspath + client.runtimeClasspath
 | 
			
		||||
        consistentWithMain(sourceSet)
 | 
			
		||||
        project.dependencies.add(sourceSet.implementationConfigurationName, main.output)
 | 
			
		||||
        project.dependencies.add(sourceSet.implementationConfigurationName, client.output)
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    companion object {
 | 
			
		||||
        const val DATAGEN = "datagen"
 | 
			
		||||
        const val EXAMPLES = "examples"
 | 
			
		||||
        const val TEST_MOD = "testMod"
 | 
			
		||||
 | 
			
		||||
        fun setupBasic(project: Project) {
 | 
			
		||||
            MinecraftConfigurations(project).setupBasic()
 | 
			
		||||
        }
 | 
			
		||||
@@ -110,6 +129,10 @@ class MinecraftConfigurations private constructor(private val project: Project)
 | 
			
		||||
        fun setup(project: Project) {
 | 
			
		||||
            MinecraftConfigurations(project).setup()
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        fun createDerivedConfiguration(project: Project, name: String) {
 | 
			
		||||
            MinecraftConfigurations(project).createDerivedConfiguration(name)
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -4,7 +4,7 @@
 | 
			
		||||
 | 
			
		||||
package cc.tweaked.gradle
 | 
			
		||||
 | 
			
		||||
import net.minecraftforge.gradle.common.util.RunConfig
 | 
			
		||||
import net.neoforged.moddevgradle.internal.RunGameTask
 | 
			
		||||
import org.gradle.api.GradleException
 | 
			
		||||
import org.gradle.api.file.FileSystemOperations
 | 
			
		||||
import org.gradle.api.invocation.Gradle
 | 
			
		||||
@@ -65,11 +65,19 @@ abstract class ClientJavaExec : JavaExec() {
 | 
			
		||||
        setTestProperties()
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    fun copyFromForge(path: String) = copyFromForge(project.tasks.getByName(path, RunGameTask::class))
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Set this task to run a given [RunConfig].
 | 
			
		||||
     * Set this task to run a given [RunGameTask].
 | 
			
		||||
     */
 | 
			
		||||
    fun setRunConfig(config: RunConfig) {
 | 
			
		||||
        (this as JavaExec).setRunConfig(config)
 | 
			
		||||
    fun copyFromForge(task: RunGameTask) {
 | 
			
		||||
        copyFrom(task)
 | 
			
		||||
 | 
			
		||||
        // Eagerly evaluate the behaviour of RunGameTask.exec
 | 
			
		||||
        environment.putAll(task.environmentProperty.get())
 | 
			
		||||
        classpath(task.classpathProvider)
 | 
			
		||||
        workingDir = task.gameDirectory.get().asFile
 | 
			
		||||
 | 
			
		||||
        setTestProperties() // setRunConfig may clobber some properties, ensure everything is set.
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -11,7 +11,9 @@ import org.gradle.api.file.Directory
 | 
			
		||||
import org.gradle.api.file.DirectoryProperty
 | 
			
		||||
import org.gradle.api.provider.Provider
 | 
			
		||||
import org.gradle.api.tasks.*
 | 
			
		||||
import org.gradle.process.ExecOperations
 | 
			
		||||
import java.io.File
 | 
			
		||||
import javax.inject.Inject
 | 
			
		||||
 | 
			
		||||
class NodePlugin : Plugin<Project> {
 | 
			
		||||
    override fun apply(project: Project) {
 | 
			
		||||
@@ -43,9 +45,12 @@ abstract class NpmInstall : DefaultTask() {
 | 
			
		||||
    @get:OutputDirectory
 | 
			
		||||
    val nodeModules: Provider<Directory> = projectRoot.dir("node_modules")
 | 
			
		||||
 | 
			
		||||
    @get:Inject
 | 
			
		||||
    protected abstract val execOperations: ExecOperations
 | 
			
		||||
 | 
			
		||||
    @TaskAction
 | 
			
		||||
    fun install() {
 | 
			
		||||
        project.exec {
 | 
			
		||||
        execOperations.exec {
 | 
			
		||||
            commandLine(ProcessHelpers.getExecutable("npm"), "ci")
 | 
			
		||||
            workingDir = projectRoot.get().asFile
 | 
			
		||||
        }
 | 
			
		||||
 
 | 
			
		||||
@@ -4,45 +4,10 @@
 | 
			
		||||
 | 
			
		||||
package cc.tweaked.gradle
 | 
			
		||||
 | 
			
		||||
import org.codehaus.groovy.runtime.ProcessGroovyMethods
 | 
			
		||||
import org.gradle.api.GradleException
 | 
			
		||||
import java.io.BufferedReader
 | 
			
		||||
import java.io.File
 | 
			
		||||
import java.io.InputStreamReader
 | 
			
		||||
import java.nio.charset.StandardCharsets
 | 
			
		||||
 | 
			
		||||
internal object ProcessHelpers {
 | 
			
		||||
    fun startProcess(vararg command: String): Process {
 | 
			
		||||
        // Something randomly passes in "GIT_DIR=" as an environment variable which clobbers everything else. Don't
 | 
			
		||||
        // inherit the environment array!
 | 
			
		||||
        return ProcessBuilder()
 | 
			
		||||
            .command(*command)
 | 
			
		||||
            .redirectError(ProcessBuilder.Redirect.INHERIT)
 | 
			
		||||
            .also { it.environment().clear() }
 | 
			
		||||
            .start()
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    fun captureOut(vararg command: String): String {
 | 
			
		||||
        val process = startProcess(*command)
 | 
			
		||||
        process.outputStream.close()
 | 
			
		||||
 | 
			
		||||
        val result = ProcessGroovyMethods.getText(process)
 | 
			
		||||
        process.waitForOrThrow("Failed to run command")
 | 
			
		||||
        return result
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    fun captureLines(vararg command: String): List<String> {
 | 
			
		||||
        val process = startProcess(*command)
 | 
			
		||||
        process.outputStream.close()
 | 
			
		||||
 | 
			
		||||
        val out = BufferedReader(InputStreamReader(process.inputStream, StandardCharsets.UTF_8)).use { reader ->
 | 
			
		||||
            reader.lines().filter { it.isNotEmpty() }.toList()
 | 
			
		||||
        }
 | 
			
		||||
        ProcessGroovyMethods.closeStreams(process)
 | 
			
		||||
        process.waitForOrThrow("Failed to run command")
 | 
			
		||||
        return out
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    fun onPath(name: String): Boolean {
 | 
			
		||||
        val path = System.getenv("PATH") ?: return false
 | 
			
		||||
        return path.splitToSequence(File.pathSeparator).any { File(it, name).exists() }
 | 
			
		||||
 
 | 
			
		||||
@@ -1,16 +0,0 @@
 | 
			
		||||
// SPDX-FileCopyrightText: 2022 The CC: Tweaked Developers
 | 
			
		||||
//
 | 
			
		||||
// SPDX-License-Identifier: MPL-2.0
 | 
			
		||||
 | 
			
		||||
package cc.tweaked.gradle
 | 
			
		||||
 | 
			
		||||
import groovy.util.Node
 | 
			
		||||
import groovy.util.NodeList
 | 
			
		||||
 | 
			
		||||
object XmlUtil {
 | 
			
		||||
    fun findChild(node: Node, name: String): Node? = when (val child = node.get(name)) {
 | 
			
		||||
        is Node -> child
 | 
			
		||||
        is NodeList -> child.singleOrNull() as Node?
 | 
			
		||||
        else -> null
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -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))
 | 
			
		||||
}
 | 
			
		||||
@@ -92,7 +92,10 @@ SPDX-License-Identifier: MPL-2.0
 | 
			
		||||
        <module name="InvalidJavadocPosition" />
 | 
			
		||||
        <module name="JavadocBlockTagLocation" />
 | 
			
		||||
        <module name="JavadocMethod"/>
 | 
			
		||||
        <module name="JavadocType"/>
 | 
			
		||||
        <module name="JavadocType">
 | 
			
		||||
            <!-- Seems to complain about @hidden!? -->
 | 
			
		||||
            <property name="allowUnknownTags" value="true" />
 | 
			
		||||
        </module>
 | 
			
		||||
        <module name="JavadocStyle">
 | 
			
		||||
            <property name="checkHtml" value="false" />
 | 
			
		||||
        </module>
 | 
			
		||||
@@ -124,7 +127,7 @@ SPDX-License-Identifier: MPL-2.0
 | 
			
		||||
        </module>
 | 
			
		||||
        <module name="MethodTypeParameterName" />
 | 
			
		||||
        <module name="PackageName">
 | 
			
		||||
            <property name="format" value="^(dan200\.computercraft|cc\.tweaked)(\.[a-z][a-z0-9]*)*" />
 | 
			
		||||
            <property name="format" value="^(dan200\.computercraft|cc\.tweaked|com\.example\.examplemod)(\.[a-z][a-z0-9]*)*" />
 | 
			
		||||
        </module>
 | 
			
		||||
        <module name="ParameterName" />
 | 
			
		||||
        <module name="StaticVariableName">
 | 
			
		||||
@@ -143,7 +146,10 @@ SPDX-License-Identifier: MPL-2.0
 | 
			
		||||
        <module name="NoWhitespaceAfter">
 | 
			
		||||
            <property name="tokens" value="AT,INC,DEC,UNARY_MINUS,UNARY_PLUS,BNOT,LNOT,DOT,ARRAY_DECLARATOR,INDEX_OP,METHOD_REF" />
 | 
			
		||||
        </module>
 | 
			
		||||
        <module name="NoWhitespaceBefore" />
 | 
			
		||||
        <module name="NoWhitespaceBefore">
 | 
			
		||||
            <!-- Allow whitespace before "..." for @Nullable annotations -->
 | 
			
		||||
            <property name="tokens" value="COMMA,SEMI,POST_INC,POST_DEC,LABELED_STAT" />
 | 
			
		||||
        </module>
 | 
			
		||||
        <!-- TODO: Decide on an OperatorWrap style. -->
 | 
			
		||||
        <module name="ParenPad" />
 | 
			
		||||
        <module name="SeparatorWrap">
 | 
			
		||||
 
 | 
			
		||||
@@ -12,6 +12,7 @@ files:
 | 
			
		||||
        de: de_de    # German
 | 
			
		||||
        es-ES: es_es # Spanish
 | 
			
		||||
        fr: fr_fr    # French
 | 
			
		||||
        hu: hu_hu    # Hungarian
 | 
			
		||||
        it: it_it    # Italian
 | 
			
		||||
        ja: ja_jp    # Japanese
 | 
			
		||||
        ko: ko_kr    # Korean
 | 
			
		||||
 
 | 
			
		||||
@@ -8,7 +8,7 @@ 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][`monitor`] size is changed.
 | 
			
		||||
 | 
			
		||||
## Return Values
 | 
			
		||||
1. [`string`]: The event name.
 | 
			
		||||
 
 | 
			
		||||
@@ -8,7 +8,7 @@ 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][`monitor`] is right-clicked.
 | 
			
		||||
 | 
			
		||||
## Return Values
 | 
			
		||||
1. [`string`]: The event name.
 | 
			
		||||
 
 | 
			
		||||
@@ -10,7 +10,7 @@ kotlin.jvm.target.validation.mode=error
 | 
			
		||||
 | 
			
		||||
# Mod properties
 | 
			
		||||
isUnstable=false
 | 
			
		||||
modVersion=1.114.1
 | 
			
		||||
modVersion=1.116.2
 | 
			
		||||
 | 
			
		||||
# Minecraft properties: We want to configure this here so we can read it in settings.gradle
 | 
			
		||||
mcVersion=1.20.1
 | 
			
		||||
 
 | 
			
		||||
@@ -1,2 +1,2 @@
 | 
			
		||||
#This file is generated by updateDaemonJvm
 | 
			
		||||
toolchainVersion=17
 | 
			
		||||
toolchainVersion=21
 | 
			
		||||
 
 | 
			
		||||
@@ -23,17 +23,17 @@ netty = "4.1.82.Final"
 | 
			
		||||
slf4j = "2.0.1"
 | 
			
		||||
 | 
			
		||||
# Core dependencies (independent of Minecraft)
 | 
			
		||||
asm = "9.6"
 | 
			
		||||
asm = "9.9"
 | 
			
		||||
autoService = "1.1.1"
 | 
			
		||||
checkerFramework = "3.42.0"
 | 
			
		||||
cobalt = { strictly = "0.9.5" }
 | 
			
		||||
commonsCli = "1.6.0"
 | 
			
		||||
jetbrainsAnnotations = "24.1.0"
 | 
			
		||||
jsr305 = "3.0.2"
 | 
			
		||||
checkerFramework = "3.51.1"
 | 
			
		||||
cobalt = { strictly = "0.9.7" }
 | 
			
		||||
commonsCli = "1.10.0"
 | 
			
		||||
jetbrainsAnnotations = "26.0.2-1"
 | 
			
		||||
jspecify = "1.0.0"
 | 
			
		||||
jzlib = "1.1.3"
 | 
			
		||||
kotlin = "1.9.21"
 | 
			
		||||
kotlin-coroutines = "1.7.3"
 | 
			
		||||
nightConfig = "3.6.7"
 | 
			
		||||
kotlin = "2.2.21"
 | 
			
		||||
kotlin-coroutines = "1.10.2"
 | 
			
		||||
nightConfig = "3.8.3"
 | 
			
		||||
 | 
			
		||||
# Minecraft mods
 | 
			
		||||
emi = "1.0.8+1.20.1"
 | 
			
		||||
@@ -46,36 +46,35 @@ oculus = "1.2.5"
 | 
			
		||||
rei = "12.0.626"
 | 
			
		||||
rubidium = "0.6.1"
 | 
			
		||||
sodium = "mc1.20-0.4.10"
 | 
			
		||||
create-forge = "0.5.1.f-33"
 | 
			
		||||
create-fabric = "0.5.1-f-build.1467+mc1.20.1"
 | 
			
		||||
create-forge = "6.0.0-9"
 | 
			
		||||
create-fabric = "6.0.7.0+mc1.20.1-build.1716"
 | 
			
		||||
 | 
			
		||||
# Testing
 | 
			
		||||
hamcrest = "2.2"
 | 
			
		||||
jqwik = "1.8.2"
 | 
			
		||||
junit = "5.10.1"
 | 
			
		||||
hamcrest = "3.0"
 | 
			
		||||
jqwik = "1.9.3"
 | 
			
		||||
junit = "6.0.1"
 | 
			
		||||
junitPlatform = "6.0.1"
 | 
			
		||||
jmh = "1.37"
 | 
			
		||||
 | 
			
		||||
# Build tools
 | 
			
		||||
cctJavadoc = "1.8.3"
 | 
			
		||||
checkstyle = "10.14.1"
 | 
			
		||||
errorProne-core = "2.27.0"
 | 
			
		||||
errorProne-plugin = "3.1.0"
 | 
			
		||||
fabric-loom = "1.7.1"
 | 
			
		||||
forgeGradle = "6.0.21"
 | 
			
		||||
cctJavadoc = "1.8.4"
 | 
			
		||||
checkstyle = "12.1.1"
 | 
			
		||||
errorProne-core = "2.43.0"
 | 
			
		||||
errorProne-plugin = "4.3.0"
 | 
			
		||||
fabric-loom = "1.12.3"
 | 
			
		||||
githubRelease = "2.5.2"
 | 
			
		||||
gradleVersions = "0.50.0"
 | 
			
		||||
ideaExt = "1.1.7"
 | 
			
		||||
illuaminate = "0.1.0-74-gf1551d5"
 | 
			
		||||
librarian = "1.+"
 | 
			
		||||
lwjgl = "3.3.3"
 | 
			
		||||
minotaur = "2.+"
 | 
			
		||||
nullAway = "0.10.25"
 | 
			
		||||
shadow = "8.3.1"
 | 
			
		||||
spotless = "6.23.3"
 | 
			
		||||
taskTree = "2.1.1"
 | 
			
		||||
teavm = "0.11.0-SQUID.1"
 | 
			
		||||
vanillaExtract = "0.1.3"
 | 
			
		||||
versionCatalogUpdate = "0.8.1"
 | 
			
		||||
gradleVersions = "0.53.0"
 | 
			
		||||
ideaExt = "1.3"
 | 
			
		||||
illuaminate = "0.1.0-83-g1131f68"
 | 
			
		||||
lwjgl = "3.3.6"
 | 
			
		||||
minotaur = "2.8.7"
 | 
			
		||||
modDevGradle = "2.0.116"
 | 
			
		||||
nullAway = "0.12.11"
 | 
			
		||||
shadow = "9.2.2"
 | 
			
		||||
spotless = "8.0.0"
 | 
			
		||||
teavm = "0.13.0-SQUID.2"
 | 
			
		||||
vanillaExtract = "0.2.1"
 | 
			
		||||
versionCatalogUpdate = "1.0.1"
 | 
			
		||||
 | 
			
		||||
[libraries]
 | 
			
		||||
# Normal dependencies
 | 
			
		||||
@@ -89,7 +88,7 @@ fastutil = { module = "it.unimi.dsi:fastutil", version.ref = "fastutil" }
 | 
			
		||||
forgeSpi = { module = "net.minecraftforge:forgespi", version.ref = "forgeSpi" }
 | 
			
		||||
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" }
 | 
			
		||||
jspecify = { module = "org.jspecify:jspecify", version.ref = "jspecify" }
 | 
			
		||||
jzlib = { module = "com.jcraft:jzlib", version.ref = "jzlib" }
 | 
			
		||||
kotlin-coroutines = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-core", version.ref = "kotlin-coroutines" }
 | 
			
		||||
kotlin-platform = { module = "org.jetbrains.kotlin:kotlin-bom", version.ref = "kotlin" }
 | 
			
		||||
@@ -131,6 +130,7 @@ jqwik-engine = { module = "net.jqwik:jqwik-engine", version.ref = "jqwik" }
 | 
			
		||||
junit-jupiter-api = { module = "org.junit.jupiter:junit-jupiter-api", version.ref = "junit" }
 | 
			
		||||
junit-jupiter-engine = { module = "org.junit.jupiter:junit-jupiter-engine", version.ref = "junit" }
 | 
			
		||||
junit-jupiter-params = { module = "org.junit.jupiter:junit-jupiter-params", version.ref = "junit" }
 | 
			
		||||
junit-platform-launcher = { module = "org.junit.platform:junit-platform-launcher", version.ref = "junitPlatform" }
 | 
			
		||||
slf4j-simple = { module = "org.slf4j:slf4j-simple", version.ref = "slf4j" }
 | 
			
		||||
jmh = { module = "org.openjdk.jmh:jmh-core", version.ref = "jmh" }
 | 
			
		||||
jmh-processor = { module = "org.openjdk.jmh:jmh-generator-annprocess", version.ref = "jmh" }
 | 
			
		||||
@@ -150,12 +150,11 @@ 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" }
 | 
			
		||||
nullAway = { module = "com.uber.nullaway:nullaway", version.ref = "nullAway" }
 | 
			
		||||
modDevGradle = { module = "net.neoforged:moddev-gradle", version.ref = "modDevGradle" }
 | 
			
		||||
spotless = { module = "com.diffplug.spotless:spotless-plugin-gradle", version.ref = "spotless" }
 | 
			
		||||
teavm-classlib = { module = "org.teavm:teavm-classlib", version.ref = "teavm" }
 | 
			
		||||
teavm-core = { module = "org.teavm:teavm-core", version.ref = "teavm" }
 | 
			
		||||
@@ -170,17 +169,14 @@ vanillaExtract = { module = "cc.tweaked.vanilla-extract:plugin", version.ref = "
 | 
			
		||||
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" }
 | 
			
		||||
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" }
 | 
			
		||||
shadow = { id = "com.gradleup.shadow", version.ref = "shadow" }
 | 
			
		||||
taskTree = { id = "com.dorongold.task-tree", version.ref = "taskTree" }
 | 
			
		||||
versionCatalogUpdate = { id = "nl.littlerobots.version-catalog-update", version.ref = "versionCatalogUpdate" }
 | 
			
		||||
 | 
			
		||||
[bundles]
 | 
			
		||||
annotations = ["jsr305", "checkerFramework", "jetbrainsAnnotations"]
 | 
			
		||||
annotations = ["checkerFramework", "jetbrainsAnnotations", "jspecify"]
 | 
			
		||||
kotlin = ["kotlin-stdlib", "kotlin-coroutines"]
 | 
			
		||||
 | 
			
		||||
# Minecraft
 | 
			
		||||
@@ -192,7 +188,7 @@ externalMods-fabric-runtime = ["jei-fabric", "modmenu"]
 | 
			
		||||
 | 
			
		||||
# Testing
 | 
			
		||||
test = ["junit-jupiter-api", "junit-jupiter-params", "hamcrest", "jqwik-api"]
 | 
			
		||||
testRuntime = ["junit-jupiter-engine", "jqwik-engine"]
 | 
			
		||||
testRuntime = ["junit-jupiter-engine", "junit-platform-launcher", "jqwik-engine"]
 | 
			
		||||
 | 
			
		||||
# Build tools
 | 
			
		||||
teavm-api = ["teavm-jso", "teavm-jso-apis", "teavm-platform", "teavm-classlib", "teavm-metaprogramming-api"]
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										2
									
								
								gradle/wrapper/gradle-wrapper.properties
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										2
									
								
								gradle/wrapper/gradle-wrapper.properties
									
									
									
									
										vendored
									
									
								
							@@ -1,6 +1,6 @@
 | 
			
		||||
distributionBase=GRADLE_USER_HOME
 | 
			
		||||
distributionPath=wrapper/dists
 | 
			
		||||
distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-bin.zip
 | 
			
		||||
distributionUrl=https\://services.gradle.org/distributions/gradle-9.2.0-bin.zip
 | 
			
		||||
networkTimeout=10000
 | 
			
		||||
validateDistributionUrl=true
 | 
			
		||||
zipStoreBase=GRADLE_USER_HOME
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										3
									
								
								gradlew
									
									
									
									
										vendored
									
									
								
							
							
						
						
									
										3
									
								
								gradlew
									
									
									
									
										vendored
									
									
								
							@@ -86,8 +86,7 @@ done
 | 
			
		||||
# shellcheck disable=SC2034
 | 
			
		||||
APP_BASE_NAME=${0##*/}
 | 
			
		||||
# Discard cd standard output in case $CDPATH is set (https://github.com/gradle/gradle/issues/25036)
 | 
			
		||||
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s
 | 
			
		||||
' "$PWD" ) || exit
 | 
			
		||||
APP_HOME=$( cd -P "${APP_HOME:-./}" > /dev/null && printf '%s\n' "$PWD" ) || exit
 | 
			
		||||
 | 
			
		||||
# Use the maximum available, or set MAX_FD != -1 to use that value.
 | 
			
		||||
MAX_FD=maximum
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										1064
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
							
						
						
									
										1064
									
								
								package-lock.json
									
									
									
										generated
									
									
									
								
							
										
											
												File diff suppressed because it is too large
												Load Diff
											
										
									
								
							@@ -12,11 +12,11 @@
 | 
			
		||||
    "tslib": "^2.0.3"
 | 
			
		||||
  },
 | 
			
		||||
  "devDependencies": {
 | 
			
		||||
    "@rollup/plugin-node-resolve": "^15.2.1",
 | 
			
		||||
    "@rollup/plugin-node-resolve": "^16.0.0",
 | 
			
		||||
    "@rollup/plugin-typescript": "^12.0.0",
 | 
			
		||||
    "@rollup/plugin-url": "^8.0.1",
 | 
			
		||||
    "@swc/core": "^1.3.92",
 | 
			
		||||
    "@types/node": "^22.0.0",
 | 
			
		||||
    "@types/node": "^24.0.0",
 | 
			
		||||
    "lightningcss": "^1.22.0",
 | 
			
		||||
    "preact-render-to-string": "^6.2.1",
 | 
			
		||||
    "rehype": "^13.0.0",
 | 
			
		||||
 
 | 
			
		||||
@@ -18,13 +18,28 @@ dependencies {
 | 
			
		||||
    api(project(":core-api"))
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
val javadocOverview by tasks.registering(Copy::class) {
 | 
			
		||||
    from("src/overview.html")
 | 
			
		||||
    into(layout.buildDirectory.dir(name))
 | 
			
		||||
 | 
			
		||||
    expand(
 | 
			
		||||
        mapOf(
 | 
			
		||||
            "mcVersion" to mcVersion,
 | 
			
		||||
            "modVersion" to version,
 | 
			
		||||
        ),
 | 
			
		||||
    )
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
tasks.javadoc {
 | 
			
		||||
    title = "CC: Tweaked $version Minecraft $mcVersion"
 | 
			
		||||
    title = "CC: Tweaked $version for Minecraft $mcVersion"
 | 
			
		||||
    include("dan200/computercraft/api/**/*.java")
 | 
			
		||||
 | 
			
		||||
    options {
 | 
			
		||||
        (this as StandardJavadocDocletOptions)
 | 
			
		||||
 | 
			
		||||
        inputs.files(javadocOverview)
 | 
			
		||||
        overview(javadocOverview.get().destinationDir.resolve("overview.html").absolutePath)
 | 
			
		||||
 | 
			
		||||
        groups = mapOf(
 | 
			
		||||
            "Common" to listOf(
 | 
			
		||||
                "dan200.computercraft.api",
 | 
			
		||||
@@ -47,8 +62,26 @@ tasks.javadoc {
 | 
			
		||||
            <link href=" https://cdn.jsdelivr.net/npm/prismjs@1.29.0/themes/prism.min.css " rel="stylesheet">
 | 
			
		||||
            """.trimIndent(),
 | 
			
		||||
        )
 | 
			
		||||
 | 
			
		||||
        val snippetSources = listOf(":common", ":fabric", ":forge").flatMap {
 | 
			
		||||
            project(it).sourceSets["examples"].allSource.sourceDirectories
 | 
			
		||||
        }
 | 
			
		||||
        inputs.files(snippetSources)
 | 
			
		||||
        addPathOption("-snippet-path").value = snippetSources
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Include the core-api in our javadoc export. This is wrong, but it means we can export a single javadoc dump.
 | 
			
		||||
    source(project(":core-api").sourceSets.main.map { it.allJava })
 | 
			
		||||
 | 
			
		||||
    options {
 | 
			
		||||
        this as StandardJavadocDocletOptions
 | 
			
		||||
        addBooleanOption("-allow-script-in-comments", true)
 | 
			
		||||
        bottom(
 | 
			
		||||
            """
 | 
			
		||||
            <script src="https://cdn.jsdelivr.net/npm/prismjs@v1.29.0/components/prism-core.min.js"></script>
 | 
			
		||||
            <script src="https://cdn.jsdelivr.net/npm/prismjs@v1.29.0/plugins/autoloader/prism-autoloader.min.js"></script>
 | 
			
		||||
            <link href=" https://cdn.jsdelivr.net/npm/prismjs@1.29.0/themes/prism.min.css " rel="stylesheet">
 | 
			
		||||
            """.trimIndent(),
 | 
			
		||||
        )
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -12,8 +12,8 @@ import net.minecraft.client.resources.model.ModelResourceLocation;
 | 
			
		||||
import net.minecraft.client.resources.model.UnbakedModel;
 | 
			
		||||
import net.minecraft.nbt.CompoundTag;
 | 
			
		||||
import net.minecraft.resources.ResourceLocation;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.Collection;
 | 
			
		||||
import java.util.List;
 | 
			
		||||
 | 
			
		||||
@@ -22,7 +22,14 @@ import java.util.List;
 | 
			
		||||
 * <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
 | 
			
		||||
 * on Forge.
 | 
			
		||||
 *
 | 
			
		||||
 * <h2>Example</h2>
 | 
			
		||||
 * <h3>Fabric</h3>
 | 
			
		||||
 * {@snippet class=com.example.examplemod.FabricExampleModClient region=turtle_modellers}
 | 
			
		||||
 *
 | 
			
		||||
 * <h3>Forge</h3>
 | 
			
		||||
 * {@snippet class=com.example.examplemod.FabricExampleModClient region=turtle_modellers}
 | 
			
		||||
 *
 | 
			
		||||
 * @param <T> The type of turtle upgrade this modeller applies to.
 | 
			
		||||
 * @see RegisterTurtleUpgradeModeller For multi-loader registration support.
 | 
			
		||||
 
 | 
			
		||||
@@ -14,8 +14,7 @@ import net.minecraft.client.Minecraft;
 | 
			
		||||
import net.minecraft.nbt.CompoundTag;
 | 
			
		||||
import net.minecraft.world.item.ItemStack;
 | 
			
		||||
import org.joml.Matrix4f;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
final class TurtleUpgradeModellers {
 | 
			
		||||
    private static final Transformation leftTransform = getMatrixFor(-0.4065f);
 | 
			
		||||
 
 | 
			
		||||
@@ -11,8 +11,7 @@ import net.minecraft.client.resources.model.ModelManager;
 | 
			
		||||
import net.minecraft.client.resources.model.ModelResourceLocation;
 | 
			
		||||
import net.minecraft.resources.ResourceLocation;
 | 
			
		||||
import org.jetbrains.annotations.ApiStatus;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
@ApiStatus.Internal
 | 
			
		||||
public interface ClientPlatformHelper {
 | 
			
		||||
 
 | 
			
		||||
@@ -10,8 +10,7 @@ import dan200.computercraft.api.turtle.ITurtleUpgrade;
 | 
			
		||||
import dan200.computercraft.api.turtle.TurtleUpgradeSerialiser;
 | 
			
		||||
import dan200.computercraft.impl.Services;
 | 
			
		||||
import org.jetbrains.annotations.ApiStatus;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Backing interface for {@link ComputerCraftAPIClient}
 | 
			
		||||
 
 | 
			
		||||
@@ -26,8 +26,7 @@ import net.minecraft.core.Direction;
 | 
			
		||||
import net.minecraft.server.MinecraftServer;
 | 
			
		||||
import net.minecraft.world.item.ItemStack;
 | 
			
		||||
import net.minecraft.world.level.Level;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * The static entry point to the ComputerCraft API.
 | 
			
		||||
@@ -171,16 +170,9 @@ public final class ComputerCraftAPI {
 | 
			
		||||
     * using {@link ILuaAPI#getModuleName()} to expose this library as a module instead of as a global.
 | 
			
		||||
     * <p>
 | 
			
		||||
     * This may be used with {@link IComputerSystem#getComponent(ComputerComponent)} to only attach APIs to specific
 | 
			
		||||
     * computers. For example, one can add an additional API just to turtles with the following code:
 | 
			
		||||
     * computers. For example, one can add a new API just to turtles with the following code:
 | 
			
		||||
     *
 | 
			
		||||
     * <pre class="language language-java">{@code
 | 
			
		||||
     * ComputerCraftAPI.registerAPIFactory(computer -> {
 | 
			
		||||
     *   // Read the turtle component.
 | 
			
		||||
     *   var turtle = computer.getComponent(ComputerComponents.TURTLE);
 | 
			
		||||
     *   // If present then add our API.
 | 
			
		||||
     *   return turtle == null ? null : new MyCustomTurtleApi(turtle);
 | 
			
		||||
     * });
 | 
			
		||||
     * }</pre>
 | 
			
		||||
     * {@snippet class=com.example.examplemod.ExampleAPI region=register}
 | 
			
		||||
     *
 | 
			
		||||
     * @param factory The factory for your API subclass.
 | 
			
		||||
     * @see ILuaAPIFactory
 | 
			
		||||
 
 | 
			
		||||
@@ -26,6 +26,20 @@ public class ComputerCraftTags {
 | 
			
		||||
        public static final TagKey<Item> WIRED_MODEM = make("wired_modem");
 | 
			
		||||
        public static final TagKey<Item> MONITOR = make("monitor");
 | 
			
		||||
 | 
			
		||||
        /**
 | 
			
		||||
         * Floppy disks. Both the read/write version, and treasure disks.
 | 
			
		||||
         *
 | 
			
		||||
         * @since 1.116.0
 | 
			
		||||
         */
 | 
			
		||||
        public static final TagKey<Item> DISKS = make("disks");
 | 
			
		||||
 | 
			
		||||
        /**
 | 
			
		||||
         * All pocket computers.
 | 
			
		||||
         *
 | 
			
		||||
         * @since 1.116.0
 | 
			
		||||
         */
 | 
			
		||||
        public static final TagKey<Item> POCKET_COMPUTERS = make("pocket_computers");
 | 
			
		||||
 | 
			
		||||
        /**
 | 
			
		||||
         * Items which can be {@linkplain Item#use(Level, Player, InteractionHand) used} when calling
 | 
			
		||||
         * {@code turtle.place()}.
 | 
			
		||||
 
 | 
			
		||||
@@ -6,8 +6,8 @@ package dan200.computercraft.api.detail;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.world.item.Item;
 | 
			
		||||
import net.minecraft.world.item.ItemStack;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.HashMap;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
import java.util.Objects;
 | 
			
		||||
 
 | 
			
		||||
@@ -8,8 +8,7 @@ import net.minecraft.core.BlockPos;
 | 
			
		||||
import net.minecraft.world.level.Level;
 | 
			
		||||
import net.minecraft.world.level.block.entity.BlockEntity;
 | 
			
		||||
import net.minecraft.world.level.block.state.BlockState;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * A reference to a block in the world, used by block detail providers.
 | 
			
		||||
 
 | 
			
		||||
@@ -14,6 +14,7 @@ import java.util.Map;
 | 
			
		||||
 *
 | 
			
		||||
 * @param <T> The type of object that this provider can provide details for.
 | 
			
		||||
 * @see DetailRegistry
 | 
			
		||||
 * @see dan200.computercraft.api.detail An overview of the detail system.
 | 
			
		||||
 */
 | 
			
		||||
@FunctionalInterface
 | 
			
		||||
public interface DetailProvider<T> {
 | 
			
		||||
 
 | 
			
		||||
@@ -17,6 +17,7 @@ import java.util.Map;
 | 
			
		||||
 * also in this package.
 | 
			
		||||
 *
 | 
			
		||||
 * @param <T> The type of object that this registry provides details for.
 | 
			
		||||
 * @see dan200.computercraft.api.detail An overview of the detail system.
 | 
			
		||||
 */
 | 
			
		||||
@ApiStatus.NonExtendable
 | 
			
		||||
public interface DetailRegistry<T> {
 | 
			
		||||
 
 | 
			
		||||
@@ -17,6 +17,9 @@ public class VanillaDetailRegistries {
 | 
			
		||||
     * <p>
 | 
			
		||||
     * This instance's {@link DetailRegistry#getBasicDetails(Object)} is thread safe (assuming the stack is immutable)
 | 
			
		||||
     * and may be called from the computer thread.
 | 
			
		||||
     * <p>
 | 
			
		||||
     * This does not have special handling for {@linkplain ItemStack#isEmpty() empty item stacks}, and so the returned
 | 
			
		||||
     * details will be an empty stack of air. Callers should generally check for empty stacks before calling this.
 | 
			
		||||
     */
 | 
			
		||||
    public static final DetailRegistry<ItemStack> ITEM_STACK = ComputerCraftAPIService.get().getItemStackDetailRegistry();
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -0,0 +1,48 @@
 | 
			
		||||
// SPDX-FileCopyrightText: 2025 The CC: Tweaked Developers
 | 
			
		||||
//
 | 
			
		||||
// SPDX-License-Identifier: MPL-2.0
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * The detail system provides a standard way for mods to return descriptions of common game objects, such as blocks or
 | 
			
		||||
 * items, as well as registering additional detail to be included in those descriptions.
 | 
			
		||||
 * <p>
 | 
			
		||||
 * For instance, the built-in {@code turtle.getItemDetail()} method uses
 | 
			
		||||
 * {@linkplain dan200.computercraft.api.detail.VanillaDetailRegistries#ITEM_STACK in order to provide information about}
 | 
			
		||||
 * the selected item:
 | 
			
		||||
 *
 | 
			
		||||
 * <pre class="language language-lua">{@code
 | 
			
		||||
 * local item = turtle.getItemDetail(nil, true)
 | 
			
		||||
 * --[[
 | 
			
		||||
 * item = {
 | 
			
		||||
 *   name = "minecraft:wheat",
 | 
			
		||||
 *   displayName = "Wheat",
 | 
			
		||||
 *   count = 1,
 | 
			
		||||
 *   maxCount = 64,
 | 
			
		||||
 *   tags = {},
 | 
			
		||||
 * }
 | 
			
		||||
 * ]]
 | 
			
		||||
 * }</pre>
 | 
			
		||||
 *
 | 
			
		||||
 * <h2>Built-in detail providers</h2>
 | 
			
		||||
 * While you can define your own detail providers (perhaps for types from your own mod), CC comes with several built-in
 | 
			
		||||
 * detail registries for vanilla and mod-loader objects:
 | 
			
		||||
 *
 | 
			
		||||
 * <ul>
 | 
			
		||||
 *     <li>{@link dan200.computercraft.api.detail.VanillaDetailRegistries}, for vanilla objects</li>
 | 
			
		||||
 *     <li>{@code dan200.computercraft.api.detail.ForgeDetailRegistries} for Forge-specific objects</li>
 | 
			
		||||
 *     <li>{@code dan200.computercraft.api.detail.FabricDetailRegistries} for Fabric-specific objects</li>
 | 
			
		||||
 * </ul>
 | 
			
		||||
 *
 | 
			
		||||
 * <h2>Example: Returning details from methods</h2>
 | 
			
		||||
 * Here we define a {@code getHeldItem()} method for pocket computers which finds the currently held item of the player
 | 
			
		||||
 * and returns it to the user using {@link dan200.computercraft.api.detail.VanillaDetailRegistries#ITEM_STACK} and
 | 
			
		||||
 * {@link dan200.computercraft.api.detail.DetailRegistry#getDetails(java.lang.Object)}.
 | 
			
		||||
 *
 | 
			
		||||
 * {@snippet class=com.example.examplemod.ExamplePocketPeripheral region=details}
 | 
			
		||||
 *
 | 
			
		||||
 * <h2>Example: Registering custom detail registries</h2>
 | 
			
		||||
 * Here we define a new detail provider for items that includes the nutrition and saturation values in the returned object.
 | 
			
		||||
 *
 | 
			
		||||
 * {@snippet class=com.example.examplemod.ExampleMod region=details}
 | 
			
		||||
 */
 | 
			
		||||
package dan200.computercraft.api.detail;
 | 
			
		||||
@@ -9,8 +9,7 @@ import dan200.computercraft.api.peripheral.IComputerAccess;
 | 
			
		||||
import net.minecraft.core.BlockPos;
 | 
			
		||||
import net.minecraft.server.level.ServerLevel;
 | 
			
		||||
import org.jetbrains.annotations.ApiStatus;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * An interface passed to {@link ILuaAPIFactory} in order to provide additional information
 | 
			
		||||
 
 | 
			
		||||
@@ -5,8 +5,7 @@
 | 
			
		||||
package dan200.computercraft.api.lua;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.ComputerCraftAPI;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Construct an {@link ILuaAPI} for a computer.
 | 
			
		||||
 
 | 
			
		||||
@@ -12,8 +12,7 @@ import net.minecraft.server.level.ServerLevel;
 | 
			
		||||
import net.minecraft.sounds.SoundEvent;
 | 
			
		||||
import net.minecraft.world.item.Item;
 | 
			
		||||
import net.minecraft.world.item.ItemStack;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Represents an item that can be placed in a disk drive and used by a Computer.
 | 
			
		||||
 
 | 
			
		||||
@@ -5,8 +5,7 @@
 | 
			
		||||
package dan200.computercraft.api.media;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.world.item.ItemStack;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * This interface is used to provide {@link IMedia} implementations for {@link ItemStack}.
 | 
			
		||||
 
 | 
			
		||||
@@ -0,0 +1,46 @@
 | 
			
		||||
// SPDX-FileCopyrightText: 2025 The CC: Tweaked Developers
 | 
			
		||||
//
 | 
			
		||||
// SPDX-License-Identifier: MPL-2.0
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.api.media;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.impl.ComputerCraftAPIService;
 | 
			
		||||
import net.minecraft.world.item.ItemStack;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
import java.util.stream.Stream;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * The contents of a page (or book) created by a ComputerCraft printer.
 | 
			
		||||
 *
 | 
			
		||||
 * @since 1.115
 | 
			
		||||
 */
 | 
			
		||||
@Nullable
 | 
			
		||||
public interface PrintoutContents {
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the (possibly empty) title for this printout.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The title of this printout.
 | 
			
		||||
     */
 | 
			
		||||
    String getTitle();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the text contents of this printout, as a sequence of lines.
 | 
			
		||||
     * <p>
 | 
			
		||||
     * The lines in the printout may include blank lines at the end of the document, as well as trailing spaces on each
 | 
			
		||||
     * line.
 | 
			
		||||
     *
 | 
			
		||||
     * @return The text contents of this printout.
 | 
			
		||||
     */
 | 
			
		||||
    Stream<String> getTextLines();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Get the printout contents for a particular stack.
 | 
			
		||||
     *
 | 
			
		||||
     * @param stack The stack to get the contents for.
 | 
			
		||||
     * @return The printout contents, or {@code null} if this is not a printout item.
 | 
			
		||||
     */
 | 
			
		||||
    static @Nullable PrintoutContents get(ItemStack stack) {
 | 
			
		||||
        return ComputerCraftAPIService.get().getPrintoutContents(stack);
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -19,8 +19,8 @@ import dan200.computercraft.api.ComputerCraftAPI;
 | 
			
		||||
 */
 | 
			
		||||
public interface WiredElement extends WiredSender {
 | 
			
		||||
    /**
 | 
			
		||||
     * Called when objects on the network change. This may occur when network nodes are added or removed, or when
 | 
			
		||||
     * peripherals change.
 | 
			
		||||
     * Called when peripherals on the network change. This may occur when network nodes are added or removed, or when
 | 
			
		||||
     * peripherals are attached or detached from a modem.
 | 
			
		||||
     *
 | 
			
		||||
     * @param change The change which occurred.
 | 
			
		||||
     * @see WiredNetworkChange
 | 
			
		||||
 
 | 
			
		||||
@@ -14,8 +14,8 @@ import net.minecraft.world.entity.Entity;
 | 
			
		||||
import net.minecraft.world.item.ItemStack;
 | 
			
		||||
import net.minecraft.world.phys.Vec3;
 | 
			
		||||
import org.jetbrains.annotations.ApiStatus;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 
 | 
			
		||||
@@ -7,20 +7,16 @@ package dan200.computercraft.api.pocket;
 | 
			
		||||
import dan200.computercraft.api.peripheral.IPeripheral;
 | 
			
		||||
import dan200.computercraft.api.upgrades.UpgradeBase;
 | 
			
		||||
import net.minecraft.world.level.Level;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import org.jspecify.annotations.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.
 | 
			
		||||
 * {@link PocketUpgradeSerialiser} instance, which are then registered in a Minecraft 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.
 | 
			
		||||
 *
 | 
			
		||||
 * @see PocketUpgradeSerialiser For how to register a pocket computer upgrade.
 | 
			
		||||
 * the upgrade registered internally.
 | 
			
		||||
 */
 | 
			
		||||
public interface IPocketUpgrade extends UpgradeBase {
 | 
			
		||||
    /**
 | 
			
		||||
 
 | 
			
		||||
@@ -17,8 +17,7 @@ import net.minecraft.world.Container;
 | 
			
		||||
import net.minecraft.world.item.ItemStack;
 | 
			
		||||
import net.minecraft.world.level.Level;
 | 
			
		||||
import org.jetbrains.annotations.ApiStatus;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * The interface passed to turtle by turtles, providing methods that they can call.
 | 
			
		||||
 
 | 
			
		||||
@@ -8,21 +8,69 @@ import dan200.computercraft.api.peripheral.IPeripheral;
 | 
			
		||||
import dan200.computercraft.api.upgrades.UpgradeBase;
 | 
			
		||||
import net.minecraft.core.Direction;
 | 
			
		||||
import net.minecraft.nbt.CompoundTag;
 | 
			
		||||
import net.minecraft.world.item.Items;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.function.BiFunction;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * The primary interface for defining an update for Turtles. A turtle update can either be a new tool, or a new
 | 
			
		||||
 * 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 TurtleUpgradeSerialiser} instance, which are then registered in a Minecraft 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.
 | 
			
		||||
 *
 | 
			
		||||
 * @see TurtleUpgradeSerialiser For how to register a turtle upgrade.
 | 
			
		||||
 * <h2>Example</h2>
 | 
			
		||||
 * <h3>Registering the upgrade serialiser</h3>
 | 
			
		||||
 * First, let's create a new class that implements {@link ITurtleUpgrade}. It is recommended to subclass
 | 
			
		||||
 * {@link AbstractTurtleUpgrade}, as that provides a default implementation of most methods.
 | 
			
		||||
 *
 | 
			
		||||
 * {@snippet class=com.example.examplemod.ExampleTurtleUpgrade region=body}
 | 
			
		||||
 * <p>
 | 
			
		||||
 * Now we must construct a new upgrade serialiser. In most cases, you can use one of the helper methods
 | 
			
		||||
 * (e.g. {@link TurtleUpgradeSerialiser#simpleWithCustomItem(BiFunction)}), rather than defining your own implementation.
 | 
			
		||||
 *
 | 
			
		||||
 * {@snippet class=com.example.examplemod.ExampleMod region=turtle_upgrades}
 | 
			
		||||
 *
 | 
			
		||||
 * We now must register this upgrade serialiser. This is done the same way as you'd register blocks, items, or other
 | 
			
		||||
 * Minecraft objects. The approach to do this will depend on mod-loader.
 | 
			
		||||
 *
 | 
			
		||||
 * <h4>Fabric</h4>
 | 
			
		||||
 * {@snippet class=com.example.examplemod.FabricExampleMod region=turtle_upgrades}
 | 
			
		||||
 *
 | 
			
		||||
 * <h4>Forge</h4>
 | 
			
		||||
 * {@snippet class=com.example.examplemod.ForgeExampleMod region=turtle_upgrades}
 | 
			
		||||
 *
 | 
			
		||||
 * <h3>Rendering the upgrade</h3>
 | 
			
		||||
 * Next, we need to register a model for our upgrade. This is done by registering a
 | 
			
		||||
 * {@link dan200.computercraft.api.client.turtle.TurtleUpgradeModeller} for your upgrade serialiser.
 | 
			
		||||
 *
 | 
			
		||||
 * <h4>Fabric</h4>
 | 
			
		||||
 * {@snippet class=com.example.examplemod.FabricExampleModClient region=turtle_modellers}
 | 
			
		||||
 *
 | 
			
		||||
 *
 | 
			
		||||
 * <h4>Forge</h4>
 | 
			
		||||
 * {@snippet class=com.example.examplemod.FabricExampleModClient region=turtle_modellers}
 | 
			
		||||
 *
 | 
			
		||||
 * <h3>Registering the upgrade itself</h3>
 | 
			
		||||
 * Upgrades themselves are loaded from datapacks when a level is loaded. In order to register our new upgrade, we must
 | 
			
		||||
 * create a new JSON file at {@code data/<my_mod>/computercraft/turtle_upgrades/<my_upgrade_id>.json}.
 | 
			
		||||
 *
 | 
			
		||||
 * {@snippet file = data/examplemod/computercraft/turtle_upgrades/example_turtle_upgrade.json}
 | 
			
		||||
 *
 | 
			
		||||
 * The {@code "type"} field points to the ID of the upgrade serialiser we've just registered, while the other fields
 | 
			
		||||
 * are read by the serialiser itself. As our upgrade was defined with {@link TurtleUpgradeSerialiser#simpleWithCustomItem(BiFunction)}, the
 | 
			
		||||
 * {@code "item"} field will construct our upgrade with {@link Items#COMPASS}.
 | 
			
		||||
 * <p>
 | 
			
		||||
 * Rather than manually creating the file, it is recommended to data-generators to generate this file. This can be done
 | 
			
		||||
 * with {@link TurtleUpgradeDataProvider}.
 | 
			
		||||
 *
 | 
			
		||||
 * {@snippet class=com.example.examplemod.data.TurtleDataProvider region=body}
 | 
			
		||||
 *
 | 
			
		||||
 * @see TurtleUpgradeSerialiser Registering a turtle upgrade.
 | 
			
		||||
 */
 | 
			
		||||
public interface ITurtleUpgrade extends UpgradeBase {
 | 
			
		||||
    /**
 | 
			
		||||
 
 | 
			
		||||
@@ -5,8 +5,7 @@
 | 
			
		||||
package dan200.computercraft.api.turtle;
 | 
			
		||||
 | 
			
		||||
import net.minecraft.core.Direction;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Used to indicate the result of executing a turtle command.
 | 
			
		||||
@@ -60,9 +59,9 @@ public final class TurtleCommandResult {
 | 
			
		||||
 | 
			
		||||
    private final boolean success;
 | 
			
		||||
    private final @Nullable String errorMessage;
 | 
			
		||||
    private final @Nullable Object[] results;
 | 
			
		||||
    private final @Nullable Object @Nullable [] results;
 | 
			
		||||
 | 
			
		||||
    private TurtleCommandResult(boolean success, @Nullable String errorMessage, @Nullable Object[] results) {
 | 
			
		||||
    private TurtleCommandResult(boolean success, @Nullable String errorMessage, @Nullable Object @Nullable [] results) {
 | 
			
		||||
        this.success = success;
 | 
			
		||||
        this.errorMessage = errorMessage;
 | 
			
		||||
        this.results = results;
 | 
			
		||||
@@ -92,8 +91,7 @@ public final class TurtleCommandResult {
 | 
			
		||||
     *
 | 
			
		||||
     * @return The command's result, or {@code null} if it was a failure.
 | 
			
		||||
     */
 | 
			
		||||
    @Nullable
 | 
			
		||||
    public Object[] getResults() {
 | 
			
		||||
    public @Nullable Object @Nullable [] getResults() {
 | 
			
		||||
        return results;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -18,8 +18,8 @@ import net.minecraft.world.entity.ai.attributes.Attributes;
 | 
			
		||||
import net.minecraft.world.item.Item;
 | 
			
		||||
import net.minecraft.world.item.ItemStack;
 | 
			
		||||
import net.minecraft.world.level.block.Block;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.function.Consumer;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
@@ -29,6 +29,9 @@ import java.util.function.Consumer;
 | 
			
		||||
 * {@link #addUpgrades(Consumer)} function, construct each upgrade, and pass them off to the provided consumer to
 | 
			
		||||
 * generate them.
 | 
			
		||||
 *
 | 
			
		||||
 * <h2>Example</h2>
 | 
			
		||||
 * {@snippet class=com.example.examplemod.data.TurtleDataProvider region=body}
 | 
			
		||||
 *
 | 
			
		||||
 * @see TurtleUpgradeSerialiser
 | 
			
		||||
 */
 | 
			
		||||
public abstract class TurtleUpgradeDataProvider extends UpgradeDataProvider<ITurtleUpgrade, TurtleUpgradeSerialiser<?>> {
 | 
			
		||||
 
 | 
			
		||||
@@ -27,32 +27,6 @@ import java.util.function.Function;
 | 
			
		||||
 * 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 class="language language-java">{@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 class="language language-json">{@code
 | 
			
		||||
 * {
 | 
			
		||||
 *     "type": "my_mod:my_upgrade",
 | 
			
		||||
 * }
 | 
			
		||||
 * }</pre>
 | 
			
		||||
 * <p>
 | 
			
		||||
 * Finally, we need to register a model for our upgrade. The way to do this varies on mod loader, see
 | 
			
		||||
 * {@link dan200.computercraft.api.client.turtle.TurtleUpgradeModeller} for more information.
 | 
			
		||||
 * <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
 | 
			
		||||
 
 | 
			
		||||
@@ -9,8 +9,7 @@ import dan200.computercraft.api.turtle.ITurtleUpgrade;
 | 
			
		||||
import net.minecraft.nbt.CompoundTag;
 | 
			
		||||
import net.minecraft.world.item.ItemStack;
 | 
			
		||||
import org.jetbrains.annotations.Contract;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * An upgrade (i.e. a {@link ITurtleUpgrade}) and its current upgrade data.
 | 
			
		||||
 
 | 
			
		||||
@@ -19,8 +19,8 @@ import net.minecraft.data.PackOutput;
 | 
			
		||||
import net.minecraft.resources.ResourceKey;
 | 
			
		||||
import net.minecraft.resources.ResourceLocation;
 | 
			
		||||
import net.minecraft.world.item.Item;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.*;
 | 
			
		||||
import java.util.concurrent.CompletableFuture;
 | 
			
		||||
import java.util.function.Consumer;
 | 
			
		||||
@@ -32,6 +32,8 @@ import java.util.function.Function;
 | 
			
		||||
 *
 | 
			
		||||
 * @param <T> The base class of upgrades.
 | 
			
		||||
 * @param <R> The upgrade serialiser to register for.
 | 
			
		||||
 * @see dan200.computercraft.api.turtle.TurtleUpgradeDataProvider
 | 
			
		||||
 * @see dan200.computercraft.api.pocket.PocketUpgradeDataProvider
 | 
			
		||||
 */
 | 
			
		||||
public abstract class UpgradeDataProvider<T extends UpgradeBase, R extends UpgradeSerialiser<? extends T>> implements DataProvider {
 | 
			
		||||
    private final PackOutput output;
 | 
			
		||||
@@ -84,13 +86,9 @@ public abstract class UpgradeDataProvider<T extends UpgradeBase, R extends Upgra
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Add all turtle or pocket computer upgrades.
 | 
			
		||||
     * <p>
 | 
			
		||||
     * <strong>Example usage:</strong>
 | 
			
		||||
     * <pre class="language language-java">{@code
 | 
			
		||||
     * protected void addUpgrades(Consumer<Upgrade<TurtleUpgradeSerialiser<?>>> addUpgrade) {
 | 
			
		||||
     *     simple(new ResourceLocation("mymod", "speaker"), SPEAKER_SERIALISER.get()).add(addUpgrade);
 | 
			
		||||
     * }
 | 
			
		||||
     * }</pre>
 | 
			
		||||
     *
 | 
			
		||||
     * <h4>Example</h4>
 | 
			
		||||
     * {@snippet class=com.example.examplemod.data.TurtleDataProvider region=body}
 | 
			
		||||
     *
 | 
			
		||||
     * @param addUpgrade A callback used to register an upgrade.
 | 
			
		||||
     */
 | 
			
		||||
 
 | 
			
		||||
@@ -12,6 +12,7 @@ import dan200.computercraft.api.filesystem.WritableMount;
 | 
			
		||||
import dan200.computercraft.api.lua.GenericSource;
 | 
			
		||||
import dan200.computercraft.api.lua.ILuaAPIFactory;
 | 
			
		||||
import dan200.computercraft.api.media.MediaProvider;
 | 
			
		||||
import dan200.computercraft.api.media.PrintoutContents;
 | 
			
		||||
import dan200.computercraft.api.network.PacketNetwork;
 | 
			
		||||
import dan200.computercraft.api.network.wired.WiredElement;
 | 
			
		||||
import dan200.computercraft.api.network.wired.WiredNode;
 | 
			
		||||
@@ -27,8 +28,7 @@ import net.minecraft.server.MinecraftServer;
 | 
			
		||||
import net.minecraft.world.item.ItemStack;
 | 
			
		||||
import net.minecraft.world.level.Level;
 | 
			
		||||
import org.jetbrains.annotations.ApiStatus;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Backing interface for {@link ComputerCraftAPI}
 | 
			
		||||
@@ -75,6 +75,9 @@ public interface ComputerCraftAPIService {
 | 
			
		||||
 | 
			
		||||
    DetailRegistry<BlockReference> getBlockInWorldDetailRegistry();
 | 
			
		||||
 | 
			
		||||
    @Nullable
 | 
			
		||||
    PrintoutContents getPrintoutContents(ItemStack stack);
 | 
			
		||||
 | 
			
		||||
    final class Instance {
 | 
			
		||||
        static final @Nullable ComputerCraftAPIService INSTANCE;
 | 
			
		||||
        static final @Nullable Throwable ERROR;
 | 
			
		||||
 
 | 
			
		||||
@@ -12,8 +12,7 @@ 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;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Abstraction layer for Forge and Fabric. See implementations for more details.
 | 
			
		||||
 
 | 
			
		||||
@@ -5,8 +5,8 @@
 | 
			
		||||
package dan200.computercraft.impl;
 | 
			
		||||
 | 
			
		||||
import org.jetbrains.annotations.ApiStatus;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.io.Serial;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 
 | 
			
		||||
@@ -5,8 +5,8 @@
 | 
			
		||||
package dan200.computercraft.impl;
 | 
			
		||||
 | 
			
		||||
import org.jetbrains.annotations.ApiStatus;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.ServiceLoader;
 | 
			
		||||
import java.util.stream.Collectors;
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										68
									
								
								projects/common-api/src/overview.html
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										68
									
								
								projects/common-api/src/overview.html
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,68 @@
 | 
			
		||||
<!--
 | 
			
		||||
SPDX-FileCopyrightText: 2025 The CC: Tweaked Developers
 | 
			
		||||
 | 
			
		||||
SPDX-License-Identifier: MPL-2.0
 | 
			
		||||
-->
 | 
			
		||||
 | 
			
		||||
<!DOCTYPE HTML>
 | 
			
		||||
<html lang="en">
 | 
			
		||||
<body>
 | 
			
		||||
<p>
 | 
			
		||||
    This is the documentation for CC: Tweaked $modVersion for Minecraft $mcVersion. Documentation for other versions of
 | 
			
		||||
    Minecraft are available on the CC: Tweaked website:
 | 
			
		||||
 | 
			
		||||
<ul>
 | 
			
		||||
    <li><a href="/mc-1.20.x/javadoc/">Minecraft 1.20.1</a>
 | 
			
		||||
    <li><a href="/mc-1.21.x/javadoc/">Minecraft 1.21.1</a>
 | 
			
		||||
</ul>
 | 
			
		||||
 | 
			
		||||
<h1>Quick links</h1>
 | 
			
		||||
<p>
 | 
			
		||||
    You probably want to start in the following places:
 | 
			
		||||
 | 
			
		||||
<ul>
 | 
			
		||||
    <li>{@linkplain dan200.computercraft.api.peripheral Registering new peripherals}</li>
 | 
			
		||||
    <li>
 | 
			
		||||
        {@link dan200.computercraft.api.lua.LuaFunction} and {@link dan200.computercraft.api.lua.IArguments} for
 | 
			
		||||
        adding methods to your peripheral or Lua objects.
 | 
			
		||||
    </li>
 | 
			
		||||
    <li>{@linkplain dan200.computercraft.api.turtle.ITurtleUpgrade Turtle upgrades}</li>
 | 
			
		||||
    <li>{@linkplain dan200.computercraft.api.pocket.IPocketUpgrade Pocket upgrades}</li>
 | 
			
		||||
</ul>
 | 
			
		||||
 | 
			
		||||
<h1>Using</h1>
 | 
			
		||||
<p>
 | 
			
		||||
    CC: Tweaked is hosted on my maven repo, and so is relatively simple to depend on. You may wish to add a soft (or
 | 
			
		||||
    hard) dependency in your <code>mods.toml</code> file, with the appropriate version bounds, to ensure that API
 | 
			
		||||
    functionality you depend on is present.
 | 
			
		||||
 | 
			
		||||
<pre class="language language-groovy"><code>repositories {
 | 
			
		||||
    maven {
 | 
			
		||||
        url "https://maven.squiddev.cc"
 | 
			
		||||
        content { includeGroup("cc.tweaked") }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
dependencies {
 | 
			
		||||
    // Vanilla (i.e. for multi-loader systems)
 | 
			
		||||
    compileOnly("cc.tweaked:cc-tweaked-$mcVersion-common-api:$modVersion")
 | 
			
		||||
 | 
			
		||||
    // Forge Gradle
 | 
			
		||||
    compileOnly("cc.tweaked:cc-tweaked-$mcVersion-core-api:$modVersion")
 | 
			
		||||
    compileOnly(fg.deobf("cc.tweaked:cc-tweaked-$mcVersion-forge-api:$modVersion"))
 | 
			
		||||
    runtimeOnly(fg.deobf("cc.tweaked:cc-tweaked-$mcVersion-forge:$modVersion"))
 | 
			
		||||
 | 
			
		||||
    // Fabric Loom
 | 
			
		||||
    modCompileOnly("cc.tweaked:cc-tweaked-$mcVersion-fabric-api:$modVersion")
 | 
			
		||||
    modRuntimeOnly("cc.tweaked:cc-tweaked-$mcVersion-fabric:$modVersion")
 | 
			
		||||
}
 | 
			
		||||
</code></pre>
 | 
			
		||||
 | 
			
		||||
<p>
 | 
			
		||||
    You should also be careful to only use classes within the <code>dan200.computercraft.api</code> package. Non-API
 | 
			
		||||
    classes are subject to change at any point. If you depend on functionality outside the API (or need to mixin to
 | 
			
		||||
    CC:T), please <a href="https://github.com/cc-tweaked/CC-Tweaked/discussions/new/choose">start a discussion</a> to
 | 
			
		||||
    let me know!
 | 
			
		||||
 | 
			
		||||
</body>
 | 
			
		||||
</html>
 | 
			
		||||
@@ -6,17 +6,11 @@ import cc.tweaked.gradle.*
 | 
			
		||||
 | 
			
		||||
plugins {
 | 
			
		||||
    id("cc-tweaked.vanilla")
 | 
			
		||||
    id("cc-tweaked.gametest")
 | 
			
		||||
    id("cc-tweaked.illuaminate")
 | 
			
		||||
    id("cc-tweaked.mod")
 | 
			
		||||
    id("cc-tweaked.publishing")
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
sourceSets {
 | 
			
		||||
    main {
 | 
			
		||||
        resources.srcDir("src/generated/resources")
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
minecraft {
 | 
			
		||||
    accessWideners(
 | 
			
		||||
        "src/main/resources/computercraft.accesswidener",
 | 
			
		||||
@@ -43,7 +37,6 @@ dependencies {
 | 
			
		||||
    clientApi(clientClasses(project(":common-api")))
 | 
			
		||||
 | 
			
		||||
    compileOnly(libs.bundles.externalMods.common)
 | 
			
		||||
    compileOnly(variantOf(libs.create.forge) { classifier("slim") }) { isTransitive = false }
 | 
			
		||||
    clientCompileOnly(variantOf(libs.emi) { classifier("api") })
 | 
			
		||||
 | 
			
		||||
    annotationProcessorEverywhere(libs.autoService)
 | 
			
		||||
@@ -67,7 +60,7 @@ dependencies {
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
illuaminate {
 | 
			
		||||
    version.set(libs.versions.illuaminate)
 | 
			
		||||
    version = libs.versions.illuaminate
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
val luaJavadoc by tasks.registering(Javadoc::class) {
 | 
			
		||||
@@ -88,11 +81,7 @@ val luaJavadoc by tasks.registering(Javadoc::class) {
 | 
			
		||||
    options.addStringOption("project-root", rootProject.file(".").absolutePath)
 | 
			
		||||
    options.noTimestamp(false)
 | 
			
		||||
 | 
			
		||||
    javadocTool.set(
 | 
			
		||||
        javaToolchains.javadocToolFor {
 | 
			
		||||
            languageVersion.set(CCTweakedPlugin.JAVA_VERSION)
 | 
			
		||||
        },
 | 
			
		||||
    )
 | 
			
		||||
    javadocTool = javaToolchains.javadocToolFor { languageVersion = CCTweakedPlugin.JDK_VERSION }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
val lintLua by tasks.registering(IlluaminateExec::class) {
 | 
			
		||||
@@ -113,20 +102,31 @@ val lintLua by tasks.registering(IlluaminateExec::class) {
 | 
			
		||||
    doLast { if (System.getenv("GITHUB_ACTIONS") != null) println("::remove-matcher owner=illuaminate::") }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
val runData by tasks.registering(MergeTrees::class) {
 | 
			
		||||
    output = layout.projectDirectory.dir("src/generated/resources")
 | 
			
		||||
fun MergeTrees.configureForDatagen(source: SourceSet, outputFolder: String) {
 | 
			
		||||
    output = layout.projectDirectory.dir(outputFolder)
 | 
			
		||||
 | 
			
		||||
    for (loader in listOf("forge", "fabric")) {
 | 
			
		||||
        mustRunAfter(":$loader:runData")
 | 
			
		||||
        mustRunAfter(":$loader:$name")
 | 
			
		||||
        source {
 | 
			
		||||
            input {
 | 
			
		||||
                from(project(":$loader").layout.buildDirectory.dir("generatedResources"))
 | 
			
		||||
                from(project(":$loader").layout.buildDirectory.dir(source.getTaskName("generateResources", null)))
 | 
			
		||||
                exclude(".cache")
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            output = project(":$loader").layout.projectDirectory.dir("src/generated/resources")
 | 
			
		||||
            output = project(":$loader").layout.projectDirectory.dir(outputFolder)
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
tasks.withType(GenerateModuleMetadata::class).configureEach { isEnabled = false }
 | 
			
		||||
val runData by tasks.registering(MergeTrees::class) {
 | 
			
		||||
    configureForDatagen(sourceSets.main.get(), "src/generated/resources")
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
val runExampleData by tasks.registering(MergeTrees::class) {
 | 
			
		||||
    configureForDatagen(sourceSets.examples.get(), "src/examples/generatedResources")
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
// We can't create accurate module metadata for our additional capabilities, so disable it.
 | 
			
		||||
project.tasks.withType(GenerateModuleMetadata::class.java).configureEach {
 | 
			
		||||
    isEnabled = false
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -38,8 +38,8 @@ import net.minecraft.world.item.ItemStack;
 | 
			
		||||
import net.minecraft.world.level.block.state.BlockState;
 | 
			
		||||
import net.minecraft.world.phys.BlockHitResult;
 | 
			
		||||
import net.minecraft.world.phys.HitResult;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.function.Consumer;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 
 | 
			
		||||
@@ -46,8 +46,10 @@ import net.minecraft.world.entity.LivingEntity;
 | 
			
		||||
import net.minecraft.world.item.Item;
 | 
			
		||||
import net.minecraft.world.item.ItemStack;
 | 
			
		||||
import net.minecraft.world.level.ItemLike;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
import org.slf4j.Logger;
 | 
			
		||||
import org.slf4j.LoggerFactory;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.io.File;
 | 
			
		||||
import java.io.IOException;
 | 
			
		||||
import java.util.function.BiConsumer;
 | 
			
		||||
@@ -63,6 +65,8 @@ import java.util.function.Supplier;
 | 
			
		||||
 * @see ModRegistry The common registry for actual game objects.
 | 
			
		||||
 */
 | 
			
		||||
public final class ClientRegistry {
 | 
			
		||||
    private static final Logger LOG = LoggerFactory.getLogger(ClientRegistry.class);
 | 
			
		||||
 | 
			
		||||
    private ClientRegistry() {
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
@@ -182,7 +186,18 @@ public final class ClientRegistry {
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public static void registerShaders(ResourceProvider resources, BiConsumer<ShaderInstance, Consumer<ShaderInstance>> load) throws IOException {
 | 
			
		||||
        RenderTypes.registerShaders(resources, load);
 | 
			
		||||
        RenderTypes.registerShaders(resources, (name, create, onLoaded) -> {
 | 
			
		||||
            ShaderInstance shader;
 | 
			
		||||
            try {
 | 
			
		||||
                shader = create.get();
 | 
			
		||||
            } catch (Exception e) {
 | 
			
		||||
                LOG.error("Failed to load {}", name, e);
 | 
			
		||||
                onLoaded.accept(null);
 | 
			
		||||
                return;
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            load.accept(shader, onLoaded);
 | 
			
		||||
        });
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private record UnclampedPropertyFunction(
 | 
			
		||||
 
 | 
			
		||||
@@ -15,8 +15,8 @@ import net.minecraft.client.gui.components.ChatComponent;
 | 
			
		||||
import net.minecraft.network.chat.Component;
 | 
			
		||||
import net.minecraft.util.Mth;
 | 
			
		||||
import org.apache.commons.lang3.StringUtils;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.Objects;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 
 | 
			
		||||
@@ -26,11 +26,11 @@ import net.minecraft.client.gui.screens.inventory.AbstractContainerScreen;
 | 
			
		||||
import net.minecraft.network.chat.Component;
 | 
			
		||||
import net.minecraft.world.entity.player.Inventory;
 | 
			
		||||
import net.minecraft.world.item.ItemStack;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
import org.lwjgl.glfw.GLFW;
 | 
			
		||||
import org.slf4j.Logger;
 | 
			
		||||
import org.slf4j.LoggerFactory;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.io.IOException;
 | 
			
		||||
import java.nio.ByteBuffer;
 | 
			
		||||
import java.nio.file.Files;
 | 
			
		||||
 
 | 
			
		||||
@@ -10,10 +10,10 @@ import dan200.computercraft.shared.computer.menu.ComputerMenu;
 | 
			
		||||
import dan200.computercraft.shared.network.server.ComputerActionServerMessage;
 | 
			
		||||
import dan200.computercraft.shared.network.server.KeyEventServerMessage;
 | 
			
		||||
import dan200.computercraft.shared.network.server.MouseEventServerMessage;
 | 
			
		||||
import dan200.computercraft.shared.network.server.QueueEventServerMessage;
 | 
			
		||||
import dan200.computercraft.shared.network.server.PasteEventComputerMessage;
 | 
			
		||||
import net.minecraft.world.inventory.AbstractContainerMenu;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.nio.ByteBuffer;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * An {@link InputHandler} for use on the client.
 | 
			
		||||
@@ -27,6 +27,11 @@ public final class ClientInputHandler implements InputHandler {
 | 
			
		||||
        this.menu = menu;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void terminate() {
 | 
			
		||||
        ClientNetworking.sendToServer(new ComputerActionServerMessage(menu, ComputerActionServerMessage.Action.TERMINATE));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void turnOn() {
 | 
			
		||||
        ClientNetworking.sendToServer(new ComputerActionServerMessage(menu, ComputerActionServerMessage.Action.TURN_ON));
 | 
			
		||||
@@ -42,11 +47,6 @@ public final class ClientInputHandler implements InputHandler {
 | 
			
		||||
        ClientNetworking.sendToServer(new ComputerActionServerMessage(menu, ComputerActionServerMessage.Action.REBOOT));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void queueEvent(String event, @Nullable Object[] arguments) {
 | 
			
		||||
        ClientNetworking.sendToServer(new QueueEventServerMessage(menu, event, arguments));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void keyDown(int key, boolean repeat) {
 | 
			
		||||
        ClientNetworking.sendToServer(new KeyEventServerMessage(menu, repeat ? KeyEventServerMessage.Action.REPEAT : KeyEventServerMessage.Action.DOWN, key));
 | 
			
		||||
@@ -57,6 +57,16 @@ public final class ClientInputHandler implements InputHandler {
 | 
			
		||||
        ClientNetworking.sendToServer(new KeyEventServerMessage(menu, KeyEventServerMessage.Action.UP, key));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void charTyped(byte chr) {
 | 
			
		||||
        ClientNetworking.sendToServer(new KeyEventServerMessage(menu, KeyEventServerMessage.Action.CHAR, chr));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void paste(ByteBuffer contents) {
 | 
			
		||||
        ClientNetworking.sendToServer(new PasteEventComputerMessage(menu, contents));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public void mouseClick(int button, int x, int y) {
 | 
			
		||||
        ClientNetworking.sendToServer(new MouseEventServerMessage(menu, MouseEventServerMessage.Action.CLICK, button, x, y));
 | 
			
		||||
 
 | 
			
		||||
@@ -6,14 +6,13 @@ package dan200.computercraft.client.gui;
 | 
			
		||||
 | 
			
		||||
import dan200.computercraft.api.ComputerCraftAPI;
 | 
			
		||||
import dan200.computercraft.client.render.ComputerBorderRenderer;
 | 
			
		||||
import dan200.computercraft.data.client.ClientDataProviders;
 | 
			
		||||
import dan200.computercraft.shared.computer.core.ComputerFamily;
 | 
			
		||||
import net.minecraft.client.renderer.texture.TextureAtlasSprite;
 | 
			
		||||
import net.minecraft.client.renderer.texture.TextureManager;
 | 
			
		||||
import net.minecraft.client.resources.TextureAtlasHolder;
 | 
			
		||||
import net.minecraft.resources.ResourceLocation;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.Objects;
 | 
			
		||||
import java.util.stream.Stream;
 | 
			
		||||
 | 
			
		||||
@@ -33,10 +32,13 @@ public final class GuiSprites extends TextureAtlasHolder {
 | 
			
		||||
    public static final ComputerTextures COMPUTER_COMMAND = computer("command", false, true);
 | 
			
		||||
    public static final ComputerTextures COMPUTER_COLOUR = computer("colour", true, false);
 | 
			
		||||
 | 
			
		||||
    public static final ResourceLocation TURTLE_NORMAL_SELECTED_SLOT = new ResourceLocation(ComputerCraftAPI.MOD_ID, "gui/sprites/turtle_normal_selected_slot");
 | 
			
		||||
    public static final ResourceLocation TURTLE_ADVANCED_SELECTED_SLOT = new ResourceLocation(ComputerCraftAPI.MOD_ID, "gui/sprites/turtle_advanced_selected_slot");
 | 
			
		||||
 | 
			
		||||
    private static ButtonTextures button(String name) {
 | 
			
		||||
        return new ButtonTextures(
 | 
			
		||||
            new ResourceLocation(ComputerCraftAPI.MOD_ID, "gui/buttons/" + name),
 | 
			
		||||
            new ResourceLocation(ComputerCraftAPI.MOD_ID, "gui/buttons/" + name + "_hover")
 | 
			
		||||
            new ResourceLocation(ComputerCraftAPI.MOD_ID, "gui/sprites/buttons/" + name),
 | 
			
		||||
            new ResourceLocation(ComputerCraftAPI.MOD_ID, "gui/sprites/buttons/" + name + "_hover")
 | 
			
		||||
        );
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
@@ -113,7 +115,6 @@ public final class GuiSprites extends TextureAtlasHolder {
 | 
			
		||||
     * @param pocketBottom The texture for the bottom of a pocket computer.
 | 
			
		||||
     * @param sidebar      The texture for the computer sidebar.
 | 
			
		||||
     * @see ComputerBorderRenderer
 | 
			
		||||
     * @see ClientDataProviders
 | 
			
		||||
     */
 | 
			
		||||
    public record ComputerTextures(
 | 
			
		||||
        ResourceLocation border,
 | 
			
		||||
 
 | 
			
		||||
@@ -0,0 +1,40 @@
 | 
			
		||||
// SPDX-FileCopyrightText: 2025 The CC: Tweaked Developers
 | 
			
		||||
//
 | 
			
		||||
// SPDX-License-Identifier: MPL-2.0
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.client.gui;
 | 
			
		||||
 | 
			
		||||
import org.lwjgl.glfw.GLFW;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Supports for converting/translating key codes.
 | 
			
		||||
 */
 | 
			
		||||
public class KeyConverter {
 | 
			
		||||
    /**
 | 
			
		||||
     * GLFW's key events refer to the physical key code, rather than the "actual" key code (with keyboard layout
 | 
			
		||||
     * applied).
 | 
			
		||||
     * <p>
 | 
			
		||||
     * This makes sense for WASD-style input, but is a right pain for keyboard shortcuts — this function attempts to
 | 
			
		||||
     * translate those keys back to their "actual" key code. See also
 | 
			
		||||
     * <a href="https://github.com/glfw/glfw/issues/1502"> this discussion on GLFW's GitHub.</a>
 | 
			
		||||
     *
 | 
			
		||||
     * @param key      The current key code.
 | 
			
		||||
     * @param scanCode The current scan code.
 | 
			
		||||
     * @return The translated key code.
 | 
			
		||||
     */
 | 
			
		||||
    public static int physicalToActual(int key, int scanCode) {
 | 
			
		||||
        var name = GLFW.glfwGetKeyName(key, scanCode);
 | 
			
		||||
        if (name == null || name.length() != 1) return key;
 | 
			
		||||
 | 
			
		||||
        // If we've got a single character as the key name, treat that as the ASCII value of the key,
 | 
			
		||||
        // and map that back to a key code.
 | 
			
		||||
        var character = name.charAt(0);
 | 
			
		||||
 | 
			
		||||
        // 0-9 and A-Z map directly to their GLFW key (they're the same ASCII code).
 | 
			
		||||
        if ((character >= '0' && character <= '9') || (character >= 'A' && character <= 'Z')) return character;
 | 
			
		||||
        // a-z map to GLFW_KEY_{A,Z}
 | 
			
		||||
        if (character >= 'a' && character <= 'z') return GLFW.GLFW_KEY_A + (character - 'a');
 | 
			
		||||
 | 
			
		||||
        return key;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -15,9 +15,9 @@ import net.minecraft.client.gui.screens.Screen;
 | 
			
		||||
import net.minecraft.client.gui.screens.inventory.MenuAccess;
 | 
			
		||||
import net.minecraft.network.chat.Component;
 | 
			
		||||
import net.minecraft.world.entity.player.Inventory;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
import org.lwjgl.glfw.GLFW;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.Objects;
 | 
			
		||||
 | 
			
		||||
import static dan200.computercraft.core.util.Nullability.assertNonNull;
 | 
			
		||||
 
 | 
			
		||||
@@ -12,8 +12,8 @@ import net.minecraft.client.gui.components.MultiLineLabel;
 | 
			
		||||
import net.minecraft.client.gui.screens.Screen;
 | 
			
		||||
import net.minecraft.network.chat.Component;
 | 
			
		||||
import net.minecraft.resources.ResourceLocation;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.List;
 | 
			
		||||
 | 
			
		||||
import static dan200.computercraft.core.util.Nullability.assertNonNull;
 | 
			
		||||
 
 | 
			
		||||
@@ -149,6 +149,7 @@ public final class PrintoutScreen extends AbstractContainerScreen<PrintoutMenu>
 | 
			
		||||
        // Skip rendering labels.
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @SuppressWarnings("ArrayRecordComponent")
 | 
			
		||||
    record PrintoutInfo(int pages, boolean book, TextBuffer[] text, TextBuffer[] colour) {
 | 
			
		||||
        public static final PrintoutInfo DEFAULT;
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -54,9 +54,9 @@ public class TurtleScreen extends AbstractComputerScreen<TurtleMenu> {
 | 
			
		||||
        if (slot >= 0) {
 | 
			
		||||
            var slotX = slot % 4;
 | 
			
		||||
            var slotY = slot / 4;
 | 
			
		||||
            graphics.blit(texture,
 | 
			
		||||
                leftPos + TURTLE_START_X - 2 + slotX * 18, topPos + PLAYER_START_Y - 2 + slotY * 18, 0,
 | 
			
		||||
                0, 217, 24, 24, FULL_TEX_SIZE, FULL_TEX_SIZE
 | 
			
		||||
            graphics.blit(
 | 
			
		||||
                leftPos + TURTLE_START_X - 2 + slotX * 18, topPos + PLAYER_START_Y - 2 + slotY * 18, 0, 22, 22,
 | 
			
		||||
                GuiSprites.get(advanced ? GuiSprites.TURTLE_ADVANCED_SELECTED_SLOT : GuiSprites.TURTLE_NORMAL_SELECTED_SLOT)
 | 
			
		||||
            );
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -55,7 +55,7 @@ public final class ComputerSidebar {
 | 
			
		||||
        add.accept(new DynamicImageButton(
 | 
			
		||||
            x, y, ICON_WIDTH, ICON_HEIGHT,
 | 
			
		||||
            GuiSprites.TERMINATE::get,
 | 
			
		||||
            b -> input.queueEvent("terminate"),
 | 
			
		||||
            b -> input.terminate(),
 | 
			
		||||
            new HintedMessage(
 | 
			
		||||
                Component.translatable("gui.computercraft.tooltip.terminate"),
 | 
			
		||||
                Component.translatable("gui.computercraft.tooltip.terminate.key")
 | 
			
		||||
 
 | 
			
		||||
@@ -12,8 +12,8 @@ import net.minecraft.client.gui.components.Button;
 | 
			
		||||
import net.minecraft.client.gui.components.Tooltip;
 | 
			
		||||
import net.minecraft.client.renderer.texture.TextureAtlasSprite;
 | 
			
		||||
import net.minecraft.network.chat.Component;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.function.Supplier;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 
 | 
			
		||||
@@ -5,6 +5,7 @@
 | 
			
		||||
package dan200.computercraft.client.gui.widgets;
 | 
			
		||||
 | 
			
		||||
import com.mojang.blaze3d.vertex.Tesselator;
 | 
			
		||||
import dan200.computercraft.client.gui.KeyConverter;
 | 
			
		||||
import dan200.computercraft.client.render.RenderTypes;
 | 
			
		||||
import dan200.computercraft.client.render.text.FixedWidthFontRenderer;
 | 
			
		||||
import dan200.computercraft.core.terminal.Terminal;
 | 
			
		||||
@@ -71,11 +72,8 @@ public class TerminalWidget extends AbstractWidget {
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public boolean charTyped(char ch, int modifiers) {
 | 
			
		||||
        if (ch >= 32 && ch <= 126 || ch >= 160 && ch <= 255) {
 | 
			
		||||
            // Queue the char event for any printable chars in byte range
 | 
			
		||||
            computer.queueEvent("char", new Object[]{ Character.toString(ch) });
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        var terminalChar = StringUtil.unicodeToTerminal(ch);
 | 
			
		||||
        if (StringUtil.isTypableChar(terminalChar)) computer.charTyped((byte) terminalChar);
 | 
			
		||||
        return true;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
@@ -88,7 +86,7 @@ public class TerminalWidget extends AbstractWidget {
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        if ((modifiers & GLFW.GLFW_MOD_CONTROL) != 0) {
 | 
			
		||||
            switch (key) {
 | 
			
		||||
            switch (KeyConverter.physicalToActual(key, scancode)) {
 | 
			
		||||
                case GLFW.GLFW_KEY_T -> {
 | 
			
		||||
                    if (terminateTimer < 0) terminateTimer = 0;
 | 
			
		||||
                }
 | 
			
		||||
@@ -112,8 +110,8 @@ public class TerminalWidget extends AbstractWidget {
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private void paste() {
 | 
			
		||||
        var clipboard = StringUtil.normaliseClipboardString(Minecraft.getInstance().keyboardHandler.getClipboard());
 | 
			
		||||
        if (!clipboard.isEmpty()) computer.queueEvent("paste", new Object[]{ clipboard });
 | 
			
		||||
        var clipboard = StringUtil.getClipboardString(Minecraft.getInstance().keyboardHandler.getClipboard());
 | 
			
		||||
        if (clipboard.remaining() > 0) computer.paste(clipboard);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
@@ -124,7 +122,7 @@ public class TerminalWidget extends AbstractWidget {
 | 
			
		||||
            computer.keyUp(key);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        switch (key) {
 | 
			
		||||
        switch (KeyConverter.physicalToActual(key, scancode)) {
 | 
			
		||||
            case GLFW.GLFW_KEY_T -> terminateTimer = -1;
 | 
			
		||||
            case GLFW.GLFW_KEY_R -> rebootTimer = -1;
 | 
			
		||||
            case GLFW.GLFW_KEY_S -> shutdownTimer = -1;
 | 
			
		||||
@@ -222,7 +220,7 @@ public class TerminalWidget extends AbstractWidget {
 | 
			
		||||
 | 
			
		||||
    public void update() {
 | 
			
		||||
        if (terminateTimer >= 0 && terminateTimer < TERMINATE_TIME && (terminateTimer += 0.05f) > TERMINATE_TIME) {
 | 
			
		||||
            computer.queueEvent("terminate");
 | 
			
		||||
            computer.terminate();
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        if (shutdownTimer >= 0 && shutdownTimer < TERMINATE_TIME && (shutdownTimer += 0.05f) > TERMINATE_TIME) {
 | 
			
		||||
 
 | 
			
		||||
@@ -0,0 +1,97 @@
 | 
			
		||||
// SPDX-FileCopyrightText: 2024 The CC: Tweaked Developers
 | 
			
		||||
//
 | 
			
		||||
// SPDX-License-Identifier: MPL-2.0
 | 
			
		||||
 | 
			
		||||
package dan200.computercraft.client.model;
 | 
			
		||||
 | 
			
		||||
import com.mojang.blaze3d.vertex.PoseStack;
 | 
			
		||||
import com.mojang.blaze3d.vertex.VertexConsumer;
 | 
			
		||||
import dan200.computercraft.api.ComputerCraftAPI;
 | 
			
		||||
import dan200.computercraft.client.pocket.PocketComputerData;
 | 
			
		||||
import dan200.computercraft.client.render.CustomLecternRenderer;
 | 
			
		||||
import dan200.computercraft.shared.computer.core.ComputerFamily;
 | 
			
		||||
import dan200.computercraft.shared.pocket.items.PocketComputerItem;
 | 
			
		||||
import net.minecraft.client.model.geom.ModelPart;
 | 
			
		||||
import net.minecraft.client.model.geom.PartPose;
 | 
			
		||||
import net.minecraft.client.model.geom.builders.CubeListBuilder;
 | 
			
		||||
import net.minecraft.client.model.geom.builders.MeshDefinition;
 | 
			
		||||
import net.minecraft.client.renderer.LightTexture;
 | 
			
		||||
import net.minecraft.client.renderer.MultiBufferSource;
 | 
			
		||||
import net.minecraft.client.renderer.RenderType;
 | 
			
		||||
import net.minecraft.client.resources.model.Material;
 | 
			
		||||
import net.minecraft.resources.ResourceLocation;
 | 
			
		||||
import net.minecraft.util.FastColor;
 | 
			
		||||
import net.minecraft.world.inventory.InventoryMenu;
 | 
			
		||||
import net.minecraft.world.item.ItemStack;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * A model for {@linkplain PocketComputerItem pocket computers} placed on a lectern.
 | 
			
		||||
 *
 | 
			
		||||
 * @see CustomLecternRenderer
 | 
			
		||||
 */
 | 
			
		||||
public class LecternPocketModel {
 | 
			
		||||
    public static final ResourceLocation TEXTURE_NORMAL = new ResourceLocation(ComputerCraftAPI.MOD_ID, "entity/pocket_computer_normal");
 | 
			
		||||
    public static final ResourceLocation TEXTURE_ADVANCED = new ResourceLocation(ComputerCraftAPI.MOD_ID, "entity/pocket_computer_advanced");
 | 
			
		||||
    public static final ResourceLocation TEXTURE_COLOUR = new ResourceLocation(ComputerCraftAPI.MOD_ID, "entity/pocket_computer_colour");
 | 
			
		||||
    public static final ResourceLocation TEXTURE_FRAME = new ResourceLocation(ComputerCraftAPI.MOD_ID, "entity/pocket_computer_frame");
 | 
			
		||||
    public static final ResourceLocation TEXTURE_LIGHT = new ResourceLocation(ComputerCraftAPI.MOD_ID, "entity/pocket_computer_light");
 | 
			
		||||
 | 
			
		||||
    private static final Material MATERIAL_NORMAL = new Material(InventoryMenu.BLOCK_ATLAS, TEXTURE_NORMAL);
 | 
			
		||||
    private static final Material MATERIAL_ADVANCED = new Material(InventoryMenu.BLOCK_ATLAS, TEXTURE_ADVANCED);
 | 
			
		||||
    private static final Material MATERIAL_COLOUR = new Material(InventoryMenu.BLOCK_ATLAS, TEXTURE_COLOUR);
 | 
			
		||||
    private static final Material MATERIAL_FRAME = new Material(InventoryMenu.BLOCK_ATLAS, TEXTURE_FRAME);
 | 
			
		||||
    private static final Material MATERIAL_LIGHT = new Material(InventoryMenu.BLOCK_ATLAS, TEXTURE_LIGHT);
 | 
			
		||||
 | 
			
		||||
    // The size of the terminal within the model.
 | 
			
		||||
    public static final float TERM_WIDTH = 12.0f / 32.0f;
 | 
			
		||||
    public static final float TERM_HEIGHT = 14.0f / 32.0f;
 | 
			
		||||
 | 
			
		||||
    // The size of the texture. The texture is 36x36, but is at 2x resolution.
 | 
			
		||||
    private static final int TEXTURE_WIDTH = 48 / 2;
 | 
			
		||||
    private static final int TEXTURE_HEIGHT = 48 / 2;
 | 
			
		||||
 | 
			
		||||
    private final ModelPart root;
 | 
			
		||||
 | 
			
		||||
    public LecternPocketModel() {
 | 
			
		||||
        root = buildPages();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private static ModelPart buildPages() {
 | 
			
		||||
        var mesh = new MeshDefinition();
 | 
			
		||||
        var parts = mesh.getRoot();
 | 
			
		||||
        parts.addOrReplaceChild(
 | 
			
		||||
            "root",
 | 
			
		||||
            CubeListBuilder.create().texOffs(0, 0).addBox(0f, -5.0f, -4.0f, 1f, 10.0f, 8.0f),
 | 
			
		||||
            PartPose.ZERO
 | 
			
		||||
        );
 | 
			
		||||
        return mesh.getRoot().bake(TEXTURE_WIDTH, TEXTURE_HEIGHT);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private void render(PoseStack poseStack, VertexConsumer buffer, int packedLight, int packedOverlay, int colour) {
 | 
			
		||||
        int red = FastColor.ARGB32.red(colour), green = FastColor.ARGB32.green(colour), blue = FastColor.ARGB32.blue(colour), alpha = FastColor.ARGB32.alpha(colour);
 | 
			
		||||
        root.render(poseStack, buffer, packedLight, packedOverlay, red / 255.0f, green / 255.0f, blue / 255.0f, alpha / 255.0f);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Render the pocket computer model.
 | 
			
		||||
     *
 | 
			
		||||
     * @param poseStack     The current pose stack.
 | 
			
		||||
     * @param bufferSource  The buffer source to draw to.
 | 
			
		||||
     * @param packedLight   The current light level.
 | 
			
		||||
     * @param packedOverlay The overlay texture (used for entity hurt animation).
 | 
			
		||||
     * @param family        The computer family.
 | 
			
		||||
     * @param frameColour   The pocket computer's {@linkplain PocketComputerItem#getColour(ItemStack) colour}.
 | 
			
		||||
     * @param lightColour   The pocket computer's {@linkplain PocketComputerData#getLightState() light colour}.
 | 
			
		||||
     */
 | 
			
		||||
    public void render(PoseStack poseStack, MultiBufferSource bufferSource, int packedLight, int packedOverlay, ComputerFamily family, int frameColour, int lightColour) {
 | 
			
		||||
        if (frameColour != -1) {
 | 
			
		||||
            root.render(poseStack, MATERIAL_FRAME.buffer(bufferSource, RenderType::entityCutout), packedLight, packedOverlay, 1, 1, 1, 1);
 | 
			
		||||
            render(poseStack, MATERIAL_COLOUR.buffer(bufferSource, RenderType::entityCutout), packedLight, packedOverlay, frameColour);
 | 
			
		||||
        } else {
 | 
			
		||||
            var buffer = (family == ComputerFamily.ADVANCED ? MATERIAL_ADVANCED : MATERIAL_NORMAL).buffer(bufferSource, RenderType::entityCutout);
 | 
			
		||||
            root.render(poseStack, buffer, packedLight, packedOverlay, 1, 1, 1, 1);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        render(poseStack, MATERIAL_LIGHT.buffer(bufferSource, RenderType::entityCutout), LightTexture.FULL_BRIGHT, packedOverlay, lightColour);
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -13,8 +13,8 @@ import net.minecraft.client.resources.model.BakedModel;
 | 
			
		||||
import net.minecraft.core.Direction;
 | 
			
		||||
import org.joml.Matrix4f;
 | 
			
		||||
import org.joml.Vector4f;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.ArrayList;
 | 
			
		||||
import java.util.List;
 | 
			
		||||
 | 
			
		||||
 
 | 
			
		||||
@@ -20,8 +20,8 @@ import net.minecraft.client.Minecraft;
 | 
			
		||||
import net.minecraft.client.resources.model.BakedModel;
 | 
			
		||||
import net.minecraft.resources.ResourceLocation;
 | 
			
		||||
import net.minecraft.world.item.ItemStack;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.ArrayList;
 | 
			
		||||
import java.util.List;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
 
 | 
			
		||||
@@ -26,8 +26,8 @@ import net.minecraft.resources.ResourceLocation;
 | 
			
		||||
import net.minecraft.sounds.SoundEvent;
 | 
			
		||||
import net.minecraft.world.entity.player.Player;
 | 
			
		||||
import net.minecraft.world.level.Level;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.UUID;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 
 | 
			
		||||
@@ -13,8 +13,7 @@ import net.minecraft.core.BlockPos;
 | 
			
		||||
import net.minecraft.network.protocol.Packet;
 | 
			
		||||
import net.minecraft.network.protocol.game.ServerGamePacketListener;
 | 
			
		||||
import net.minecraft.sounds.SoundEvent;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
public interface ClientPlatformHelper extends dan200.computercraft.impl.client.ClientPlatformHelper {
 | 
			
		||||
    static ClientPlatformHelper get() {
 | 
			
		||||
@@ -39,7 +38,7 @@ public interface ClientPlatformHelper extends dan200.computercraft.impl.client.C
 | 
			
		||||
     * @param overlayLight  The current overlay light.
 | 
			
		||||
     * @param tints         Block colour tints to apply to the model.
 | 
			
		||||
     */
 | 
			
		||||
    void renderBakedModel(PoseStack transform, MultiBufferSource buffers, BakedModel model, int lightmapCoord, int overlayLight, @Nullable int[] tints);
 | 
			
		||||
    void renderBakedModel(PoseStack transform, MultiBufferSource buffers, BakedModel model, int lightmapCoord, int overlayLight, int @Nullable [] tints);
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Play a record at a particular position.
 | 
			
		||||
 
 | 
			
		||||
@@ -10,8 +10,8 @@ import dan200.computercraft.shared.computer.terminal.TerminalState;
 | 
			
		||||
import dan200.computercraft.shared.network.client.PocketComputerDataMessage;
 | 
			
		||||
import dan200.computercraft.shared.pocket.items.PocketComputerItem;
 | 
			
		||||
import net.minecraft.world.item.ItemStack;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import java.util.HashMap;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
import java.util.UUID;
 | 
			
		||||
 
 | 
			
		||||
@@ -8,8 +8,7 @@ import dan200.computercraft.shared.computer.core.ComputerState;
 | 
			
		||||
import dan200.computercraft.shared.computer.terminal.NetworkedTerminal;
 | 
			
		||||
import dan200.computercraft.shared.computer.terminal.TerminalState;
 | 
			
		||||
import dan200.computercraft.shared.pocket.core.PocketServerComputer;
 | 
			
		||||
 | 
			
		||||
import javax.annotation.Nullable;
 | 
			
		||||
import org.jspecify.annotations.Nullable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Clientside data about a pocket computer.
 | 
			
		||||
 
 | 
			
		||||
@@ -6,15 +6,29 @@ package dan200.computercraft.client.render;
 | 
			
		||||
 | 
			
		||||
import com.mojang.blaze3d.vertex.PoseStack;
 | 
			
		||||
import com.mojang.math.Axis;
 | 
			
		||||
import dan200.computercraft.client.model.LecternPocketModel;
 | 
			
		||||
import dan200.computercraft.client.model.LecternPrintoutModel;
 | 
			
		||||
import dan200.computercraft.client.pocket.ClientPocketComputers;
 | 
			
		||||
import dan200.computercraft.client.render.text.FixedWidthFontRenderer;
 | 
			
		||||
import dan200.computercraft.core.terminal.Terminal;
 | 
			
		||||
import dan200.computercraft.core.util.Colour;
 | 
			
		||||
import dan200.computercraft.shared.ModRegistry;
 | 
			
		||||
import dan200.computercraft.shared.lectern.CustomLecternBlockEntity;
 | 
			
		||||
import dan200.computercraft.shared.media.items.PrintoutItem;
 | 
			
		||||
import dan200.computercraft.shared.pocket.items.PocketComputerItem;
 | 
			
		||||
import dan200.computercraft.shared.util.ARGB32;
 | 
			
		||||
import net.minecraft.client.renderer.MultiBufferSource;
 | 
			
		||||
import net.minecraft.client.renderer.RenderType;
 | 
			
		||||
import net.minecraft.client.renderer.blockentity.BlockEntityRenderDispatcher;
 | 
			
		||||
import net.minecraft.client.renderer.blockentity.BlockEntityRenderer;
 | 
			
		||||
import net.minecraft.client.renderer.blockentity.BlockEntityRendererProvider;
 | 
			
		||||
import net.minecraft.client.renderer.blockentity.LecternRenderer;
 | 
			
		||||
import net.minecraft.world.level.block.LecternBlock;
 | 
			
		||||
import net.minecraft.world.phys.Vec3;
 | 
			
		||||
 | 
			
		||||
import static dan200.computercraft.client.render.ComputerBorderRenderer.MARGIN;
 | 
			
		||||
import static dan200.computercraft.client.render.text.FixedWidthFontRenderer.FONT_HEIGHT;
 | 
			
		||||
import static dan200.computercraft.client.render.text.FixedWidthFontRenderer.FONT_WIDTH;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * A block entity renderer for our {@linkplain CustomLecternBlockEntity lectern}.
 | 
			
		||||
@@ -22,10 +36,17 @@ import net.minecraft.world.level.block.LecternBlock;
 | 
			
		||||
 * This largely follows {@link LecternRenderer}, but with support for multiple types of item.
 | 
			
		||||
 */
 | 
			
		||||
public class CustomLecternRenderer implements BlockEntityRenderer<CustomLecternBlockEntity> {
 | 
			
		||||
    private static final int POCKET_TERMINAL_RENDER_DISTANCE = 32;
 | 
			
		||||
 | 
			
		||||
    private final BlockEntityRenderDispatcher berDispatcher;
 | 
			
		||||
    private final LecternPrintoutModel printoutModel;
 | 
			
		||||
    private final LecternPocketModel pocketModel;
 | 
			
		||||
 | 
			
		||||
    public CustomLecternRenderer(BlockEntityRendererProvider.Context context) {
 | 
			
		||||
        berDispatcher = context.getBlockEntityRenderDispatcher();
 | 
			
		||||
 | 
			
		||||
        printoutModel = new LecternPrintoutModel();
 | 
			
		||||
        pocketModel = new LecternPocketModel();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
@@ -37,15 +58,53 @@ public class CustomLecternRenderer implements BlockEntityRenderer<CustomLecternB
 | 
			
		||||
        poseStack.translate(0, -0.125f, 0);
 | 
			
		||||
 | 
			
		||||
        var item = lectern.getItem();
 | 
			
		||||
        if (item.getItem() instanceof PrintoutItem printout) {
 | 
			
		||||
        if (item.getItem() instanceof PrintoutItem) {
 | 
			
		||||
            var vertexConsumer = LecternPrintoutModel.MATERIAL.buffer(buffer, RenderType::entitySolid);
 | 
			
		||||
            if (printout.getType() == PrintoutItem.Type.BOOK) {
 | 
			
		||||
            if (item.is(ModRegistry.Items.PRINTED_BOOK.get())) {
 | 
			
		||||
                printoutModel.renderBook(poseStack, vertexConsumer, packedLight, packedOverlay);
 | 
			
		||||
            } else {
 | 
			
		||||
                printoutModel.renderPages(poseStack, vertexConsumer, packedLight, packedOverlay, PrintoutItem.getPageCount(item));
 | 
			
		||||
            }
 | 
			
		||||
        } else if (item.getItem() instanceof PocketComputerItem pocket) {
 | 
			
		||||
            var computer = ClientPocketComputers.get(item);
 | 
			
		||||
 | 
			
		||||
            pocketModel.render(
 | 
			
		||||
                poseStack, buffer, packedLight, packedOverlay, pocket.getFamily(), pocket.getColour(item),
 | 
			
		||||
                ARGB32.opaque(computer == null || computer.getLightState() == -1 ? Colour.BLACK.getHex() : computer.getLightState())
 | 
			
		||||
            );
 | 
			
		||||
 | 
			
		||||
            // Jiggle the terminal about a bit, so (0, 0) is in the top left of the model's terminal hole.
 | 
			
		||||
            poseStack.mulPose(Axis.YP.rotationDegrees(90f));
 | 
			
		||||
            poseStack.translate(-0.5 * LecternPocketModel.TERM_WIDTH, 0.5 * LecternPocketModel.TERM_HEIGHT + 1f / 32.0f, 1 / 16.0f);
 | 
			
		||||
            poseStack.mulPose(Axis.XP.rotationDegrees(180));
 | 
			
		||||
 | 
			
		||||
            // Either render the terminal or a black screen, depending on how close we are.
 | 
			
		||||
            var terminal = computer == null ? null : computer.getTerminal();
 | 
			
		||||
            var quadEmitter = FixedWidthFontRenderer.toVertexConsumer(poseStack, buffer.getBuffer(RenderTypes.TERMINAL));
 | 
			
		||||
            if (terminal != null && Vec3.atCenterOf(lectern.getBlockPos()).closerThan(berDispatcher.camera.getPosition(), POCKET_TERMINAL_RENDER_DISTANCE)) {
 | 
			
		||||
                renderPocketTerminal(poseStack, quadEmitter, terminal);
 | 
			
		||||
            } else {
 | 
			
		||||
                FixedWidthFontRenderer.drawEmptyTerminal(quadEmitter, 0, 0, LecternPocketModel.TERM_WIDTH, LecternPocketModel.TERM_HEIGHT);
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        poseStack.popPose();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private static void renderPocketTerminal(PoseStack poseStack, FixedWidthFontRenderer.QuadEmitter quadEmitter, Terminal terminal) {
 | 
			
		||||
        var width = terminal.getWidth() * FONT_WIDTH;
 | 
			
		||||
        var height = terminal.getHeight() * FONT_HEIGHT;
 | 
			
		||||
 | 
			
		||||
        // Scale the terminal down to fit in the available space.
 | 
			
		||||
        var scaleX = LecternPocketModel.TERM_WIDTH / (width + MARGIN * 2);
 | 
			
		||||
        var scaleY = LecternPocketModel.TERM_HEIGHT / (height + MARGIN * 2);
 | 
			
		||||
        var scale = Math.min(scaleX, scaleY);
 | 
			
		||||
        poseStack.scale(scale, scale, -1.0f);
 | 
			
		||||
 | 
			
		||||
        // Convert the model dimensions to terminal space, then find out how large the margin should be.
 | 
			
		||||
        var marginX = ((LecternPocketModel.TERM_WIDTH / scale) - width) / 2;
 | 
			
		||||
        var marginY = ((LecternPocketModel.TERM_HEIGHT / scale) - height) / 2;
 | 
			
		||||
 | 
			
		||||
        FixedWidthFontRenderer.drawTerminal(quadEmitter, marginX, marginY, terminal, marginY, marginY, marginX, marginX);
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
Some files were not shown because too many files have changed in this diff Show More
		Reference in New Issue
	
	Block a user