Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/xyundy/squaredadditions

A Minecraft mod for Fabric modloader which adds new blocks, items & other Vanilla+/Create themed stuff.
https://github.com/xyundy/squaredadditions

100commitow fabric fabricmc fabricmc-mod java minecraft minecraft-fabric minecraft-fabric-mod

Last synced: 3 months ago
JSON representation

A Minecraft mod for Fabric modloader which adds new blocks, items & other Vanilla+/Create themed stuff.

Host: GitHub
URL: https://github.com/xyundy/squaredadditions
Owner: xYundy
License: mit
Created: 2024-02-22T12:05:36.000Z (11 months ago)
Default Branch: main
Last Pushed: 2024-04-13T19:59:38.000Z (9 months ago)
Last Synced: 2024-04-14T05:10:22.656Z (9 months ago)
Topics: 100commitow, fabric, fabricmc, fabricmc-mod, java, minecraft, minecraft-fabric, minecraft-fabric-mod
Language: Java
Homepage:
Size: 455 KB
Stars: 19
Watchers: 3
Forks: 0
Open Issues: 5
Metadata Files:
- Readme: README.MD
- License: LICENSE

Awesome Lists containing this project

README

        






  

    

  

Squared Additions





    

    







[![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![Build status][build-shield]][build-url]

[![Mod side][side-shield]][side-url]

[![Mod loader][loader-shield]][loader-url]

[![MIT License][license-shield]][license-url]

[![Current Modrinth version][modrinth-version-badge]][modrinth-version-url]

[![Modrinth download count][modrinth-downloads-badge]][modrinth-downloads-url]

[![Supported Game Supported Versions][modrinth-supported-game-versions-shield]][modrinth-supported-game-versions-url]

  


    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

    


    


    :star: - The star motivates me a lot! Don't wait and became a Stargazer!

    


    

       

    

    


    


    The project is part of the competition :medal_sports: 100 commitow.

  



  Table of Contents

  


    

      About The Project

      

        Built With

      

    

    

      Getting Started

      

        Prerequisites

        Installation

      

    

    Usage & mod content

    Roadmap

    Contributing

    License

    Contact

    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_](https://100commitow.pl) 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](https://www.youtube.com/@ModdingByKaupenjoe)

* I also like [Create mod](https://modrinth.com/mod/create-fabric) 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 :smile:

* 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][IntelliJIdea]][IntelliJIdea-url]

* [![Fabric][Fabric]][Fabric-url]

* [![MidnightLib][MidnightLib]][MidnightLib-url]

* [![ARRP][ARRP]][ARRP-url]

(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

* [Fabric API](https://modrinth.com/mod/fabric-api)

#### Optional mods

* [Mod Menu](https://modrinth.com/mod/modmenu)

### Installation

#### Available on mod platforms






    

   






#### Installation instructions

To install this mod:

1. Download this mod

   1. from [releases](https://github.com/xYundy/SquaredAdditions/releases), [latest build action](https://github.com/xYundy/SquaredAdditions/actions/workflows/build.yml), [Modrinth](https://modrinth.com/mod/squaredadditions) or [CurseForge](https://www.curseforge.com/minecraft/mc-mods/squared-additions).

   2. or "one-click download and install" using your Minecraft launcher (ex. [Modrinth Launcher](https://modrinth.com/app), [Prism Launcher](https://prismlauncher.org))

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

  

  


  

  

  

  

  




    



### Video showcase

*Work in progress* 

(back to top)


## Roadmap

See the [open issues](https://github.com/xyundy/squaredadditions/issues) for a full list of proposed features (and known issues).

For current roadmap (aka working board) see [project kanban board](https://github.com/users/xYundy/projects/3).

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

See the [milestones](https://github.com/xYundy/SquaredAdditions/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](https://github.com/xYundy/SquaredAdditions)

(back to top)


## Acknowledgments

* [Modding by Kaupenjoe](https://www.youtube.com/@ModdingByKaupenjoe)

* [Blockbench](https://www.blockbench.net) - A low-poly 3D model editor

* [Img Shields](https://shields.io)

* [Piskel](https://www.piskelapp.com/p/create/sprite)

* [Andrew Grant](https://github.com/Andrew6rant) 

(back to top)


[contributors-shield]: https://img.shields.io/github/contributors/xYundy/SquaredAdditions.svg?style=for-the-badge

[contributors-url]: https://github.com/xYundy/SquaredAdditions/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/xYundy/SquaredAdditions.svg?style=for-the-badge

[forks-url]: https://github.com/xYundy/SquaredAdditions/network/members

[stars-shield]: https://img.shields.io/github/stars/xYundy/SquaredAdditions.svg?style=for-the-badge

[stars-url]: https://github.com/xYundy/SquaredAdditions/stargazers

[issues-shield]: https://img.shields.io/github/issues/xYundy/SquaredAdditions.svg?style=for-the-badge

[issues-url]: https://github.com/othneildrew/Best-README-Template/issues

[license-shield]: https://img.shields.io/github/license/xYundy/SquaredAdditions.svg?style=for-the-badge

[license-url]: https://github.com/xYundy/SquaredAdditions/blob/master/LICENSE

[build-shield]: https://img.shields.io/github/actions/workflow/status/xYundy/SquaredAdditions/build.yml?style=for-the-badge

[build-url]: https://github.com/xYundy/SquaredAdditions/actions/workflows/build.yml

[loader-shield]: https://img.shields.io/badge/mod_loader-fabric-d7cfb5?style=for-the-badge

[loader-url]: https://fabricmc.net/wiki/player:tutorials:start#installing_fabric_loader

[side-shield]: https://img.shields.io/badge/environment-both-4caf50?style=for-the-badge

[side-url]: https://fabricmc.net/wiki/tutorial:side

[modrinth-supported-game-versions-shield]: https://img.shields.io/modrinth/game-versions/uUiBMoXL?style=for-the-badge

[modrinth-supported-game-versions-url]: https://modrinth.com/mod/squaredadditions

[modrinth-version-badge]: https://img.shields.io/modrinth/v/uUiBMoXL?style=for-the-badge&label=Modrinth's%20version

[modrinth-version-url]: https://modrinth.com/mod/squaredadditions/versions

[modrinth-downloads-badge]: https://img.shields.io/modrinth/dt/uUiBMoXL?style=for-the-badge&label=modrinth%20downloads

[modrinth-downloads-url]: https://modrinth.com/mod/squaredadditions/versions

[IntelliJIdea]: https://img.shields.io/badge/IntelliJ_Idea-000000?style=for-the-badge&logo=intellijidea&logoColor=white

[IntelliJIdea-url]: https://www.jetbrains.com/idea/

[Fabric]: https://img.shields.io/badge/Fabric_Mod_Loader-20232A?style=for-the-badge

[Fabric-url]: https://fabricmc.net/

[MidnightLib]: https://img.shields.io/badge/MidnightLib-20232A?style=for-the-badge

[MidnightLib-url]: https://www.midnightdust.eu/midnightlib/

[ARRP]: https://img.shields.io/badge/ARRP-20232A?style=for-the-badge

[ARRP-url]: https://github.com/Devan-Kerman/ARRP