https://github.com/uranometrical/constellar

Mixin-based standalone Minecraft PvP client and simplistic modding framework.
https://github.com/uranometrical/constellar

api fabric forge framework minecraft minecraft-fabric minecraft-forge minecraft-mod minecraft-pvp mixin mixins mod modding spongepowered-mixin standalone

Last synced: about 16 hours ago
JSON representation

Mixin-based standalone Minecraft PvP client and simplistic modding framework.

• Host: GitHub
• URL: https://github.com/uranometrical/constellar
• Owner: uranometrical
• License: mit
• Created: 2021-10-03T00:33:25.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2022-03-26T23:42:01.000Z (over 2 years ago)
• Last Synced: 2024-09-20T11:30:59.611Z (5 days ago)
• Topics: api, fabric, forge, framework, minecraft, minecraft-fabric, minecraft-forge, minecraft-mod, minecraft-pvp, mixin, mixins, mod, modding, spongepowered-mixin, standalone
• Homepage: https://tomat.dev/projects/constellar
• Size: 3.99 MB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Constellar

![Gradle Build Workflow](https://github.com/Uranometrical/COnstellar/actions/workflows/gradle-build.yml/badge.svg)

![CodeFactor](https://www.codefactor.io/repository/github/Uranometrical/Constellar/badge)

![Repository size](https://img.shields.io/github/repo-size/Uranometrical/Constellar)

![Total lines of code](https://img.shields.io/tokei/lines/github/Uranometrical/Constellar)

![License](https://img.shields.io/github/license/Uranometrical/Constellar)

![Latest commit](https://img.shields.io/github/last-commit/Uranometrical/Constellar)

Experimental MC 1.8.9 PvP client that isn't necessarily focused only on Hypixel (unheard of).

# Security

Please see [`SECURITY.md`](https://github.com/uranometrical/constellar/blob/master/SECURITY.md) for our security policy.

# Contributing

Just PR (TO-DO).

# Building

Below are the steps for building. Follow the "Universal" steps, then Standalone/Forge.

`.jar` files produced follow the following format: `Constellar-version-target.jar` and `Constellar.version-target-dep.jar`. Use the `-dep` `.jar` file.

### Universal

1. Clone the repo (`git clone https://github.com/Uranometrical/Constellar && cd Constellar`)

2. Open the project with an IDE (I recommend IntelliJ). Ensure Gradle 4 is being used (provided in `gradle` folder).

3. Run `gradle setupDecompWorkspace`

### Standalone (Mixin Client)

1. Change the `constellar_build_target` property in `gradle.properties` to `standalone`.

2. Ensure Gradle has been refreshed if the build target had to be changed.

3. Run `gradle genIntellijRuns` if you're on IntelliJ.

4. Make sure the generated build module for client is `Constellar.main`.

![image](https://user-images.githubusercontent.com/45357714/142085884-95d34046-a7e6-4b09-b7a5-de675eae668c.png)

4. Make sure to reload all Gradle projects.  

![image](https://user-images.githubusercontent.com/45357714/142085841-dcdc8073-3d2e-4099-b5a1-b53e628f48eb.png)

### Forge (Mod)

1. Change the `constellar_build_target` property in `gradle.properties` to `forge`.

2. Ensure Gradle has been refreshed if the build target had to be changed.

3. Run the `build` Gradle task to generate a `.jar` to use as a mod.