1
0
mirror of https://github.com/SquidDev-CC/CC-Tweaked synced 2024-07-07 20:34:25 +00:00
Modernized/improved/actually updated version of ComputerCraft: https://tweaked.cc
Go to file
Jonathan Coates 7b7527ec80
Rewrite turtle upgrade registration to be more data driven (#967)
The feature nobody asked for, but we're getting anyway.

Old way to register a turtle/pocket computer upgrade:

    ComputerCraftAPI.registerTurtleUpgrade(new MyUpgrade(new ResourceLocation("my_mod", "my_upgrade")));

New way to register a turtle/pocket computer upgrade:

First, define a serialiser for your turtle upgrade type:

    static final DeferredRegister<TurtleUpgradeSerialiser<?>> SERIALISERS = DeferredRegister.create( TurtleUpgradeSerialiser.TYPE, "my_mod" );
    public static final RegistryObject<TurtleUpgradeSerialiser<MyUpgrade>> MY_UPGRADE =
        SERIALISERS.register( "my_upgrade", () -> TurtleUpgradeSerialiser.simple( MyUpgrade::new ) );
    SERIALISERS.register(bus); // Call in your mod constructor.

Now either create a JSON string or use a data generator to register your upgrades:

    class TurtleDataGenerator extends TurtleUpgradeDataProvider {
        @Override
        protected void addUpgrades( @Nonnull Consumer<Upgrade<TurtleUpgradeSerialiser<?>>> addUpgrade )
            simple(new ResourceLocation("my_mod", my_upgrade"), MY_UPGRADE.get()).add(addUpgrade);
        }
    }

See much better! In all seriousness, this does offer some benefits,
namely that it's now possible to overwrite or create upgrades via
datapacks.

Actual changes:
 - Remove ComputerCraftAPI.register{Turtle,Pocket}Upgrade functions.

 - Instead add {Turtle,Pocket}UpgradeSerialiser classes, which are used
   to load upgrades from JSON files in datapacks, and then read/write
   them to network packets (much like recipe serialisers).

 - The upgrade registries now subscribe to datapack reload events. They
   find all JSON files in the
   data/$mod_id/computercraft/{turtle,pocket}_upgrades directories,
   parse them, and then register them as upgrades.

   Once datapacks have fully reloaded, these upgrades are then sent over
   the network to the client.

 - Add data generators for turtle and pocket computer upgrades, to make
   the creation of JSON files a bit easier.

 - Port all of CC:T's upgrades over to use the new system.
2021-11-26 23:36:02 +00:00
.github Move repo to cc-tweaked org 2021-10-17 18:14:32 +01:00
config Merge branch 'mc-1.16.x' into mc-1.17.x 2021-11-25 13:34:19 +00:00
doc Move repo to cc-tweaked org 2021-10-17 18:14:32 +01:00
gradle/wrapper Move repo to cc-tweaked org 2021-10-17 18:14:32 +01:00
src Rewrite turtle upgrade registration to be more data driven (#967) 2021-11-26 23:36:02 +00:00
tools Merge branch 'mc-1.16.x' into mc-1.17.x 2021-10-06 18:10:45 +01:00
.editorconfig Add a pre commit hook to lint code 2021-04-28 21:24:27 +01:00
.gitattributes Update test mod "generated" tags 2021-08-18 13:03:53 +01:00
.gitignore Runnable examples (#576) 2020-11-12 19:01:50 +00:00
.gitpod.yml Gitpod Support (#817) 2021-06-12 21:33:08 +01:00
build.gradle Don't specify the version number in mods.toml 2021-11-25 14:54:32 +00:00
CONTRIBUTING.md Move repo to cc-tweaked org 2021-10-17 18:14:32 +01:00
gradle.properties Some post-1.17 cleanup 2021-10-13 17:46:29 +01:00
gradlew Move repo to cc-tweaked org 2021-10-17 18:14:32 +01:00
gradlew.bat Bump Gradle/ForgeGradle version 2021-02-13 12:39:52 +00:00
illuaminate.sexp Move repo to cc-tweaked org 2021-10-17 18:14:32 +01:00
LICENSE Add a pre commit hook to lint code 2021-04-28 21:24:27 +01:00
package-lock.json Bump various package versions 2021-11-20 23:20:12 +00:00
package.json npm update 2021-08-20 21:54:44 +01:00
README.md Move repo to cc-tweaked org 2021-10-17 18:14:32 +01:00
rollup.config.js More examples 2020-11-20 21:59:17 +00:00
settings.gradle Several recipe improvements 2019-03-19 11:59:23 +00:00
tsconfig.json Runnable examples (#576) 2020-11-12 19:01:50 +00:00

CC: Tweaked

Current build status Download CC: Tweaked on CurseForge

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 better performance, stability, and a wealth of new features.

CC: Tweaked can be installed from CurseForge or Modrinth. It requires the Minecraft Forge mod loader, but versions are available for Fabric.

Contributing

Any contribution is welcome, be that using the mod, reporting bugs or contributing code. If you want to get started developing the mod, check out the instructions here.

Community

If you need help getting started with CC: Tweaked, want to show off your latest project, or just want to chat about ComputerCraft we have a forum and Discord guild! There's also a fairly populated, albeit quiet IRC channel, if that's more your cup of tea.

We also host fairly comprehensive documentation at tweaked.cc.

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.

repositories {
  maven {
    url 'https://squiddev.cc/maven/'
    content {
      includeGroup 'org.squiddev'
    }
  }
}

dependencies {
  implementation fg.deobf("org.squiddev:cc-tweaked-${mc_version}:${cct_version}")
}

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.