Skip to content

Latest commit

 

History

History
43 lines (40 loc) · 2.05 KB

README.md

File metadata and controls

43 lines (40 loc) · 2.05 KB
Raw

clientcommands

Adds several useful client-side commands to Minecraft

Social

Discord: https://discord.gg/Jg7Bun7 Patreon: https://www.patreon.com/earthcomputer

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
  7. Note: by default, these steps will install a development environment for clientcommands only, and not its scripting submodule. If you want to work on the scripting submodule, follow the instructions in the Clientcommands Scripting readme.