From b21c495815ade6903d4717b2d78046d5945890b7 Mon Sep 17 00:00:00 2001 From: SquidDev Date: Tue, 15 May 2018 12:25:04 +0100 Subject: [PATCH] Update the README to be a bit more detailed - Include a list of features, pretty similar to that on the forum thread or CurseForge page. - Replace CC: Tweaked with CC:T. After all, who wants to type all of that? --- README.md | 36 ++++++++++++++++++++++++++---------- 1 file changed, 26 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 710856a5c..dfd8b9011 100644 --- a/README.md +++ b/README.md @@ -6,26 +6,42 @@ # ![CC: Tweaked](logo.png) [original mod](https://github.com/dan200/ComputerCraft). ## What? -CC: Tweaked does not aim to create a competing fork of ComputerCraft, nor am I planning to take it in in a vastly -different direction to the original mod. In fact, CC: Tweaked aims to be a nurturing ground for various features, with -a pull request against the original mod being the end goal. +CC: Tweaked (or CC:T for short) does not aim to create a competing fork of ComputerCraft, nor am I planning to take it +in in a vastly different direction to the original mod. In fact, CC:T aims to be a nurturing ground for various +features, with a pull request against the original mod being the end goal. -CC: Tweaked also includes many pull requests from the community which have not yet been merged, offering a large number +CC:T also includes many pull requests from the community which have not yet been merged, offering a large number of additional bug fixes and features over the original mod. +## Features +CC: Tweaked contains the all features of the latest alpha, as well as numerous fixes, performance improvements and +several additional features. I'd recommend checking out [the releases page](https://github.com/SquidDev-CC/CC-Tweaked/releases) +to see the full changes, but here's a couple of the more interesting changes: + + - Replace LuaJ with Cobalt. + - Allow running multiple computers at the same time. + - Websocket support in the HTTP library. + - Wired modems and cables act more like multiparts. + - Add map-like rendering for pocket computers. + - Adds the `/computercraft` command, offering various diagnostic tools for server owners. This allows operators to + track which computers are hogging resources, turn on and shutdown multiple computers at once and interact with + computers remotely. + - Add full-block wired modems, allowing one to wrap non-solid peripherals (such as turtles, or chests if Plethora is + installed). + ## Relation to CCTweaks? -This mod has nothing to do with CCTweaks, though there is no denying the name is a throwback to it. However, I do plan -to migrate some features of CCTweaks into CC: Tweaked. +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 do wish to contribute code, do consider submitting it to the ComputerCraft repository instead. -That being said, in order to start helping develop CC: Tweaked, you'll need to follow these steps: +That being said, in order to start helping develop CC:T, you'll need to follow these steps: - **Clone the repository:** `git clone https://github.com/SquidDev-CC/CC-Tweaked.git && cd CC-Tweaked` - **Setup Forge:** `./gradlew setupDecompWorkspace` - **Test your changes:** `./gradlew runClient` (or run the `GradleStart` class from your IDE). - -If you want to run CC: Tweaked in a normal Minecraft instance, run `./gradlew build` and copy the `.jar` from -`build/libs`. + +If you want to run CC:T in a normal Minecraft instance, run `./gradlew build` and copy the `.jar` from `build/libs`.