9f8774960f
illuaminate does not handle Java files, for obvious reasons. In order to get around that, we have a series of stub files within /doc/stub which mirrored the Java ones. While this works, it has a few problems: - The link to source code does not work - it just links to the stub file. - There's no guarantee that documentation remains consistent with the Java code. This change found several methods which were incorrectly documented beforehand. We now replace this with a custom Java doclet[1], which extracts doc comments from @LuaFunction annotated methods and generates stub-files from them. These also contain a @source annotation, which allows us to correctly link them back to the original Java code. There's some issues with this which have yet to be fixed. However, I don't think any of them are major blockers right now: - The custom doclet relies on Java 9 - I think it's /technically/ possible to do this on Java 8, but the API is significantly uglier. This means that we need to run javadoc on a separate JVM. This is possible, and it works locally and on CI, but is definitely not a nice approach. - illuaminate now requires the doc stubs to be generated in order for the linter to pass, which does make running the linter locally much harder (especially given the above bullet point). We could notionally include the generated stubs (or at least a cut down version of them) in the repo, but I'm not 100% sure about that. [1]: https://docs.oracle.com/javase/9/docs/api/jdk/javadoc/doclet/package-summary.html |
||
---|---|---|
.github | ||
config | ||
doc | ||
gradle/wrapper | ||
src | ||
tools | ||
.editorconfig | ||
.gitattributes | ||
.gitignore | ||
build.gradle | ||
CONTRIBUTING.md | ||
gradle.properties | ||
gradlew | ||
gradlew.bat | ||
illuaminate.sexp | ||
LICENSE | ||
README.md | ||
settings.gradle |
CC: Tweaked is a fork of ComputerCraft, adding programmable computers, turtles and more to Minecraft.
What?
ComputerCraft has always held a fond place in my heart: it's the mod which really got me into Minecraft, and it's the mod which has kept me playing it for many years. However, development of the original mod has slowed, as the original developers have had less time to work on the mod, and moved onto other projects and commitments.
CC: Tweaked (or CC:T for short) is an attempt to continue ComputerCraft's legacy. It's not intended to be a competitor to CC, nor do I want to take it in a vastly different direction to the original mod. Instead, CC:T focuses on making the ComputerCraft experience as solid as possible, ironing out any wrinkles that may have developed over time.
Features
CC: Tweaked contains all the features of the latest version of ComputerCraft, as well as numerous fixes, performance improvements and several nifty additions. I'd recommend checking out the releases page to see the full set of changes, but here's a couple of the more interesting additions:
- Improvements to the
http
library, including websockets, support for other HTTP methods (PUT
,DELETE
, etc...) and configurable limits on HTTP usage. - Full-block wired modems, allowing one to wrap non-solid peripherals (such as turtles, or chests if Plethora is installed).
- Pocket computers can be held like maps, allowing you to view the screen without entering a GUI.
- Printed pages and books can be placed in item frames and held like maps.
- Several profiling and administration tools for server owners, via the
/computercraft
command. This allows operators to track which computers are hogging resources, turn on and shutdown multiple computers at once and interact with computers remotely. - Closer emulation of standard Lua, adding the
debug
andio
libraries. This also enables seeking within binary files, meaning you don't need to read large files into memory. - Allow running multiple computers on multiple threads, reducing latency on worlds with many computers.
Relation to CCTweaks?
This mod has nothing to do with CCTweaks, though there is no denying the name is a throwback to it. That being said, several features have been included, such as full block modems, the Cobalt runtime and map-like rendering for pocket computers.
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 we have a forum and Discord guild! There's also a fairly populated, albeit quiet IRC channel, if that's more your cup of tea.
I'd generally recommend you don't contact me directly (email, DM, etc...) unless absolutely necessary (i.e. in order to report exploits). You'll get a far quicker response if you ask the whole community!
Using
If you want to depend on CC: Tweaked, we have a maven repo. However, you should be wary that some functionality is only exposed by CC:T's API and not vanilla ComputerCraft. If you wish to support all variations of ComputerCraft, I recommend using cc.crzd.me's maven instead.
dependencies {
maven { url 'https://squiddev.cc/maven/' }
}
dependencies {
implementation 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.