|
3 | 3 | </p> |
4 | 4 |
|
5 | 5 | <p align=center> |
6 | | -<img src="https://img.shields.io/github/license/DarthGigi/MinionAH?style=for-the-badge" alt="license"> |
7 | | -<img src="https://img.shields.io/github/languages/count/DarthGigi/MinionAH?style=for-the-badge" alt="languages"> |
8 | | -<img src="https://img.shields.io/github/languages/top/DarthGigi/MinionAH?style=for-the-badge" alt="top language"> |
9 | | -<img src="https://img.shields.io/website?style=for-the-badge&url=https%3A%2F%2Fminionah.com" alt="website status"> |
| 6 | + <img src="https://img.shields.io/github/license/DarthGigi/MinionAH?style=for-the-badge" alt="license"> |
| 7 | + <img src="https://img.shields.io/github/languages/count/DarthGigi/MinionAH?style=for-the-badge" alt="languages"> |
| 8 | + <img src="https://img.shields.io/github/languages/top/DarthGigi/MinionAH?style=for-the-badge" alt="top language"> |
| 9 | + <img src="https://img.shields.io/website?style=for-the-badge&url=https%3A%2F%2Fminionah.com" alt="website status"> |
10 | 10 | </p> |
11 | 11 |
|
| 12 | +# Changelog |
| 13 | + |
| 14 | +Looking for the changelog? Check out [CHANGELOG.md](/CHANGELOG.md)! |
| 15 | + |
12 | 16 | # 📑 Table of Contents |
13 | 17 |
|
14 | 18 | - [📑 Table of Contents](#-table-of-contents) |
15 | 19 | - [🏦 MinionAH](#-minionah) |
| 20 | + - [🏠 Home](#-home) |
| 21 | + - [👤 Profile](#-profile) |
| 22 | + - [🛠️ Creating Minions](#️-creating-minions) |
16 | 23 | - [💰 Purchasing Minions](#-purchasing-minions) |
17 | | - - [🤔 Why MinionAH](#-why-minionah) |
18 | | - - [🌐 Community](#-community) |
19 | | - - [📜 Credits](#-credits) |
| 24 | +- [🤔 Why MinionAH](#-why-minionah) |
| 25 | +- [🌐 Community](#-community) |
| 26 | +- [📜 Credits](#-credits) |
| 27 | + |
20 | 28 | - [🔒 Privacy/Data](#-privacydata) |
21 | 29 | - [🤝 Contributing](#-contributing) |
22 | | - - [🧰 Setup for Development](#-setup-for-development) |
23 | | - - [📝 License](#-license) |
| 30 | +- [📝 License](#-license) |
24 | 31 |
|
25 | 32 | # 🏦 MinionAH |
26 | 33 |
|
27 | 34 | 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. |
28 | 35 |
|
29 | | -MinionAH makes it easy to sell minions and view information about minions with a glance. |
30 | | - |
31 | | - |
32 | | -As shown, it's easy to find minions on MinionAH. But it even gets better with a beautiful hover animation. Clicking the card or the user will open the seller's Discord profile. Clicking the minion will open the wiki page of the minion for even more information. |
33 | | - |
34 | | - |
35 | | -It's also super easy to search for minions on MinionAH. |
36 | | - |
37 | | - |
38 | | -After logging in with Discord, you can access your profile page where you can sell a minion, see a list of your minions and delete minions you sell or no longer want to sell. |
39 | | - |
40 | | - |
41 | | -Creating minions is very easy too. You simply select a minion from the minion dropdown, or just start typing the name of the minion. Next, select the tier and fill how many minions you're selling and the price (for each). Finally, just click Create and you're done! |
| 36 | +MinionAH makes it easy to sell minions and view information about minions at a glance. |
42 | 37 |
|
43 | | - |
| 38 | +## 🏠 Home |
44 | 39 |
|
45 | | -## 💰 Purchasing Minions |
| 40 | + |
| 41 | +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. |
| 42 | + |
46 | 43 |
|
47 | | -The way you buy minions is essentially the same as you would if using Discord servers to sell your minions. You simply DM the user that sells the minion and discuss when you both can get online and trade. You can click on the user to start a chat with them. |
| 44 | +--- |
48 | 45 |
|
49 | | -## 🤔 Why MinionAH |
| 46 | + |
50 | 47 |
|
51 | | -I 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 in the in-game chat. In both cases, the message also "disappears" since so many others are doing the same thing. |
52 | | -That's why I thought, "There must surely be a better way to tackle this problem." So I decided to work on MinionAH. |
| 48 | +## 👤 Profile |
53 | 49 |
|
54 | | -## 🌐 Community |
| 50 | +After signing up with [mc-auth](https://mc-auth.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. |
55 | 51 |
|
56 | | -<a href="https://discord.minionah.com"> |
57 | | - <img src="https://discordapp.com/api/guilds/1133219625497284638/widget.png?style=banner3" alt="Discord Server" /> |
58 | | -</a> |
| 52 | + |
59 | 53 |
|
60 | | -## 📜 Credits |
| 54 | +## 🛠️ Creating Minions |
61 | 55 |
|
62 | | -[Gigi](https://github.com/DarthGigi) - Main Developer |
| 56 | +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! |
63 | 57 |
|
64 | | -# 🔒 Privacy/Data |
| 58 | + |
65 | 59 |
|
66 | | -Here is all the data stored with MinionAH (more technical stuff incoming): |
| 60 | +--- |
67 | 61 |
|
68 | | -- IP: Whether you are logged in or not, we store your IP on the server (not the database) solely for rate-limiting purposes. You can make 60 requests per minute (searching/filtering, loading more minions, logging in, basically every time you do something on the website even loading the website, is a request). This is to prevent any malicious users from spamming requests and overloading the database and hosting provider (in which case we would need to pay more). Again, since this is not stored in the database but the server itself, not even I can see your IP. |
| 62 | + |
69 | 63 |
|
70 | | -If you log in via Discord, I get "access" to your Discord account, but the "access" is very limited (this is how every "Sign in via Discord" app/bot/website works). |
71 | | -Basically, Discord sends an extremely limited authentication token for your account so we can request the necessary info about your account for the website. Here is what info we request from Discord and store in the database: |
72 | | - |
73 | | -- Discord ID |
74 | | -- Username |
75 | | -- Avatar |
76 | | -- Banner |
77 | | -- Accent color |
78 | | -- Locale (not doing anything with it, but might add localization support later) |
79 | | -- Date/time of last logged in (not data that Discord gives me, but needed so that I can delete accounts that were last logged in an X amount of days/months ago, not sure how long I should make this yet). |
80 | | - |
81 | | -# 🤝 Contributing |
82 | | - |
83 | | -Feel free to contribute to MinionAH! Just make a Pull Request. |
84 | | - |
85 | | -## 🧰 Setup for Development |
86 | | - |
87 | | -1. Clone the repository |
88 | | - |
89 | | - ```bash |
90 | | - git clone https://github.com/DarthGigi/MinionAH.git |
91 | | - ``` |
92 | | - |
93 | | -2. Go into the directory |
94 | | - |
95 | | - ```bash |
96 | | - cd MinionAH |
97 | | - ``` |
| 64 | +## 💰 Purchasing Minions |
98 | 65 |
|
99 | | -3. Install the dependencies |
| 66 | +The way you buy minions is essentially the same as if you would be using Discord servers to sell your minions. |
| 67 | +You simply message the user who sells the minion and discuss when you both can get online and trade. |
100 | 68 |
|
101 | | - ```bash |
102 | | - pnpm install |
103 | | - ``` |
| 69 | + |
104 | 70 |
|
105 | | -4. Add an `.env` file with the same contents as `.env.example` and fill in the values. |
| 71 | +# 🤔 Why MinionAH |
106 | 72 |
|
107 | | -5. Run the database initialization script |
| 73 | +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. |
| 74 | +That's why I thought, "There must surely be a better way to tackle this problem." So I decided to work on MinionAH. |
108 | 75 |
|
109 | | - ```bash |
110 | | - pnpx prisma db push |
111 | | - ``` |
| 76 | +# 🌐 Community |
112 | 77 |
|
113 | | - and |
| 78 | +<p align=center> |
| 79 | + <a href="https://discord.minionah.com"> |
| 80 | + <img src="https://discordapp.com/api/guilds/1133219625497284638/widget.png?style=banner3" alt="Discord Server" /> |
| 81 | + </a> |
| 82 | +</p> |
114 | 83 |
|
115 | | - ```bash |
116 | | - pnpx prisma generate |
117 | | - ``` |
| 84 | +# 📜 Credits |
118 | 85 |
|
119 | | -6. Start the development server |
| 86 | +[Gigi](https://github.com/DarthGigi) - Main Developer |
120 | 87 |
|
121 | | - ```bash |
122 | | - pnpm dev |
123 | | - ``` |
| 88 | +# 🔒 Privacy/Data |
124 | 89 |
|
125 | | -7. Open `src/routes/api/resetminions/+server.ts`, remove |
| 90 | +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. |
| 91 | +These will be updated when needed, unlike this README. |
126 | 92 |
|
127 | | - ```js |
128 | | - return new Response(null, { |
129 | | - status: 302, |
130 | | - headers: { |
131 | | - location: "/" |
132 | | - } |
133 | | - }); |
134 | | - ``` |
| 93 | +# 🤝 Contributing |
135 | 94 |
|
136 | | - and open [localhost:5127/api/loadMinions](http://localhost:5127/api/loadMinions) with your browser to fill the database with minions. |
| 95 | +Contributions are welcome! Please read [CONTRIBUTING.md](/CONTRIBUTING.md) for more information. |
137 | 96 |
|
138 | | -## 📝 License |
| 97 | +# 📝 License |
139 | 98 |
|
140 | | -[GNU AGPLv3](https://github.com/DarthGigi/MinionAH/blob/main/LICENSE) |
| 99 | +This project is licensed under the [GNU AGPLv3](https://github.com/DarthGigi/MinionAH/blob/main/LICENSE) license. |
0 commit comments