Usage - Earthcomputer/clientcommands GitHub Wiki

This page is about how to install ClientCommands and contribute to ClientCommanads.

Installation

  1. Download and run the Fabric installer.
    • Click the "vanilla" button, leave the other settings as they are, and click "download installer".
    • Note: this step may vary if you aren't using the vanilla launcher or an old version of Minecraft.
  2. Download the Fabric API and move it to the mods folder (.minecraft/mods).
  3. Download clientcommands from the releases page and move it to the mods folder (.minecraft/mods).

Contributing

  1. Clone the repository

    git clone https://github.com/Earthcomputer/clientcommands
cd clientcommands

  2. Generate the Minecraft source code

    ./gradlew genSources
    • Note: on Windows, use gradlew rather than ./gradlew.

  3. Import the project into your preferred IDE.

    1. If you use IntelliJ (the preferred option), you can simply import the project as a Gradle project.
    2. If you use Eclipse, you need to ./gradlew eclipse before importing the project as an Eclipse project.

  4. Edit the code

  5. After testing in the IDE, build a JAR to test whether it works outside the IDE too

    ./gradlew build

    The mod JAR may be found in the build/libs directory

  6. Create a pull request so that your changes can be integrated into clientcommands

    • Note: for large contributions, create an issue before doing all that work, to ask whether your pull request is likely to be accepted

Contributing to the Wiki

You are very welcome to add a new page or edit and correct others.

When creating a new command page please follow the following fromatting:

# `/commandname`
Short command desc

## Requirements
What one needs to do to use the command

## Usage
How to use the command

...

When writing a command please use the minecraft command formatting:

  • normalText Items you must type as shown.
  • <Text inside angle brackets> Placeholder for which you must supply a value.
  • [<Text inside square brackets with braces>] Optional items.
  • (Text inside braces) Set of required items. You must choose one.
  • Vertical bar | Separator for mutually exclusive items. You must choose one.
  • Ellipsis … Items that can be repeated and used multiple times.

You can just look a the chelp output, and add things.