mirror of
https://github.com/SquidDev-CC/CC-Tweaked
synced 2024-12-14 12:10:30 +00:00
3920ff08ab
- 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.
62 lines
3.5 KiB
Markdown
62 lines
3.5 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: 2020 The CC: Tweaked Developers
|
|
|
|
SPDX-License-Identifier: MPL-2.0
|
|
-->
|
|
|
|
# ![CC: Tweaked](logo.png)
|
|
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].
|
|
|
|
## Features
|
|
Controlled using the [Lua programming language][lua], CC: Tweaked's computers provides all the tools you need to start
|
|
writing code and automating your Minecraft world.
|
|
|
|
![A ComputerCraft terminal open and ready to be programmed.](images/basic-terminal.png){.big-image}
|
|
|
|
While computers are incredibly powerful, they're rather limited by their inability to move about. *Turtles* are the
|
|
solution here. They can move about the world, placing and breaking blocks, swinging a sword to protect you from zombies,
|
|
or whatever else you program them to!
|
|
|
|
![A turtle tunneling in Minecraft.](images/turtle.png){.big-image}
|
|
|
|
Not all problems can be solved with a pickaxe though, and so CC: Tweaked also provides a bunch of additional peripherals
|
|
for your computers. You can play a tune with speakers, display text or images on a monitor, connect all your
|
|
computers together with modems, and much more.
|
|
|
|
Computers can now also interact with inventories such as chests, allowing you to build complex inventory and item
|
|
management systems.
|
|
|
|
![A chest's contents being read by a computer and displayed on a monitor.](images/peripherals.png){.big-image}
|
|
|
|
## Getting Started
|
|
While ComputerCraft is lovely for both experienced programmers and for people who have never coded before, it can be a
|
|
little daunting getting started. Thankfully, there's several fantastic tutorials out there:
|
|
|
|
- [Direwolf20's ComputerCraft tutorials](https://www.youtube.com/watch?v=wrUHUhfCY5A "ComputerCraft Tutorial Episode 1 - HELP! and Hello World")
|
|
- [Sethbling's ComputerCraft series](https://www.youtube.com/watch?v=DSsx4VSe-Uk "Programming Tutorial with Minecraft Turtles -- Ep. 1: Intro to Turtles and If-Then-Else_End")
|
|
- [Lyqyd's Computer Basics 1](http://www.computercraft.info/forums2/index.php?/topic/15033-computer-basics-i/ "Computer Basics I")
|
|
|
|
Once you're a little more familiar with the mod, the sidebar and links below provide more detailed documentation on the
|
|
various APIs and peripherals provided by the mod.
|
|
|
|
If you get stuck, do [ask a question on GitHub][GitHub Discussions] or pop in to the ComputerCraft's [IRC channel][IRC].
|
|
|
|
## Get Involved
|
|
CC: Tweaked lives on [GitHub]. If you've got any ideas, feedback or bugs please do [create an issue][bug].
|
|
|
|
[github]: https://github.com/cc-tweaked/CC-Tweaked/ "CC: Tweaked on GitHub"
|
|
[bug]: https://github.com/cc-tweaked/CC-Tweaked/issues/new/choose
|
|
[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."
|
|
[Minecraft Forge]: https://files.minecraftforge.net/ "Download Minecraft Forge."
|
|
[Fabric]: https://fabricmc.net/use/installer/ "Download Fabric."
|
|
[lua]: https://www.lua.org/ "Lua's main website"
|
|
[GitHub Discussions]: https://github.com/cc-tweaked/CC-Tweaked/discussions
|
|
[IRC]: https://webchat.esper.net/?channels=computercraft "#computercraft on EsperNet"
|