1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-06-26 07:03:22 +00:00
Modernized/improved/actually updated version of ComputerCraft: https://tweaked.cc
Go to file
Jonathan Coates a17b001950
Move the core API into a separate module
It should be possible to consume the ComputerCraft's core (i.e.
non-Minecraft code) in other projects, such as emulators.  While this
has been possible for years, it's somewhat tricky from a maintenance
perspective - it's very easy to accidentally add an MC dependency
somewhere!

By publishing a separate "core" jar, we can better distinguish the
boundaries between our Lua runtime and the Minecraft-specific code.

Ideally we could have one core project (rather than separate core and
core-api modules), and publish a separate "api" jar, like we do for the
main mod. However, this isn't really possible to express using Maven
dependencies, and so we must resort to this system.

Of course, this is kinda what the Java module system is meant to solve,
but unfortunately getting that working with Minecraft is infeasible.
2022-11-04 21:41:59 +00:00
.github Merge branch 'mc-1.16.x' into mc-1.18.x 2022-10-25 22:38:26 +01:00
buildSrc Move the core API into a separate module 2022-11-04 21:41:59 +00:00
config Reformat everything 2022-11-04 13:41:38 +00:00
doc Add a couple of tests for file autocompletion 2022-11-01 19:22:07 +00:00
gradle Move the core API into a separate module 2022-11-04 21:41:59 +00:00
projects Move the core API into a separate module 2022-11-04 21:41:59 +00:00
src Move the core API into a separate module 2022-11-04 21:41:59 +00:00
tools Merge branch 'mc-1.16.x' into mc-1.17.x 2021-10-06 18:10:45 +01:00
.editorconfig Reformat everything 2022-11-04 13:41:38 +00:00
.git-blame-ignore-revs Exclude the previous commit from git blame 2022-11-04 13:42:00 +00:00
.gitattributes Move some eldritch horrors to another directory 2022-06-01 01:02:26 +01:00
.gitignore Move the core API into a separate module 2022-11-04 21:41:59 +00:00
.gitpod.yml Use a Gradle plugin to download illuaminate 2022-09-11 14:11:33 +01:00
.pre-commit-config.yaml Use spotless for enforcing licenses 2022-10-22 18:19:51 +01:00
build.gradle.kts Move the core API into a separate module 2022-11-04 21:41:59 +00:00
CODE_OF_CONDUCT.md Add a code of conduct 2022-07-08 22:08:50 +01:00
CONTRIBUTING.md Move some more build logic to buildSrc 2022-10-22 20:47:47 +01:00
gradle.properties Bump CC:T to 1.101.1 2022-11-03 20:41:47 +00:00
gradlew Bump Gradle and Kotlin versions 2021-11-26 21:12:20 +00:00
gradlew.bat Bump Gradle/ForgeGradle version 2021-02-13 12:39:52 +00:00
illuaminate.sexp Convert build script to Kotlin 2022-10-22 21:09:08 +01:00
LICENSE Add a pre commit hook to lint code 2021-04-28 21:24:27 +01:00
package-lock.json Update npm packages 2022-07-21 20:38:44 +01:00
package.json Update npm packages 2022-07-21 20:38:44 +01:00
README.md Make IRC links https 2022-10-09 11:22:24 +01:00
rollup.config.js Add speaker support to the documentation website 2021-12-21 22:20:57 +00:00
settings.gradle.kts Move the core API into a separate module 2022-11-04 21:41:59 +00:00
tsconfig.json Add more eldritch horrors to the build system 2022-06-01 00:48:36 +01:00

CC: Tweaked

Current build status Download CC: Tweaked on CurseForge

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

CC: Tweaked can be installed from CurseForge or Modrinth. It requires the Minecraft Forge mod loader, but versions are available for 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 'org.squiddev'
    }
  }
}

dependencies {
  compileOnly fg.deobf("org.squiddev:cc-tweaked-${mc_version}:${cct_version}:api")
  runtimeOnly fg.deobf("org.squiddev:cc-tweaked-${mc_version}:${cct_version}")
}

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.