Skip to content

Latest commit

 

History

History
321 lines (246 loc) · 13.5 KB

README.MD

File metadata and controls

321 lines (246 loc) · 13.5 KB
Raw


SquaredAdditions Logo

Squared Additions


Available on Fabric Requires Fabric API

Contributors Forks Stargazers Issues Build status Mod side Mod loader MIT License Current Modrinth version Modrinth download count Supported Game Supported Versions

A Minecraft: Java Edition mod for Fabric modloader which adds new blocks, items & other Vanilla+/Create themed stuff.
Go to installation guide »
Explore the wiki »
Check the roadmap »

Report Bug · Request Feature · Request Translation

⭐ - The star motivates me a lot! Don't wait and became a Stargazer!
Stargazers repo roster for @xYundy/SquaredAdditions

The project is part of the competition 🏅 100 commitow.

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

About The Project

I'm a Minecraft player since I was a child. At that time I don't know how to code. Novadays, I'm a PHP developer who still like playing games. When I heard about 100 commitów contest I have decide to take my chance in it by creating this mod for my favourite game.

I don't code in Java before or create any mod for Minecraft, so this mod will be my first.

What I want accomplish by developing this project:

  • I want to try add different kind of features which will come to my mind watching course created by: Modding by Kaupenjoe
  • I also like Create mod so I want try to integrate with it.
  • I want to do thing will make me smile while coding and while playing using this mod on server with friends 😄
  • I want to create mod which will support many languages instead of "english only"

Of course, no one mod will serve all player tastes and/or be "fully completed". So I'll be adding more features in the near future which looks good to me. You may also suggest changes by forking this repo and creating a pull request or opening an issue. Thanks to all the people have contributed to expanding this mod!

(back to top)

Built With

  • IntelliJIdea
  • Fabric
  • MidnightLib
  • ARRP

(back to top)

Getting Started

To use this mod you need to install it to your Minecraft Java Edition instance which has Fabric mod loader installed.

Prerequisites

  • Minecraft Java Edition (1.20.1)
  • Fabric mod loader

Required mods

Optional mods

Installation

Available on mod platforms


Available on Modinth Available on Modinth

Installation instructions

To install this mod:

  1. Download this mod
    1. from releases, latest build action, Modrinth or CurseForge.
    2. or "one-click download and install" using your Minecraft launcher (ex. Modrinth Launcher, Prism Launcher)
  2. Place mod .jar file in mods folder
  3. Launch the game

If you don't have Minecraft game and want to test this mod or contribute to the project you can:

  1. Clone this repository
  2. Run local dev version of Minecraft with this mod installed, using one of methods provided below:
    1. Open it using IntelliJ Idea and launch project using Minecraft Client and/or Minecraft Server configuration.
    2. Use gradlew runClient or runServer task

(back to top)

Usage & mod content

Current content:

  • copper, emerald & rose gold tools
  • rose gold ingot & rose gold block
  • emerald & rose gold armor
  • Vertical Slabs


For info about newest changes, please check release notes»
For more info about content of this mod, please explore the wiki » (WIP)

Photo showcase

Some photos of mod's content

modrinth-gallery

Video showcase

Work in progress

(back to top)

Roadmap

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

For current roadmap (aka working board) see project kanban board.

If you have an idea or sugestion about mod content don't hesitate to tell me more about it!

See the milestones for a list of features in next mod versions.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

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!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

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

(back to top)

Contact

Feel free to contact me using one of available methods on my Github profile and/or listed below:

Discord: xyundy

Project Link: https://github.com/xYundy/SquaredAdditions

(back to top)

Acknowledgments

(back to top)