https://github.com/obsidian-client/obsidian-client

A free and open source Minecraft client.
https://github.com/obsidian-client/obsidian-client

forge forge-mod forgegradle gpl3 gplv3 gradle gradle-java java java-8 java8 minecraft minecraft-forge minecraft-forge-mod minecraft-mod minecraftforge modded-minecraft obsidian-client obsidianclient

Last synced: 10 days ago
JSON representation

A free and open source Minecraft client.

• Host: GitHub
• URL: https://github.com/obsidian-client/obsidian-client
• Owner: obsidian-client
• License: gpl-3.0
• Created: 2022-03-23T18:41:45.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-04-24T08:23:12.000Z (almost 3 years ago)
• Last Synced: 2025-01-25T19:31:22.892Z (11 days ago)
• Topics: forge, forge-mod, forgegradle, gpl3, gplv3, gradle, gradle-java, java, java-8, java8, minecraft, minecraft-forge, minecraft-forge-mod, minecraft-mod, minecraftforge, modded-minecraft, obsidian-client, obsidianclient
• Language: Java
• Homepage: https://www.obsidian-client.com
• Size: 185 KB
• Stars: 2
• Watchers: 0
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
##



## Initial Setup

Before you can start doing anything with the Obsidian Client source code,

you have to run one of these commands to initialize ForgeGradle:

 - `./gradlew setupDecompWorkspace` For normal development environments, gives you nice deobfuscated Minecraft source to work with.

 - `./gradlew setupDevWorkspace` Like `setupDecompWorkspace`, but with obfuscated Minecraft source.

 - `./gradlew setupCiWorkspace` Bare minimum to build Obsidian Client, ideally for CI servers.

## Build & Run

To build Obsidian Client, run

`./gradlew jar`

or for production purposes you should use this command instead

`./gradlew reobfJar`.

Both commands will also automatically download all dependencies for you.

The output Java Archive will be in `build/libs/`.

To run Obsidian Client, there are two commands you can use:

 - For Vanilla Minecraft, use

    `./gradlew -b build.gradle runClient` or just `./gradlew runClient`

    (You can choose whatever you want, since `build.gradle` actually is the default buildscript).

 - For Minecraft Forge, use

    `./gradlew -b buildForge.gradle runClient`.

Both commands will download all dependencies, compile everything and run the game.

## Setup Development Environment

### IntelliJ Idea

 1. Open IntelliJ and import / open the project by selecting the `build.gradle` file.

 2. Now you have to generate the run configurations yourself using this command `./gradlew genIntellijRuns`.

### Eclipse

 1. Run this command `./gradlew eclipse` to generate the Eclipse project files.

 2. Now you can open the `eclipse` folder inside of Eclipse.

## Contributing

Feel free to contribute to this project by opening a pull request under the following rules:

 1. Write clean and organised code with Javadoc documentation.

 2. Try to adopt existing mechanisms, I don't want to end up 3 `ModuleManagers`.

    But if you want to improve existing mechanisms (like the `ModuleManager`), contact me: .

 3. Write code that fits perfectly into the existing one, so nothing looks out of place (especially important for the GUI's).

    I recommend you to take a look at other existing classes (with similar content) for refrence.