MarketShark

MarketShark is a Java-based Forge mod designed to automate interactions within the Minecraft Hypixel server. Built upon the Forge1.8.9Template, this mod includes automated purchasing and other remote-controlled functionalities for users connected to Hypixel, leveraging a backend for additional features.

Credits

MarketShark was built using Forge1.8.9Template, a template repository by nea89o. This template provides the foundational setup for Forge mods targeting Minecraft version 1.8.9.

Original template features:

• Architectury Loom integration for Forge modding
• DevAuth for Minecraft account authentication
• Customizable Mod ID on template usage
• JDK 1.8 and JDK 17 compatibility for development
• Gradle build system with support for mixins

Special thanks to nea89o for providing a streamlined template for legacy Minecraft modding.

Features

• Automated item purchasing on Hypixel using the CoflNet websocket
• Backend server integration for remote control
• Remote Start/Stop functionality
• Discord bot integration for command and control
• CLI tool for easy configuration (optional)
• AutoList feature for managing in-game listings

Building MarketShark

Requirements

To build and run MarketShark, you will need:

• Java 1.8 JDK for the project SDK
• Java 17 JDK for Gradle JVM
• IntelliJ IDEA for development

Download the required JDKs from Adoptium.

Configuring MarketShark

1. Configuring env variables

   • Open gradle.properties
   • Edit the basegroup, modid if appliciable
   • Set your domain for your MarketSharkServer host

2. Switching to Unsecure (Not Reccomended)

   • Only required if using an IP or Domain that has no SSL Certifciates Served
   • Replace "wss" in DiscordIntegration.java with "ws"

Building Instructions

1. Clone the Repository

   git clone https://github.com/JackTYM/MarketShark
   cd MarketShark

2. Run build.sh Script

   chmod +x build.sh
   ./build.sh

   This script executes Gradle tasks for building different MarketShark versions:

   • buildHammerhead
   • buildWobbegong
   • buildGreatWhite
   • buildMegalodon

3. Automatic Obfuscation

   • During the build, each version automatically passes through Grunt for minor obfuscation, ensuring code security and reducing readability for external users.

4. Single Codebase with Version-Specific Features

   • MarketShark is designed to maintain a single codebase that supports multiple feature sets, which are customized per build type (e.g., Hammerhead, Wobbegong, GreatWhite, Megalodon). This emulates C++ preprocessor directives by using Regex patterns to include or exclude specific code sections based on the build type.

5. Configure IntelliJ IDEA

   • Set the Gradle JVM to the Java 17 JDK.
   • Set the Project SDK to the Java 1.8 JDK.
   • Synchronize Gradle and ensure the Minecraft Client run task appears.

6. Exporting the Mod

   • Run the gradle build task, or execute build.sh.
   • The compiled mod files can be found at build/libs/<modid>-<version>-<BuildType>.jar.
   • Ignore the jars in the build/badjars folder, as these are intermediary files.

7. Optional Configuration for Mac Users

   • Remove the -XStartOnFirstThread VM argument in your run configuration if you encounter issues running the client.

Missing Features

• None

Known Vulnerabilities

• None reported

Known Bugs

• Error when rejoining island after limbo.
• CrashPatch does not work properly

Contributing

Contributions are welcome! To contribute:

1. Fork the repository.
2. Clone your fork: git clone https://github.com/JackTYM/MarketShark.git
3. Create a new branch for your feature or bug fix: git checkout -b feature-name
4. Commit your changes: git commit -m "Add new feature"
5. Push to your fork: git push origin feature-name
6. Submit a pull request with a description of your changes.

Pull requests will be reviewed and accepted if applicable to the project goals.

---

Thank you for your interest in MarketShark!