1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2025-06-25 22:52:51 +00:00

Clarify the README a little

This commit is contained in:
Jonathan Coates 2023-06-13 17:37:11 +01:00
parent 073df30e53
commit 0bb6ec39bd
No known key found for this signature in database
GPG Key ID: B9E431FF07C98D06
3 changed files with 5 additions and 41 deletions

View File

@ -14,6 +14,7 @@ Copyright: The CC: Tweaked Developers
License: MPL-2.0 License: MPL-2.0
Files: Files:
doc/logo.png
src/main/resources/assets/cctweaked/lua/rom/autorun/.ignoreme src/main/resources/assets/cctweaked/lua/rom/autorun/.ignoreme
src/main/resources/assets/cctweaked/lua/rom/help/* src/main/resources/assets/cctweaked/lua/rom/help/*
src/main/resources/assets/cctweaked/lua/rom/programs/fun/advanced/levels/* src/main/resources/assets/cctweaked/lua/rom/programs/fun/advanced/levels/*

View File

@ -6,14 +6,14 @@ SPDX-License-Identifier: MPL-2.0
# ![CC: Tweaked](doc/logo.png) # ![CC: Tweaked](doc/logo.png)
[![Current build status](https://github.com/cc-tweaked/CC-Tweaked/workflows/Build/badge.svg)](https://github.com/cc-tweaked/CC-Tweaked/actions "Current build status") [![Current build status](https://github.com/cc-tweaked/CC-Tweaked/workflows/Build/badge.svg)](https://github.com/cc-tweaked/CC-Tweaked/actions "Current build status")
[![Download CC: Tweaked on CurseForge](https://img.shields.io/static/v1?label=Download&message=CC:%20Tweaked&color=E04E14&logoColor=E04E14&logo=CurseForge)][CurseForge]
[![Download CC: Tweaked on Modrinth](https://img.shields.io/static/v1?label=Download&color=00AF5C&logoColor=00AF5C&logo=Modrinth&message=CC:%20Tweaked)][Modrinth] [![Download CC: Tweaked on Modrinth](https://img.shields.io/static/v1?label=Download&color=00AF5C&logoColor=00AF5C&logo=Modrinth&message=CC:%20Tweaked)][Modrinth]
CC: Tweaked is a mod for Minecraft which adds programmable computers, turtles and more to the game. A fork of the CC: Tweaked is a mod for Minecraft which adds programmable computers, turtles and more to the game. An add-on to the
much-beloved [ComputerCraft], it continues its legacy with improved performance and stability, along with a wealth of much-beloved [ComputerCraft], it continues its legacy with improved performance and stability, along with a wealth of
new features. new features.
CC: Tweaked can be installed from [CurseForge] or [Modrinth]. It runs on both [Minecraft Forge] and [Fabric]. CC: Tweaked can be installed from [Modrinth]. It requires [Minecraft Forge] and [ComputerCraft 1.50] and MUST be
installed as a core mod.
## Contributing ## Contributing
Any contribution is welcome, be that using the mod, reporting bugs or contributing code. If you want to get started Any contribution is welcome, be that using the mod, reporting bugs or contributing code. If you want to get started
@ -26,44 +26,6 @@ populated, albeit quiet [IRC channel][irc], if that's more your cup of tea.
We also host fairly comprehensive documentation at [tweaked.cc](https://tweaked.cc/ "The CC: Tweaked website"). 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("cc.tweaked")
includeModule("org.squiddev", "Cobalt")
}
}
}
dependencies {
// Vanilla (i.e. for multi-loader systems)
compileOnly("cc.tweaked:cc-tweaked-$mcVersion-common-api")
// Forge Gradle
compileOnly("cc.tweaked:cc-tweaked-$mcVersion-core-api:$cctVersion")
compileOnly(fg.deobf("cc.tweaked:cc-tweaked-$mcVersion-forge-api:$cctVersion"))
runtimeOnly(fg.deobf("cc.tweaked:cc-tweaked-$mcVersion-forge:$cctVersion"))
// Fabric Loom
modCompileOnly("cc.tweaked:cc-tweaked-$mcVersion-fabric-api:$cctVersion")
modRuntimeOnly("cc.tweaked:cc-tweaked-$mcVersion-fabric:$cctVersion")
}
```
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" [computercraft]: https://github.com/dan200/ComputerCraft "ComputerCraft on GitHub"
[curseforge]: https://minecraft.curseforge.com/projects/cc-tweaked "Download CC: Tweaked from CurseForge" [curseforge]: https://minecraft.curseforge.com/projects/cc-tweaked "Download CC: Tweaked from CurseForge"
[modrinth]: https://modrinth.com/mod/gu7yAYhd "Download CC: Tweaked from Modrinth" [modrinth]: https://modrinth.com/mod/gu7yAYhd "Download CC: Tweaked from Modrinth"
@ -72,3 +34,4 @@ the generated documentation [can be browsed online](https://tweaked.cc/javadoc/)
[forum]: https://forums.computercraft.cc/ [forum]: https://forums.computercraft.cc/
[GitHub Discussions]: https://github.com/cc-tweaked/CC-Tweaked/discussions [GitHub Discussions]: https://github.com/cc-tweaked/CC-Tweaked/discussions
[IRC]: https://webchat.esper.net/?channels=computercraft "#computercraft on EsperNet" [IRC]: https://webchat.esper.net/?channels=computercraft "#computercraft on EsperNet"
[ComputerCraft 1.50]: https://modrinth.com/mod/computercraft/version/1.50 "Download ComputerCraft 1.50 from Modrinth"

BIN
doc/logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 KiB