Skip to content

Gilly7CE/Carpet-Addons-Not-Found

Repository files navigation

Carpet-Addons-Not-Found

Curseforge downloads Modrinth Downloads GitHub all releases

GitHub

Curseforge available for GitHub release (latest by date)

GitHub Workflow Status GitHub Workflow Status GitHub Workflow Status

This mod extends the carpet mod and adds useful features to the game which would be cool to have in the Vanilla game.

This is the work of the 404 Not Found Technical Server.

The mod was formerly called "Gilly7CE Carpet Addons", which releases 1.1.0 and prior were called. Versions after this will be "Carpet Addons Not Found".

Installation

Download the .jar which corresponds to the minecraft version you are using and place it inside the 'mods' directory within your minecraft installation folder.

You also need to download the carpet mod and fabric loader.

Features

The list of carpet rules can be found on the wiki.

Contributing

Anyone can contribute to this repository. However, please follow the following guidelines when contributing.

Raising issues

If you have a question, feature request or bug report please raise it in the issues tab and link it with the corresponding label.

Code setup

Follow these guidelines to setup a dev environment to contribute code to this repository. Intellij IDEA is the preferred IDE to use, and the one which I use (Gilly7CE). You do not need to clone the fabric example mod, instead clone this repo. Once setup, you can build the mod. If building using fabric isn't working, try running ./gradlew idea in the terminal whilst in the repo directory. I'd recommend running this each time before debugging the code anyway. Since this mod is dependent on carpet, it will automatically build the carpet mod .jar needed and place it within the mods/ folder of the running minecraft instance along with this mod.

Workflow for PRs

The workflow will depend on whether you're a contributor with write access or not. If you're not a contributor please follow this general guidance, however please still follow the branching and commit guidance below.

To contribute a code change to the repository, please do the following:

  • Create a branch with a name that matches the following format: <type of issue>-<author name>-<issue number> -<description>
    • The issue can be omitted until one is created, however the branch should be renamed to include the issue. You can do this before creating a PR. You can also create the issue in advance and assign yourself to indicate you're working on it.
    • The branch base should be targeting main, unless the issue is specific to a particular minecraft version of the mod.
  • When writing commits, please follow these guidelines.
  • Once code changes have been made to the branch, push it and create a PR.
  • Additional checks before creating a PR:
    • Right-click the project in IntelliJ IDEA and select "Reformat Code". Under "Options" select "Cleanup code" and "Optimize imports". Click "Run". The code will now be formatted to the project's rules.
    • Run the tests under the "Test" directory. Ensure they all pass.
    • Run "Minecraft Client" in release and/or debug mode. If Minecraft loads then you know the configuration is okay.
    • Ensure any Mixin classes are declared abstract.

If you have any issues doing any of these, please contact the following: