1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-12-12 11:10:29 +00:00
Modernized/improved/actually updated version of ComputerCraft: https://tweaked.cc
Go to file
Jonathan Coates 3920ff08ab
Some README cleanup
- Standardise our badges a little, adding a modrinth badge.
 - Mention Fabric and Forge support.
 - Don't include MC version in the Modrinth version number. I feel this
   was required at some point, but apparently not any more! This also
   allows us to use Modrinth for the Forge update JSON.
2023-04-06 18:18:40 +01:00
.github Improve our CI artifacts 2023-01-01 15:04:25 +00:00
.reuse Further licensing work 2023-03-29 23:00:18 +01:00
buildSrc Some README cleanup 2023-04-06 18:18:40 +01:00
config Further licensing work 2023-03-29 23:00:18 +01:00
doc Some README cleanup 2023-04-06 18:18:40 +01:00
gradle Bump CC:T to 1.104.0 2023-04-05 20:50:01 +01:00
LICENSES License CC:T according to the REUSE specification (#1351) 2023-03-15 21:52:13 +00:00
projects Some README cleanup 2023-04-06 18:18:40 +01:00
tools License CC:T according to the REUSE specification (#1351) 2023-03-15 21:52:13 +00:00
.editorconfig License CC:T according to the REUSE specification (#1351) 2023-03-15 21:52:13 +00:00
.git-blame-ignore-revs License CC:T according to the REUSE specification (#1351) 2023-03-15 21:52:13 +00:00
.gitattributes License CC:T according to the REUSE specification (#1351) 2023-03-15 21:52:13 +00:00
.gitignore Turtle flags 2023-03-31 18:14:44 +01:00
.gitpod.yml Further licensing work 2023-03-29 23:00:18 +01:00
.pre-commit-config.yaml License CC:T according to the REUSE specification (#1351) 2023-03-15 21:52:13 +00:00
build.gradle.kts License CC:T according to the REUSE specification (#1351) 2023-03-15 21:52:13 +00:00
CODE_OF_CONDUCT.md License CC:T according to the REUSE specification (#1351) 2023-03-15 21:52:13 +00:00
CONTRIBUTING.md License CC:T according to the REUSE specification (#1351) 2023-03-15 21:52:13 +00:00
gradle.properties Bump CC:T to 1.104.0 2023-04-05 20:50:01 +01:00
gradlew Bump dependency versions 2023-03-14 18:43:42 +00:00
gradlew.bat Bump dependency versions 2023-03-14 18:43:42 +00:00
illuaminate.sexp License CC:T according to the REUSE specification (#1351) 2023-03-15 21:52:13 +00:00
package-lock.json Bump dependency versions 2023-03-14 18:43:42 +00:00
package.json Bump dependency versions 2023-03-14 18:43:42 +00:00
README.md Some README cleanup 2023-04-06 18:18:40 +01:00
settings.gradle.kts License CC:T according to the REUSE specification (#1351) 2023-03-15 21:52:13 +00:00

CC: Tweaked

Current build status Download CC: Tweaked on CurseForge Download CC: Tweaked on Modrinth

CC: Tweaked is a mod for Minecraft which adds programmable computers, turtles and more to the game. A fork of the much-beloved ComputerCraft, it continues its legacy with improved performance and stability, along with a wealth of new features.

CC: Tweaked can be installed from CurseForge or Modrinth. It runs on both Minecraft Forge and Fabric.

Contributing

Any contribution is welcome, be that using the mod, reporting bugs or contributing code. If you want to get started developing the mod, check out the instructions here.

Community

If you need help getting started with CC: Tweaked, want to show off your latest project, or just want to chat about ComputerCraft, do check out our forum and GitHub discussions page! There's also a fairly populated, albeit quiet IRC channel, if that's more your cup of tea.

We also host fairly comprehensive documentation at tweaked.cc.

Using

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

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

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

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

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

You should also be careful to only use classes within the dan200.computercraft.api package. Non-API classes are subject to change at any point. If you depend on functionality outside the API, file an issue, and we can look into exposing more features.

We bundle the API sources with the jar, so documentation should be easily viewable within your editor. Alternatively, the generated documentation can be browsed online.