Skip to content

Latest commit

 

History

History
246 lines (163 loc) · 7.46 KB

README.md

File metadata and controls

246 lines (163 loc) · 7.46 KB
Raw

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Forgero [Fabric]

A tool creation and customization mod for Minecraft!
Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About

Logo

Forgero was created to fill a gap in the mods available for Fabric. The aim of the mod is to give tool creation and customization in Minecraft a greater depth.

Key features:

  • A wide variety of materials can be used to craft every part of a tool (But some are better suited than others)
  • Unique patterns which will enhance the look and attributes of your tools
  • Vanilla friendly, this mod generates textures from palettes created from Minecraft's own textures
  • Gems, which can further enhance tools and weapons through an expansive upgrade path
  • Enchanting support
  • Support for adding and customizing materials, patterns and gems entirely trough config files

(back to top)

Built With

This project is created with Fabric, and its toolchain

(back to top)

Getting Started with modding

Modding Minecraft is very easy using the tools developed by the modding community.

Prerequisites

If you wish to run this project without using and IDE, you need to install java 17, and Gradle

Installation

Setting up Forgero is best done using

  1. Clone the project from this repository

    git clone https://github.com/sigmundgranaas/forgero.git

  2. Install Intellij IDEA

    install intellij from: https://www.jetbrains.com/idea/download/

  3. Open Forgero in Intellij

    new > project from existing sources > choose forgero folder

  4. Make changes and run Forgero

    Make canges and run Minecraft by choosing the runClient gradle task from the righand Gradle menu

(back to top)

Roadmap

Forgero is in active development, and features are being added frequently.

  • Add tool parts and materials
  • Pickaxe, Shovel and axe
  • Gems
  • Patterns
  • Sword and hoe support
  • Support for enhanced tool properties, like golden and a 3x3 breaking area
  • Rework model system to avoid flickering textures

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again! Your contributions are Greatly appreciated

  1. Fork the Project to your Github account
  2. Set up the project as described in the installation section
  3. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  4. Commit your Changes (git commit -m 'Add some AmazingFeature')
  5. Push to the Branch (git push origin feature/AmazingFeature)
  6. Open a Pull request here

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Contact

Sigmund Granaas Sandring

Project Link: https://github.com/sigmundgranaas/forgero

(back to top)

Acknowledgments

Creating this project could not have been done without the prior work of the community.

(back to top)