mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-11-16 23:04:53 +00:00
ab6b861cd6
Let's see how this goes. - Update references to the new repo - Use rrsync on the server, meaning make-doc.sh uploads relative to the website root. - Bump Gradle wrapper to 7.2. Not related to this change, but possibly fixes running under Java 16. Possibly.
54 lines
2.8 KiB
Markdown
54 lines
2.8 KiB
Markdown
# 
|
|
[](https://github.com/cc-tweaked/CC-Tweaked/actions "Current build status") [][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][forge] mod loader, but
|
|
[versions are available for Fabric][ccrestitched].
|
|
|
|
## 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](CONTRIBUTING.md#developing).
|
|
|
|
## 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](https://forums.computercraft.cc/) and [Discord guild](https://discord.computercraft.cc)!
|
|
There's also a fairly populated, albeit quiet [IRC channel](http://webchat.esper.net/?channels=computercraft), if that's
|
|
more your cup of tea.
|
|
|
|
We also host fairly comprehensive documentation at [tweaked.cc](https://tweaked.cc/ "The CC: Tweaked website").
|
|
|
|
## 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.
|
|
|
|
```groovy
|
|
repositories {
|
|
maven {
|
|
url 'https://squiddev.cc/maven/'
|
|
content {
|
|
includeGroup 'org.squiddev'
|
|
}
|
|
}
|
|
}
|
|
|
|
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.
|
|
|
|
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](https://tweaked.cc/javadoc/).
|
|
|
|
[computercraft]: https://github.com/dan200/ComputerCraft "ComputerCraft on GitHub"
|
|
[curseforge]: https://minecraft.curseforge.com/projects/cc-tweaked "Download CC: Tweaked from CurseForge"
|
|
[modrinth]: https://modrinth.com/mod/gu7yAYhd "Download CC: Tweaked from Modrinth"
|
|
[forge]: https://files.minecraftforge.net/ "Download Minecraft Forge."
|
|
[ccrestitched]: https://www.curseforge.com/minecraft/mc-mods/cc-restitched "Download CC: Restitched from CurseForge"
|