71669cf49c
This is the second time I've rewritten our class generation in a little over a month. Oh dear! Back in d562a051c7b3b114d6821c4a3a5d9d025a782f0a we started using method handles inside our generated ASM, effectively replacing a direct call with .invokeExact on a constant method handle. This goes one step further and removes our ASM entirely, building up a MethodHandle that checks arguments and then wraps the return value. Rather than generating a class, we just return a new LuaFunction instance that invokeExacts the method handle. This is definitely slower than what we had before, but in the order of 8ns vs 12ns (in the worst case, sometimes they're much more comparable), so I'm not too worried in practice. However, generation of the actual method is now a bit faster. I've not done any proper benchmarking, but it's about 20-30% faster. This also gives us a bit more flexibility in the future, for instance uisng bound MethodHandles in generation (e.g. for instance methods on GenericSources). Not something I'm planning on doing right now, but is an option.
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:$cctVersion")
// 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")
}
When using ForgeGradle, you may also need to add the following:
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, 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.