mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-11-10 20:09:58 +00:00
Code Issues Releases Wiki Activity
cd9840d1c1
CC-Tweaked/doc/index.md

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

62 lines
3.6 KiB
Markdown
Raw Normal View History

License CC:T according to the REUSE specification (#1351) This adds SPDX license headers to all source code files, following the REUSE[1] specification. This does not include any asset files (such as generated JSON files, or textures). While REUSE does support doing so with ".license" files, for now we define these licences using the .reuse/dep5 file. [1]: https://reuse.software/
2023-03-15 21:52:13 +00:00
<!--
SPDX-FileCopyrightText: 2020 The CC: Tweaked Developers
SPDX-License-Identifier: MPL-2.0
-->
Some doc updates - Fix some spacing in code blocks - Rewrite the index page - You can't see it, but update illuaminate.
2021-08-13 21:35:08 +00:00
# ![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
Some README cleanup - 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.
2023-04-06 17:13:55 +00:00
much-beloved [ComputerCraft], it continues its legacy with improved performance and stability, along with a wealth of
new features.
An initial stab at documentation generation (#360) This adds documentation comments to many of CC's Lua APIs, and a couple of the Java ones, through the use of stubs. We then export these to HTML using illuaminate [1] and upload them to our documentation site [2]. Uploads currently occur on pushes to master and any release/tag. The site is entirely static - there is no way to switch between versions, etc... but hopefully we can improve this in the future. [1]: github.com/SquidDev/illuaminate/ [2]: https://tweaked.cc/
2020-04-10 09:27:53 +00:00
Some README cleanup - 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.
2023-04-06 17:13:55 +00:00
CC: Tweaked can be installed from [CurseForge] or [Modrinth]. It runs on both [Minecraft Forge] and [Fabric].
An initial stab at documentation generation (#360) This adds documentation comments to many of CC's Lua APIs, and a couple of the Java ones, through the use of stubs. We then export these to HTML using illuaminate [1] and upload them to our documentation site [2]. Uploads currently occur on pushes to master and any release/tag. The site is entirely static - there is no way to switch between versions, etc... but hopefully we can improve this in the future. [1]: github.com/SquidDev/illuaminate/ [2]: https://tweaked.cc/
2020-04-10 09:27:53 +00:00
Some doc updates - Fix some spacing in code blocks - Rewrite the index page - You can't see it, but update illuaminate.
2021-08-13 21:35:08 +00:00
## 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.
An initial stab at documentation generation (#360) This adds documentation comments to many of CC's Lua APIs, and a couple of the Java ones, through the use of stubs. We then export these to HTML using illuaminate [1] and upload them to our documentation site [2]. Uploads currently occur on pushes to master and any release/tag. The site is entirely static - there is no way to switch between versions, etc... but hopefully we can improve this in the future. [1]: github.com/SquidDev/illuaminate/ [2]: https://tweaked.cc/
2020-04-10 09:27:53 +00:00
Bump illuaminate version This has a new Markdown parser, so we need to remove our use of image attributes.
2023-08-23 17:09:06 +00:00
<img alt="A ComputerCraft terminal open and ready to be programmed." src="images/basic-terminal.png" class="big-image" />
Some doc updates - Fix some spacing in code blocks - Rewrite the index page - You can't see it, but update illuaminate.
2021-08-13 21:35:08 +00:00
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!
Bump illuaminate version This has a new Markdown parser, so we need to remove our use of image attributes.
2023-08-23 17:09:06 +00:00
<img alt="A turtle tunneling in Minecraft." src="images/turtle.png" class="big-image" />
Some doc updates - Fix some spacing in code blocks - Rewrite the index page - You can't see it, but update illuaminate.
2021-08-13 21:35:08 +00:00
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.
Bump illuaminate version This has a new Markdown parser, so we need to remove our use of image attributes.
2023-08-23 17:09:06 +00:00
<img alt="A chest's contents being read by a computer and displayed on a monitor." src="images/peripherals.png" class="big-image" />
Some doc updates - Fix some spacing in code blocks - Rewrite the index page - You can't see it, but update illuaminate.
2021-08-13 21:35:08 +00:00
## 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.
Improve community links a little
2022-09-29 21:01:51 +00:00
If you get stuck, do [ask a question on GitHub][GitHub Discussions] or pop in to the ComputerCraft's [IRC channel][IRC].
Some doc updates - Fix some spacing in code blocks - Rewrite the index page - You can't see it, but update illuaminate.
2021-08-13 21:35:08 +00:00
## Get Involved
CC: Tweaked lives on [GitHub]. If you've got any ideas, feedback or bugs please do [create an issue][bug].
Move repo to cc-tweaked org 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.
2021-10-17 17:14:22 +00:00
[github]: https://github.com/cc-tweaked/CC-Tweaked/ "CC: Tweaked on GitHub"
[bug]: https://github.com/cc-tweaked/CC-Tweaked/issues/new/choose
Rewrite our documentation index We're going to flesh this out a lot in the future, but this'll have to do for now.
2020-04-16 17:18:36 +00:00
[computercraft]: https://github.com/dan200/ComputerCraft "ComputerCraft on GitHub"
Some doc updates - Fix some spacing in code blocks - Rewrite the index page - You can't see it, but update illuaminate.
2021-08-13 21:35:08 +00:00
[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."
Some README cleanup - 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.
2023-04-06 17:13:55 +00:00
[Minecraft Forge]: https://files.minecraftforge.net/ "Download Minecraft Forge."
[Fabric]: https://fabricmc.net/use/installer/ "Download Fabric."
Some doc updates - Fix some spacing in code blocks - Rewrite the index page - You can't see it, but update illuaminate.
2021-08-13 21:35:08 +00:00
[lua]: https://www.lua.org/ "Lua's main website"
Improve community links a little
2022-09-29 21:01:51 +00:00
[GitHub Discussions]: https://github.com/cc-tweaked/CC-Tweaked/discussions
Make IRC links https
2022-10-09 10:22:24 +00:00
[IRC]: https://webchat.esper.net/?channels=computercraft "#computercraft on EsperNet"
Reference in New Issue Copy Permalink