<p align=center>
<img src="https://raw.githubusercontent.com/DarthGigi/MinionAH/main/static/assets/images/banner.png" alt="Banner">
</p>

<p align=center>
   <img src="https://img.shields.io/github/license/DarthGigi/MinionAH?style=for-the-badge" alt="license">
   <img src="https://img.shields.io/github/languages/count/DarthGigi/MinionAH?style=for-the-badge" alt="languages">
   <img src="https://img.shields.io/github/languages/top/DarthGigi/MinionAH?style=for-the-badge" alt="top language">
   <img src="https://img.shields.io/website?style=for-the-badge&url=https%3A%2F%2Fminionah.com" alt="website status">
</p>

# Changelog

Looking for the changelog? Check out [CHANGELOG.md](/CHANGELOG.md)!

# 📑 Table of Contents

- [📑 Table of Contents](#-table-of-contents)
- [🏦 MinionAH](#-minionah)
  - [🏠 Home](#-home)
  - [👤 Profile](#-profile)
  - [🛠️ Creating Minions](#️-creating-minions)
  - [💰 Purchasing Minions](#-purchasing-minions)
- [🤔 Why MinionAH](#-why-minionah)
- [🌐 Community](#-community)
- [📜 Credits](#-credits)

- [🚀 Dokploy Production Deploy](#-dokploy-production-deploy)
- [🔒 Privacy/Data](#-privacydata)
- [🤝 Contributing](#-contributing)
- [📝 License](#-license)

# 🏦 MinionAH

MinionAH is a seamless and easy-to-use way to purchase and sell Hypixel SkyBlock minions with a beautiful interface. It's designed with precision and a good user experience in mind and is perfect for _any_ SkyBlock player.

MinionAH makes it easy to sell minions and view information about minions at a glance.

## 🏠 Home

![MinionAH](/static/assets/images/readme/overview.png)
As shown, it's easy to find minions on MinionAH. But it gets even better, when you hover over a minion or a user, more info about them will show up. Clicking the user will open their profile. Clicking the minion will open the wiki page of the minion for even more information.  
![User Hover](/static/assets/images/readme/user-hover.png)

---

![Minion Hover](/static/assets/images/readme/minion-hover.png)

## 👤 Profile

After signing up with [MC-ID](https://mc-id.com), you can access your profile page where you can create a new minion listing, see a list of your minions, and delete minions you sold or no longer want to sell.

![Profile](/static/assets/images/readme/profile.png)

## 🛠️ Creating Minions

Creating minions is very easy. You simply select a minion from the minion dropdown or just start typing the name of the minion. Next, select the tier and fill in how many minions you're selling and the price (for each). Finally, just click Create and you're done!

![Select Minion](/static/assets/images/readme/select-minion.png)

---

![Create Minion](/static/assets/images/readme/create-minion.png)

## 💰 Purchasing Minions

The way you buy minions is essentially the same as if you would be using Discord servers to sell your minions.  
You simply message the user who sells the minion and discuss when you both can get online and trade.

![Chat](/static/assets/images/readme/chat.png)

# 🤔 Why MinionAH

I (Gigi) made MinionAH because (at the time of writing) you can't sell Minions in the in-game Auction House. Instead, you need to join various Discord servers and post "ad" messages in the right channels or the in-game chat. In both cases, the message also "disappears" since so many others are doing the same thing.  
That's why I thought, "There must surely be a better way to tackle this problem." So I decided to work on MinionAH.

# 🌐 Community

<p align=center>
   <a href="https://discord.tonantzintla.org">
      <img src="https://discordapp.com/api/guilds/1133219625497284638/widget.png?style=banner3" alt="Discord Server" />
   </a>
</p>

# 📜 Credits

[Gigi](https://github.com/DarthGigi) - Main Developer

# 🚀 Dokploy Production Deploy

This repository is prepared for the Dokploy production workflow using prebuilt Docker images.

What is included:

- `Dockerfile` for a production SvelteKit Node build.
- `.github/workflows/deploy.yml` to build and push images on `main`.
- `GET /health` endpoint at `src/routes/health/+server.ts` for health checks.

Required GitHub secrets:

- `DOCKERHUB_USERNAME`
- `DOCKERHUB_TOKEN`
- `DOCKERHUB_NAMESPACE` (your DockerHub username/org)
- `DOKPLOY_DEPLOY_HOOK` (optional; webhook URL from Dokploy Deployments tab)

Dokploy setup:

1. Create an Application with `Source Type: Docker`.
2. Use image `${DOCKERHUB_NAMESPACE}/minionah:latest`.
3. Set container port to `3000`.
4. Add your environment variables in Dokploy.
5. Configure health check to `http://localhost:3000/health`.

# 🔒 Privacy/Data

Check out our [Privacy Policy](https://newsroom.minionah.com/privacy-policy) and [Terms of Service](https://newsroom.minionah.com/terms-of-service) for more information.
These will be updated when needed, unlike this README.

# 🤝 Contributing

Contributions are welcome! Please read [CONTRIBUTING.md](/CONTRIBUTING.md) for more information.

# 📝 License

This project is licensed under the [GNU AGPLv3](https://github.com/DarthGigi/MinionAH/blob/main/LICENSE) license.
