mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2025-02-22 14:00:09 +00:00
3c46b8acd7
I've no motivation for modding right now, but always got time for build
system busywork!
CC:T (and CC before that) has always published its API docs. However,
they're not always the most helpful — they're useful if you know what
you're looking for, but aren't a good getting-started guide.
Part of the issue here is there's no examples, and everything is
described pretty abstractly. I have occasionally tried to improve this
(e.g. the peripheral docs in bdffabc08e2eb9895f966c949acc8334a2bf4475),
but it's a long road.
This commit adds a new example mod, which registers peripherals, an API
and a turtle upgrade. While the mod itself isn't exported as part of the
docs, we reference blocks of it using Java's new {@snippet} tag.
- Switch the Forge project to use NeoForge's new Legacy MDG plugin. We
don't *need* to do this, but it means the build logic for Forge and
NeoForge is more closely aligned.
- Add a new SnippetTaglet, which is a partial backport of Java 18+'s
{@snippet}.
- Add an example mod. This is a working multi-loader mod, complete with
datagen (albeit with no good multi-loader abstractions).
- Move our existing <pre>{@code ...}</pre> blocks into the example mod,
replacing them with {@snippet}s.
- Add a new overview page to the docs, providing some getting-started
information. We had this already in the dan200.computercraft.api
package docs, but it's not especially visible there.
108 lines
4.9 KiB
TOML
108 lines
4.9 KiB
TOML
# SPDX-FileCopyrightText: 2017 The CC: Tweaked Developers
|
|
#
|
|
# SPDX-License-Identifier: MPL-2.0
|
|
|
|
version = 1
|
|
SPDX-PackageName = "CC: Tweaked"
|
|
SPDX-PackageSupplier = "Jonathan Coates <git@squiddev.cc>"
|
|
SPDX-PackageDownloadLocation = "https://github.com/cc-tweaked/cc-tweaked"
|
|
|
|
[[annotations]]
|
|
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/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]]
|
|
# Several assets where it's inconvenient to create a .license file.
|
|
SPDX-FileCopyrightText = "The CC: Tweaked Developers"
|
|
SPDX-License-Identifier = "MPL-2.0"
|
|
path = [
|
|
"doc/images/**",
|
|
"package.json",
|
|
"package-lock.json",
|
|
"projects/common/src/client/resources/computercraft-client.mixins.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/src/client/resources/computercraft-client.fabric.mixins.json",
|
|
"projects/fabric/src/datagen/resources/fabric.mod.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/web/src/frontend/mount/.settings",
|
|
"projects/web/src/frontend/mount/example.nfp",
|
|
"projects/web/src/frontend/mount/example.nft",
|
|
"projects/web/src/frontend/mount/expr_template.lua",
|
|
"projects/web/tsconfig.json",
|
|
]
|
|
|
|
[[annotations]]
|
|
# Bulk-license original assets as CCPL.
|
|
SPDX-FileCopyrightText = "2011 Daniel Ratcliffe"
|
|
SPDX-License-Identifier = "LicenseRef-CCPL"
|
|
path = [
|
|
"doc/logo.png",
|
|
"doc/logo-darkmode.png",
|
|
"projects/common/src/main/resources/assets/computercraft/models/**",
|
|
"projects/common/src/main/resources/assets/computercraft/textures/**",
|
|
"projects/common/src/main/resources/pack.mcmeta",
|
|
"projects/common/src/main/resources/pack.png",
|
|
"projects/core/src/main/resources/assets/computercraft/textures/gui/term_font.png",
|
|
"projects/core/src/main/resources/data/computercraft/lua/rom/autorun/.ignoreme",
|
|
"projects/core/src/main/resources/data/computercraft/lua/rom/help/**",
|
|
"projects/core/src/main/resources/data/computercraft/lua/rom/programs/fun/advanced/levels/**",
|
|
"projects/web/src/htmlTransform/export/items/computercraft/**",
|
|
]
|
|
|
|
[[annotations]]
|
|
# Community-contributed language files
|
|
SPDX-FileCopyrightText = "2017 The CC: Tweaked Developers"
|
|
SPDX-License-Identifier = "LicenseRef-CCPL"
|
|
path = [
|
|
"projects/common/src/main/resources/assets/computercraft/lang/cs_cz.json",
|
|
"projects/common/src/main/resources/assets/computercraft/lang/ko_kr.json",
|
|
"projects/common/src/main/resources/assets/computercraft/lang/pl_pl.json",
|
|
"projects/common/src/main/resources/assets/computercraft/lang/pt_br.json",
|
|
"projects/common/src/main/resources/assets/computercraft/lang/ru_ru.json",
|
|
"projects/common/src/main/resources/assets/computercraft/lang/uk_ua.json",
|
|
"projects/common/src/main/resources/assets/computercraft/lang/zh_cn.json",
|
|
]
|
|
|
|
[[annotations]]
|
|
# 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]]
|
|
path = ["gradle/wrapper/**"]
|
|
SPDX-FileCopyrightText = "Gradle Inc"
|
|
SPDX-License-Identifier = "Apache-2.0"
|
|
|
|
[[annotations]]
|
|
path = "projects/core/src/test/resources/test-rom/data/json-parsing/**"
|
|
SPDX-FileCopyrightText = "2016 Nicolas Seriot"
|
|
SPDX-License-Identifier = "MIT"
|