mirrors/CC-Tweaked
1
0
Fork 0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-12-12 11:10:29 +00:00
Code Issues Releases Wiki Activity

Update README and versioning (#121)

Browse Source 
- Reword elements of the README, mostly changing the elements about
   vanilla ComputerCraft.
 - Change versioning scheme: we'll now do 1.x.y, with 1.81.0 being the
   next version.
 - Include MC version in the file name
 - Stop bundling javadoc with the jar. We'll look into hosting this on
   squiddev.cc if really needed.
 - Remove the LuaJ license from the root - we no longer bundle the
   sources, so it's not needed here.

I realise this change looks a little dodgey on its own, so see #113 for
the full rationale.
This commit is contained in:
SquidDev 2019-02-19 14:49:13 +00:00 committed by GitHub
parent 257a35f3ed
commit 70a226207e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 33 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
LICENSE-luaj
View File

@ -1,19 +0,0 @@
Copyright (c) 2007 LuaJ. All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

50
README.md
View File

@ -1,35 +1,35 @@
# ![CC: Tweaked](logo.png) # ![CC: Tweaked](logo.png)
[![Build Status](https://travis-ci.org/SquidDev-CC/CC-Tweaked.svg?branch=master)](https://travis-ci.org/SquidDev-CC/CC-Tweaked) [![Build Status](https://travis-ci.org/SquidDev-CC/CC-Tweaked.svg?branch=master)](https://travis-ci.org/SquidDev-CC/CC-Tweaked)
CC: Tweaked is a fork of ComputerCraft which aims to provide earlier access to the more experimental and in-development CC: Tweaked is a fork of [ComputerCraft](https://github.com/dan200/ComputerCraft), adding programmable computers,
features of the mod. For a more stable experience, I recommend checking out the turtles and more to Minecraft.
[original mod](https://github.com/dan200/ComputerCraft).
## What? ## What?
CC: Tweaked (or CC:T for short) does not aim to create a competing fork of ComputerCraft, nor am I planning to take it ComputerCraft has always held a fond place in my heart: it's the mod which really got me into Minecraft, and it's the
in in a vastly different direction to the original mod. In fact, CC:T aims to be a nurturing ground for various mod which has kept me playing it for many years. However, development of the original mod has slowed, as the original
features, with a pull request against the original mod being the end goal. developers have had less time to work on the mod, and moved onto other projects and commitments.
CC:T also includes many pull requests from the community which have not yet been merged, offering a large number CC:Tweaked (or CC:T for short) is an attempt to continue ComputerCraft's legacy. It's not intended to be a competitor
of additional bug fixes and features over the original mod. to CC, nor do I want to take it in a vastly different direction to the original mod. Instead, CC:T focuses on making the
ComputerCraft experience as _solid_ as possible, ironing out any wrinkles that may have developed over time.
## Features ## Features
CC: Tweaked contains all the features of the latest alpha, as well as numerous fixes, performance improvements and CC: Tweaked contains all the features of the latest version of ComputerCraft, as well as numerous fixes, performance
several additional features. I'd recommend checking out [the releases page](https://github.com/SquidDev-CC/CC-Tweaked/releases) improvements and several nifty additions. 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: to see the full set of changes, but here's a couple of the more interesting additions:
- Replace LuaJ with Cobalt. - Improvements to the `http` library, including websockets, support for other HTTP methods (`PUT`, `DELETE`, etc...)
- Allow running multiple computers at the same time. and configurable limits on HTTP usage.
- Websocket support in the HTTP library. - Full-block wired modems, allowing one to wrap non-solid peripherals (such as turtles, or chests if Plethora is
- Wired modems and cables act more like multiparts. installed).
- Add map-like rendering for pocket computers and printed pages/books. - Pocket computers can be held like maps, allowing you to view the screen without entering a GUI.
- Adds the `/computercraft` command, offering various diagnostic tools for server owners. This allows operators to - Printed pages and books can be placed in item frames and held like maps.
track which computers are hogging resources, turn on and shutdown multiple computers at once and interact with - Several profiling and administration tools for server owners, via the `/computercraft` command. This allows operators
to track which computers are hogging resources, turn on and shutdown multiple computers at once and interact with
computers remotely. computers remotely.
- Add full-block wired modems, allowing one to wrap non-solid peripherals (such as turtles, or chests if Plethora is - Closer emulation of standard Lua, adding the `debug` and `io` libraries. This also enables seeking within binary
installed). files, meaning you don't need to read large files into memory.
- Extended binary file handles. They support file seeking, and reading new lines, allowing full (and accurate) - Allow running multiple computers on multiple threads, reducing latency on worlds with many computers.
emulation of the standard Lua `io` library.
## Relation to CCTweaks? ## Relation to CCTweaks?
This mod has nothing to do with CCTweaks, though there is no denying the name is a throwback to it. That being said, This mod has nothing to do with CCTweaks, though there is no denying the name is a throwback to it. That being said,
@ -37,10 +37,8 @@ several features have been included, such as full block modems, the Cobalt runti
computers. computers.
## Contributing ## Contributing
Any contribution is welcome, be that using the mod, reporting bugs or contributing code. If you do wish to contribute Any contribution is welcome, be that using the mod, reporting bugs or contributing code. In order to start helping
code, do consider submitting it to the ComputerCraft repository first. develop CC:T, 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` - **Clone the repository:** `git clone https://github.com/SquidDev-CC/CC-Tweaked.git && cd CC-Tweaked`
- **Setup Forge:** `./gradlew setupDecompWorkspace` - **Setup Forge:** `./gradlew setupDecompWorkspace`

18
build.gradle
View File

@ -25,12 +25,14 @@ apply plugin: 'org.ajoberstar.grgit'
apply plugin: 'maven-publish' apply plugin: 'maven-publish'
apply plugin: 'maven' apply plugin: 'maven'
version = "1.80pr1.14" def mc_version = "1.12.2"
version = "1.81.0"
group = "org.squiddev" group = "org.squiddev"
archivesBaseName = "cc-tweaked" archivesBaseName = "cc-tweaked-${mc_version}"
minecraft { minecraft {
version = "1.12.2-14.23.4.2749" version = "${mc_version}-14.23.4.2749"
runDir = "run" runDir = "run"
replace '${version}', project.version replace '${version}', project.version
@ -86,11 +88,9 @@ jar {
attributes('FMLAT': 'computercraft_at.cfg') attributes('FMLAT': 'computercraft_at.cfg')
} }
into("docs", { from (javadoc.destinationDir) }) from (sourceSets.main.allSource) {
into("api", { from (sourceSets.main.allSource) {
include "dan200/computercraft/api/**/*.java" include "dan200/computercraft/api/**/*.java"
}}) }
from configurations.shade.collect { it.isDirectory() ? it : zipTree(it) } from configurations.shade.collect { it.isDirectory() ? it : zipTree(it) }
} }
@ -149,7 +149,7 @@ reobfJar.dependsOn proguardMove
processResources { processResources {
inputs.property "version", project.version inputs.property "version", project.version
inputs.property "mcversion", project.minecraft.version inputs.property "mcversion", project.version
def hash = 'none' def hash = 'none'
Set<String> contributors = [] Set<String> contributors = []
@ -171,7 +171,7 @@ processResources {
include 'assets/computercraft/lua/rom/help/credits.txt' include 'assets/computercraft/lua/rom/help/credits.txt'
expand 'version':project.version, expand 'version':project.version,
'mcversion':project.minecraft.version, 'mcversion':project.version,
'gitcontributors':contributors.sort(false, String.CASE_INSENSITIVE_ORDER).join('\n') 'gitcontributors':contributors.sort(false, String.CASE_INSENSITIVE_ORDER).join('\n')
} }