❯ Enhance your Minecraft experience with Fractured Mod, featuring new blocks, items, and dimensions for the Factions of Fractured Realms server.

Built with the tools and technologies:

🔗 Quick Links

• 📍 Overview
• 👾 Features
• 📂 Project Index
• 🚀 Getting Started
  • ☑️ Prerequisites
  • ⚙️ Installation
• 🔰 Contributing
• 🎗 License
• 🙌 Acknowledgments

---

📍 Overview

Fratured Mod is a Minecraft mod built using the Fabric modding toolchain. This mod aims to enhance the gameplay experience by introducing new features and improvements.

---

👾 Features

• Fake Bedrock Block: A block that looks like bedrock but has different properties.
• Portal Sword: A sword that can open a portal to a pocket dimension.

---

📂 Project Index

FRACTURED-MOD/

__root__

gradlew.bat	Windows batch file for building the project.
build.gradle	Gradle build script with project dependencies and tasks.
settings.gradle	Settings for the Gradle build.
README.md	Project README with detailed information.

.github

workflows

build.yml

GitHub Actions workflow for building the project.

src

main

resources

fractured-mod.mixins.json	Mixin configuration for the mod.
fabric.mod.json	Fabric mod metadata.

java

com

fofr

FracturedMod.java

Main class for the mod.

mixin

ExampleMixin.java

Example mixin class for the mod.

client

resources

fractured-mod.client.mixins.json

Client-side mixin configuration for the mod.

java

com

fofr

FracturedModClient.java	Client entry point for the mod.
FracturedModDataGenerator.java	Data generator class for the mod.

mixin

client

ExampleClientMixin.java

Example client-side mixin class for the mod.

---

🚀 Getting Started

☑️ Prerequisites

Before getting started with Fratured Mod, ensure your runtime environment meets the following requirements:

• Programming Language: Java
• Package Manager: Gradle

⚙️ Installation

Install Fratured Mod using one of the following methods:

Build from source:

1. Clone the Fratured Mod repository:

   ❯ git clone https://github.com/Bobisawesome07/fractured-mod

2. Navigate to the project directory:

   ❯ cd fractured-mod

3. Install the project dependencies:

Using gradle  

```sh
❯ gradle build
```

Using Fabric:

1. Ensure you have the Fabric Loader installed. You can download it from Fabric website.
2. Download the latest release of Fratured Mod from the releases page.
3. Place the downloaded .jar file into the mods folder of your Minecraft directory.

---

🔰 Contributing

• 💬 Join the Discussions: Share your insights, provide feedback, or ask questions.
• 🐛 Report Issues: Submit bugs found or log feature requests for the Fratured Mod project.
• 💡 Submit Pull Requests: Review open PRs, and submit your own PRs.

Contributing Guidelines

1. Fork the Repository: Start by forking the project repository to your GitHub account.

2. Clone Locally: Clone the forked repository to your local machine using a git client.

   git clone https://github.com/Bobisawesome07/fractured-mod

3. Create a New Branch: Always work on a new branch, giving it a descriptive name.

   git checkout -b new-feature-x

4. Make Your Changes: Develop and test your changes locally.

5. Commit Your Changes: Commit with a clear message describing your updates.

   git commit -m 'Implemented new feature x.'

6. Push to GitHub: Push the changes to your forked repository.

   git push origin new-feature-x

7. Submit a Pull Request: Create a PR against the original project repository. Clearly describe the changes and their motivations.

8. Review: Once your PR is reviewed and approved, it will be merged into the main branch. Congratulations on your contribution!

Contributor Graph

---

🎗 License

This project is licensed under the CC0 1.0 Universal (CC0 1.0) Public Domain Dedication. See the LICENSE file for more information.

---

🙌 Acknowledgments

• Thank you to Sir.Duckie for creating most of the models and textures for the mod.