Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kir-antipov/sync-fabric
One mind. Many bodies.
https://github.com/kir-antipov/sync-fabric
fabric minecraft minecraft-mod
Last synced: 3 days ago
JSON representation
One mind. Many bodies.
- Host: GitHub
- URL: https://github.com/kir-antipov/sync-fabric
- Owner: Kir-Antipov
- License: mit
- Created: 2021-08-14T17:36:01.000Z (over 3 years ago)
- Default Branch: 1.19.x/stable
- Last Pushed: 2023-01-26T20:07:57.000Z (almost 2 years ago)
- Last Synced: 2023-03-02T20:01:34.158Z (over 1 year ago)
- Topics: fabric, minecraft, minecraft-mod
- Language: Java
- Homepage:
- Size: 1.71 MB
- Stars: 12
- Watchers: 2
- Forks: 7
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Sync (Fabric)
[](https://github.com/Kir-Antipov/sync-fabric/releases/latest)
[](https://github.com/Kir-Antipov/sync-fabric/actions/workflows/build-artifacts.yml)
[](https://modrinth.com/mod/sync-fabric)
[](https://www.curseforge.com/minecraft/mc-mods/sync-fabric)
[](https://github.com/Kir-Antipov/sync-fabric#readme)
[Sync (Fabric)](https://github.com/Kir-Antipov/sync-fabric) is an unofficial reimplementation of the [Sync](https://github.com/iChun/Sync) mod, that was originally developed by [iChun](https://github.com/iChun).
As for the brief description of the mod, I think the original one says it all:
> This mod provides clones, or as we like to call it, "shells". These shells are basically new individuals, with their own inventory, experience level, and even gamemode.
> \
> \
> However, they lack a mind that would control them. That's where the player comes in. Each shell is biometrically tied to the player whose sample was used to create it, and allows the player to "sync" their mind with it, essentially creating multiple player instances.
----
## Crafting recipes
#### Sync Core:
#### Sync Core (for Hardcore players):
P.S. - If you aren't brave enough to fight the Wither in Hardcore, you can use [this datapack](media/simplified_hardcore_recipe_datapack.zip) *(it will bring back the original Sync Core recipe)*. Please read [this article](https://minecraft.fandom.com/wiki/Tutorials/Installing_a_data_pack), if you don't know how to do it.
#### Shell Constructor:
#### Shell Storage:
#### Treadmill:
----
## How to play
1. You need to craft a `shell constructor` and place it down.
2. Then you need to provide it with a sample - just `right-click` the thing.\
**⚠️WARNING: this action will kill you!** In order to create a shell with full health, the constructor must absorb 20HP *(40 for Hardcore players)*. If you don't want to die, you can eat a golden apple to increase your maximum health, or you can hold a totem of undying during the process *(which is the only option for Hardcore players)*.
3. The shell constructor needs power to work, so put a `treadmill` next to it *(it should touch any side of any part of the shell constructor)* and lure a `pig` or a `wolf` to its center to start generating piggawatts.\
You should end up with something like this:
\
You don't really need a comparator, it's here just to demonstrate that you can determine progress of the shell construction process via strength of the comparator output.
4. Once your new shell is constructed, you need to craft a `shell storage` and place it down.
5. Supply it with `redstone power`.
6. Once doors of the shell storage are open, you can `walk into it`.
7. You'll see a radial `menu` that displays your shells:
8. `Select` the shell you want to transfer your mind into, and enjoy the process!
## Notes
- You can color-code shells stored in shell storages. Just right-click a shell storage with dye.
- Syncing works cross dimensional, and should support custom dimensions.
- If you die while using a shell, you'll be immediately synced with your original body *(if you still have one; otherwise your mind will be transferred to a random shell)*.
- Death of a shell doesn't increase your death counter.
- Shell can be equipped (or unequipped) with armor, tools, etc. via hoppers connected to a corresponding shell container.
- Shell storage should be constantly supplied with power in order to keep stored shell alive.
- Shell storage can be powered by redstone, if the `shellStorageAcceptsRedstone` option is set to `true`.
- Shell storage can be powered by any valid energy source (e.g., treadmills, machinery from popular tech mods, etc.).
- It's possible to measure a shell container's state with a comparator.
- You can determine progress of the shell construction process via strength of the comparator output.
- You can measure the fullness of a shell's inventory via strength of the comparator output.
- You can change a comparator output type by right-clicking on a shell container with a wrench.
- Shell storage and shell constructor are pretty fragile, so don't try to mine them without `silk touch` enchantment.
## Config
The mod is highly configurable. The config is located at `./config/sync.json` and by default looks like this:
```json
{
"enableInstantShellConstruction": false,
"warnPlayerInsteadOfKilling": false,
"fingerstickDamage": 20.0,
"hardcoreFingerstickDamage": 40.0,
"shellConstructorCapacity": 256000,
"shellStorageCapacity": 320,
"shellStorageConsumption": 16,
"shellStorageAcceptsRedstone": true,
"shellStorageMaxUnpoweredLifespan": 20,
"energyMap": [
{
"entityId": "minecraft:chicken",
"outputEnergyQuantity": 2
},
{
"entityId": "minecraft:pig",
"outputEnergyQuantity": 16
},
{
"entityId": "minecraft:player",
"outputEnergyQuantity": 20
},
{
"entityId": "minecraft:wolf",
"outputEnergyQuantity": 24
},
{
"entityId": "minecraft:creeper",
"outputEnergyQuantity": 80
},
{
"entityId": "minecraft:enderman",
"outputEnergyQuantity": 160
}
],
"preserveOrigins": false,
"syncPriority": [
{ "priority": "NATURAL" }
],
"wrench": "minecraft:stick",
"updateTranslationsAutomatically": false
}
```
| Name | Description | Default value |
| ---- | ----------- | ------------- |
| `enableInstantShellConstruction` | If this option is enabled, creative-like shells will be constructed immediately, without the use of energy | `false` |
| `warnPlayerInsteadOfKilling` | If this option is enabled, a player won't be killed by a shell constructor if they don't have enough health to create a new shell | `false` |
| `fingerstickDamage` | The amount of damage that a shell constructor will deal to a player when they try to create a new shell | `20.0` |
| `hardcoreFingerstickDamage` | The amount of damage that a shell constructor will deal to a player in the Hardcore mode when they try to create a new shell | `40.0` |
| `shellConstructorCapacity` | The amount of energy required to construct a new shell | `256000` |
| `shellStorageCapacity` | Determines capacity of a shell storage's inner battery | `320` |
| `shellStorageConsumption` | Energy consumption of a shell storage's life support systems (per tick) | `16` |
| `shellStorageAcceptsRedstone` | If this option is enabled, a shell storage can be powered by redstone | `true` |
| `shellStorageMaxUnpoweredLifespan` | Determines how many ticks a shell can survive without a power supply connected to the corresponding shell storage | `20` |
| `energyMap` | Specifies a list of entities that can produce energy via treadmills | [...](#user-content-config) |
| `preserveOrigins` | If this option is enabled, all user shells will share the same [origins](https://www.curseforge.com/minecraft/mc-mods/origins) | `false` |
| `syncPriority` | The order of shell selection for synchronization in case of death
Available `priority` values:
- `NATURAL` - non-artificial shells are prioritized
- `NEAREST` - nearest shells are prioritized
- `WHITE`, `ORANGE`, `MAGENTA`, `LIGHT_BLUE`, `YELLOW`, `LIME`, `PINK`, `GRAY`, `LIGHT_GRAY`, `CYAN`, `PURPLE`, `BLUE`, `BROWN`, `GREEN`, `RED`, `BLACK` - shells of the given color are prioritized
- | `[{ "priority": "NATURAL" }]` |
| `wrench` | Identifier of an item that can be used as a wrench in order to change a shell constructor's state | `minecraft:stick` |
| `updateTranslationsAutomatically` | If this option is enabled, translations will be updated every time the game is launched | `false` |
You can edit any of these values directly in the config file or via [ModMenu](https://github.com/TerraformersMC/ModMenu).
----
## Translations
[](https://crowdin.com/project/sync-fabric)
[Sync (Fabric)](https://github.com/Kir-Antipov/sync-fabric) makes use of crowd sourced translations.
You can help translate the mod to additional languages here: [crowdin.com](https://crowdin.com/project/sync-fabric).
----
## Known Issues
- Dynamic shell texturing does not work with Iris ([#25](https://github.com/Kir-Antipov/sync-fabric/issues/25))
----
## Installation
Requirements:
- Minecraft `1.19.x`
- Fabric Loader `>=0.14.0`
- Fabric API `>=0.55.1`
You can download the mod from:
- [GitHub Releases](https://github.com/Kir-Antipov/sync-fabric/releases/) (recommended)
- [Modrinth](https://modrinth.com/mod/sync-fabric)
- [CurseForge](https://www.curseforge.com/minecraft/mc-mods/sync-fabric)
- [GitHub Actions](https://github.com/Kir-Antipov/sync-fabric/actions/workflows/build-artifacts.yml) *(these builds may be unstable, but they represent the actual state of the development)*
## Developers
`build.gradle`:
```groovy
repositories {
maven {
name = "Modrinth"
url = "https://api.modrinth.com/maven"
content {
includeGroup "maven.modrinth"
}
}
}
dependencies {
modImplementation "maven.modrinth:sync-fabric:${project.sync_version}"
}
```
`gradle.properties`:
```properties
sync_version=/* latest version goes here */
```
There's [no documentation](https://www.commitstrip.com/en/2021/11/10/no-documentation/) for the project's [api](https://github.com/Kir-Antipov/sync-fabric/tree/1.17.x/dev/src/main/java/stable/kir/sync/api) yet, but you can find some useful examples in the [`compat` package](https://github.com/Kir-Antipov/sync-fabric/tree/1.17.x/stable/src/main/java/dev/kir/sync/compat).
## Building from sources
Requirements:
- JDK `17`
### Linux/MacOS
```cmd
git clone https://github.com/Kir-Antipov/sync-fabric.git
cd sync-fabric
chmod +x ./gradlew
./gradlew build
cd build/libs
```
### Windows
```cmd
git clone https://github.com/Kir-Antipov/sync-fabric.git
cd sync-fabric
gradlew build
cd build/libs
```
----
## License
Created by [Kir_Antipov](https://github.com/Kir-Antipov), licensed under MIT license.\
Originally made by [iChun](https://github.com/iChun) under GNU LGPLv3 license.
```
Copyright (C) 2021 Kir_Antipov
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.
```
[Sync (Fabric)](https://github.com/Kir-Antipov/sync-fabric) was originally licensed under GNU LGPLv3 license to conform to [the original mod](https://github.com/iChun/Sync), but since the project is not a port, but a reimplementation with its own unique codebase, I got permission from [iChun](https://github.com/iChun) to change the license to MIT.
You can find more about the MIT license on [this website](https://choosealicense.com/licenses/mit/).
