Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/crafttweaker/crafttweaker
Tweak your minecraft experience
https://github.com/crafttweaker/crafttweaker
crafttweaker crafttweaker-source hacktoberfest minecraft minecraft-mod mod mod-support zenscript
Last synced: 6 days ago
JSON representation
Tweak your minecraft experience
- Host: GitHub
- URL: https://github.com/crafttweaker/crafttweaker
- Owner: CraftTweaker
- License: mit
- Created: 2015-08-29T16:53:44.000Z (over 9 years ago)
- Default Branch: 1.21.1
- Last Pushed: 2025-01-17T11:42:25.000Z (7 days ago)
- Last Synced: 2025-01-18T16:03:55.538Z (6 days ago)
- Topics: crafttweaker, crafttweaker-source, hacktoberfest, minecraft, minecraft-mod, mod, mod-support, zenscript
- Language: Java
- Homepage:
- Size: 72.1 MB
- Stars: 297
- Watchers: 24
- Forks: 124
- Open Issues: 20
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/CraftTweaker/CraftTweaker/issues)
[](https://github.com/CraftTweaker/CraftTweaker/blob/1.21.1/LICENSE)
[](https://ci.blamejared.com/job/Jared/job/Minecraft%20Mods/job/CraftTweaker/job/1.21.1/)
[](https://discord.blamejared.com/)
[](https://minecraft.curseforge.com/projects/crafttweaker)
## Table of Contents
- [Introduction](#introduction)
- [Feedback](#feedback)
- [License](#license)
- [Setup](#setup)
- [Build](#build)
- [Maven](#maven)
## Introduction
CraftTweaker is a Minecraft mod which allows modpacks and servers to customize the game. With CraftTweaker you can change recipes, script events, add new commands and even change item properties! When used with other mods the possibilities become endless! Ranging from custom machine recipes to entirely new blocks and items!
## Feedback
If you're looking for help with the mod, or just want to come hang out, we have a [Discord server](https://discord.blamejared.com).
If you're running into a bug or have a feature request, please don't be afraid to make an [issue on the tracker](https://github.com/CraftTweaker/CraftTweaker/issues).
## License
Distributed under the MIT License. See the [LICENSE](https://github.com/CraftTweaker/CraftTweaker/blob/1.21.1/LICENSE) file for more information.
## Setup
To set up the CraftTweaker development environment you must clone the repo and initialize the submodule.
```bash
git clone --recurse-submodules https://github.com/CraftTweaker/CraftTweaker.git
```
After the project has been cloned and initialized you can directly import it into your IDE of choice.
## Build
Building the project is as easy as running a Gradle command!
Simply run:
```bash
gradlew build
```
and the outputted `.jar` files will be put in `build/libs/` folder of each subproject (`Common/build/libs/`, `Fabric/build/libs/` and `Forge/build/libs/`).
CraftTweaker also has automated markdown documentation, the output of that will be in the `docsOut/` folder.
## Maven
Every push to this repository is built and published to the [BlameJared](https://maven.blamejared.com) maven, to use these builds in your project, first add the BlameJared maven to your `repositories` block in your build.gradle file like so:
```groovy
repositories {
maven {
url = 'https://maven.blamejared.com'
name = 'BlameJared Maven'
}
}
```
Then, depending on what modloader you are using, you can use the following snippets, just replace `[VERSION]` with the latest version for each artifact.
### Fabric [](https://maven.blamejared.com/com/blamejared/crafttweaker/CraftTweaker-fabric-1.21.1/)
```groovy
dependencies {
modImplementation('com.blamejared.crafttweaker:CraftTweaker-fabric-1.21.1:[VERSION]')
// Example:
// modImplementation('com.blamejared.crafttweaker:CraftTweaker-fabric-1.21.1:21.0.0')
}
```
### NeoForge [](https://maven.blamejared.com/com/blamejared/crafttweaker/CraftTweaker-neoforge-1.21.1/)
```groovy
implementation('com.blamejared.crafttweaker:CraftTweaker-neoforge-1.21.1:[VERSION]')
// Example:
// implementation('com.blamejared.crafttweaker:CraftTweaker-neoforge-1.21.1:21.0.0')
}
```
### Common [](https://maven.blamejared.com/com/blamejared/crafttweaker/CraftTweaker-common-1.21.1/)
If you are in a multi-modloader environment (Such as [MultiLoader](https://github.com/jaredlll08/MultiLoader-Template)), you can bring the Common artifact (code that does not depend on any specific mod loader but rather just the vanilla game) into your Common project like so:
```groovy
dependencies {
compileOnly('com.blamejared.crafttweaker:CraftTweaker-common-1.21.1:[VERSION]')
// Example:
// compileOnly('com.blamejared.crafttweaker:CraftTweaker-common-1.21.1:21.0.0')
}
```