diff --git a/apps/docs/docs/advanced/achievements.mdx b/apps/docs/advanced/achievements.mdx similarity index 100% rename from apps/docs/docs/advanced/achievements.mdx rename to apps/docs/advanced/achievements.mdx diff --git a/apps/docs/docs/advanced/command-bar.mdx b/apps/docs/advanced/command-bar.mdx similarity index 100% rename from apps/docs/docs/advanced/command-bar.mdx rename to apps/docs/advanced/command-bar.mdx diff --git a/apps/docs/docs/advanced/tech-stack.mdx b/apps/docs/advanced/tech-stack.mdx similarity index 100% rename from apps/docs/docs/advanced/tech-stack.mdx rename to apps/docs/advanced/tech-stack.mdx diff --git a/apps/docs/docs/changelog.mdx b/apps/docs/changelog.mdx similarity index 100% rename from apps/docs/docs/changelog.mdx rename to apps/docs/changelog.mdx diff --git a/apps/docs/docs/content/favicon.svg b/apps/docs/content/favicon.svg similarity index 100% rename from apps/docs/docs/content/favicon.svg rename to apps/docs/content/favicon.svg diff --git a/apps/docs/docs/content/icon-gd.svg b/apps/docs/content/icon-gd.svg similarity index 100% rename from apps/docs/docs/content/icon-gd.svg rename to apps/docs/content/icon-gd.svg diff --git a/apps/docs/docs/content/icon-gl.svg b/apps/docs/content/icon-gl.svg similarity index 100% rename from apps/docs/docs/content/icon-gl.svg rename to apps/docs/content/icon-gl.svg diff --git a/apps/docs/docs/content/main-banner.png b/apps/docs/content/main-banner.png similarity index 100% rename from apps/docs/docs/content/main-banner.png rename to apps/docs/content/main-banner.png diff --git a/apps/docs/docs/content/v1.2-banner.png b/apps/docs/content/v1.2-banner.png similarity index 100% rename from apps/docs/docs/content/v1.2-banner.png rename to apps/docs/content/v1.2-banner.png diff --git a/apps/docs/docs/content/v1.3-banner.png b/apps/docs/content/v1.3-banner.png similarity index 100% rename from apps/docs/docs/content/v1.3-banner.png rename to apps/docs/content/v1.3-banner.png diff --git a/apps/docs/docs/content/v1.5-banner.png b/apps/docs/content/v1.5-banner.png similarity index 100% rename from apps/docs/docs/content/v1.5-banner.png rename to apps/docs/content/v1.5-banner.png diff --git a/apps/docs/docs/content/v1.7-banner.png b/apps/docs/content/v1.7-banner.png similarity index 100% rename from apps/docs/docs/content/v1.7-banner.png rename to apps/docs/content/v1.7-banner.png diff --git a/apps/docs/docs/content/v2-banner.png b/apps/docs/content/v2-banner.png similarity index 100% rename from apps/docs/docs/content/v2-banner.png rename to apps/docs/content/v2-banner.png diff --git a/apps/docs/docs.json b/apps/docs/docs.json index 21bb28c..2534bb2 100644 --- a/apps/docs/docs.json +++ b/apps/docs/docs.json @@ -7,7 +7,7 @@ "light": "#817abb", "dark": "#c15281" }, - "favicon": "/docs/content/favicon.svg", + "favicon": "/content/favicon.svg", "navigation": { "tabs": [ { @@ -15,40 +15,40 @@ "groups": [ { "group": "General", - "pages": ["docs/getting-started"] + "pages": ["getting-started"] }, { "group": "Guides", "pages": [ - "docs/guides/customization", - "docs/guides/linking", - "docs/guides/owning-a-server", - "docs/guides/reporting-server" + "guides/customization", + "guides/linking", + "guides/owning-a-server", + "guides/reporting-server" ] }, { "group": "Advanced", "pages": [ - "docs/advanced/achievements", - "docs/advanced/command-bar", - "docs/advanced/tech-stack" + "advanced/achievements", + "advanced/command-bar", + "advanced/tech-stack" ] }, { "group": "Legal", - "pages": ["docs/legal/rules"] + "pages": ["legal/rules"] } ] }, { "tab": "Changelog", - "pages": ["docs/changelog"] + "pages": ["changelog"] } ] }, "logo": { - "light": "/docs/content/icon-gl.svg", - "dark": "/docs/content/icon-gd.svg" + "light": "/content/icon-gl.svg", + "dark": "/content/icon-gd.svg" }, "navbar": { "links": [ diff --git a/apps/docs/docs/guides/owning-a-server.mdx b/apps/docs/docs/guides/owning-a-server.mdx deleted file mode 100644 index 04330c7..0000000 --- a/apps/docs/docs/guides/owning-a-server.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: "Own a server" -folder: "Guides" ---- - - -Owning a server is quite simple and allows you to [customize your server](/docs/guides/customization) and make it stand out from other servers. Before owning your server, make sure you agree to the [ECA](Docs:legal/external-content-agreement). - -## Linking - - - - - If you haven't already, make sure your account has [already been linked with your Minecraft account](/guides/linking) - - - -Find the server you would like to own (either by looking for it, or using the keyboard shortcut Ctrl+Shift+K and searching for it) - - - -Go to the server customization tab at the top. - - - -If the owner of the server, and the user your linked to match, you will be able to own your server. -You should see a button named Click to own. Press that button, and you should automagically own the server - - - - -## I can't link my server, because my server doesn't have a author - -Your server must have an author in-order to be automagically linked, and if it doesn't have an author, that means you will have to manually link your server. To do that, make an issue on GitHub, showing that your server has no author, but needs to be linked. Show proof that you own the server, along with your account username, and your account will own the server you need. - -## There is an error while linking my server! -This most likely is because the Minehut API is blocking the server-side request to verify your the owner of that server, or your server [has no author](#i-cant-link-my-server-because-my-server-doesnt-have-a-author). -Try again in 30 minute intervals, or just make an issue on GitHub to link your server. \ No newline at end of file diff --git a/apps/docs/docs/getting-started.mdx b/apps/docs/getting-started.mdx similarity index 93% rename from apps/docs/docs/getting-started.mdx rename to apps/docs/getting-started.mdx index be3d7f1..5974117 100644 --- a/apps/docs/docs/getting-started.mdx +++ b/apps/docs/getting-started.mdx @@ -4,7 +4,6 @@ title: "Getting Started" - MHSF is an open-source wrapper for the traditional Minehut server list, either in the lobby or the one [built-in to the minehut.com website directly](https://app.minehut.com/servers). The way MHSF communicates with Minehut is using the closed Minehut API discovered by using DevTools on the original Minehut page. Along with this, there are entries that are completely third-party like for adding descriptions or banners. @@ -29,4 +28,4 @@ No. Your Minehut account is not associated with your MHSF one, and consequently, ## Conclusion -If you'd like to use MHSF, go to the server list [here](Special:Root) to try it out! You may also give MHSF a star on GitHub if you feel like this project deserves it. +If you'd like to use MHSF, go to the server list [here](/) to try it out! You may also give MHSF a star on GitHub if you feel like this project deserves it. diff --git a/apps/docs/docs/guides/customization.mdx b/apps/docs/guides/customization.mdx similarity index 75% rename from apps/docs/docs/guides/customization.mdx rename to apps/docs/guides/customization.mdx index 3a2a68d..39c450a 100644 --- a/apps/docs/docs/guides/customization.mdx +++ b/apps/docs/guides/customization.mdx @@ -3,28 +3,36 @@ title: "Customization" folder: "Guides" --- -Customizing your server is very easy after you have [linked your account](Docs:guides/linking). Make sure you have done that before then. +Customizing your server is very easy after you have [linked your account](/docs/guides/linking). Make sure you have done that before then. ## Getting started -Make sure you've also [owned your server](Docs:guides/owning-a-server). + +Make sure you've also [owned your server](/docs/guides/owning-a-server). ## Customization Types + ### Discord Server + Enable the server widget in your Discord server settings, and copy and paste in the Discord server ID, and your Discord server will appear! You can see the people inside of your server, and how many are online, along with a link to your server. ### Banner -Your server can have an image from anywhere, and can be any *static* image type that can be rendered on the web. Copy and paste the link (not the link after uploading the image, but by right clicking and hitting "Copy Image Address") into the input box! + +Your server can have an image from anywhere, and can be any _static_ image type that can be rendered on the web. Copy and paste the link (not the link after uploading the image, but by right clicking and hitting "Copy Image Address") into the input box! - Except for images hosted by Imgur, `wsrv.nl` is used to make sure users aren't IP logged. + Except for images hosted by Imgur, `wsrv.nl` is used to make sure users aren't + IP logged. ### Color Scheme + You can pick any color in the box and choosing a color scheme to show on your server specificly. ### Description + You can use Markdown formatting to add a description to describe what your server is. ## Thats it! -If you have additional customization types or other things you'd like us to add, [feel free to hit us with an issue on GitHub!](Special:GitHub) \ No newline at end of file + +If you have additional customization types or other things you'd like us to add, [feel free to hit us with an issue on GitHub!](Special:GitHub) diff --git a/apps/docs/docs/guides/linking.mdx b/apps/docs/guides/linking.mdx similarity index 100% rename from apps/docs/docs/guides/linking.mdx rename to apps/docs/guides/linking.mdx diff --git a/docs/docs/guides/owning-a-server.mdx b/apps/docs/guides/owning-a-server.mdx similarity index 68% rename from docs/docs/guides/owning-a-server.mdx rename to apps/docs/guides/owning-a-server.mdx index 04330c7..c1286ce 100644 --- a/docs/docs/guides/owning-a-server.mdx +++ b/apps/docs/guides/owning-a-server.mdx @@ -3,7 +3,6 @@ title: "Own a server" folder: "Guides" --- - Owning a server is quite simple and allows you to [customize your server](/docs/guides/customization) and make it stand out from other servers. Before owning your server, make sure you agree to the [ECA](Docs:legal/external-content-agreement). ## Linking @@ -11,21 +10,25 @@ Owning a server is quite simple and allows you to [customize your server](/docs/ - If you haven't already, make sure your account has [already been linked with your Minecraft account](/guides/linking) + If you haven't already, make sure your account has [already been linked with + your Minecraft account](/docs/guides/linking) -Find the server you would like to own (either by looking for it, or using the keyboard shortcut Ctrl+Shift+K and searching for it) + Find the server you would like to own (either by looking for it, or using the + keyboard shortcut Ctrl+Shift+K and searching + for it) -Go to the server customization tab at the top. + Go to the server customization tab at the top. -If the owner of the server, and the user your linked to match, you will be able to own your server. -You should see a button named Click to own. Press that button, and you should automagically own the server - + If the owner of the server, and the user your linked to match, you will be + able to own your server. You should see a button named Click to own. Press + that button, and you should automagically own the server + @@ -34,5 +37,6 @@ You should see a button named Click to own. Press that button, and you should au Your server must have an author in-order to be automagically linked, and if it doesn't have an author, that means you will have to manually link your server. To do that, make an issue on GitHub, showing that your server has no author, but needs to be linked. Show proof that you own the server, along with your account username, and your account will own the server you need. ## There is an error while linking my server! + This most likely is because the Minehut API is blocking the server-side request to verify your the owner of that server, or your server [has no author](#i-cant-link-my-server-because-my-server-doesnt-have-a-author). -Try again in 30 minute intervals, or just make an issue on GitHub to link your server. \ No newline at end of file +Try again in 30 minute intervals, or just make an issue on GitHub to link your server. diff --git a/apps/docs/docs/guides/reporting-server.mdx b/apps/docs/guides/reporting-server.mdx similarity index 100% rename from apps/docs/docs/guides/reporting-server.mdx rename to apps/docs/guides/reporting-server.mdx diff --git a/apps/docs/docs/legal/rules.mdx b/apps/docs/legal/rules.mdx similarity index 100% rename from apps/docs/docs/legal/rules.mdx rename to apps/docs/legal/rules.mdx diff --git a/apps/www/docs/advanced/achievements.mdx b/apps/www/docs/advanced/achievements.mdx deleted file mode 100644 index 244685c..0000000 --- a/apps/www/docs/advanced/achievements.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "Achievement Collection" -folder: "Advanced" ---- - - -# Achievements -Achievements are a page that every server gets which contains certain requirements which could be embedded in an servers history. - - - -These achievements are accessable using the "Achievements" tab on the left of any server page. -Achievements are *not* collected instantly, and are collected every 12 hours when the server is online (this is not timezone dependent). -There are currently 4 possible achievements to get, ranging from easiest to hardest. - -## 1 thousand favorites achievement -After getting 1 thousand favorites on MHSF, and your server is online during the achievement collection, *you will get this achievement showing* when you got **1,000 users to favorite your server**. - - -## 1 thousand total joins achievement -After getting 1 thousand total joins on Minehut, and your server is online during the achievement collection, *you will get this achievement showing* when you got **1,000 users to join your server**. -
Here is a preview: - - -## 100 thousand favorites achievement -After getting 100 thousand favorites on MHSF, and your server is online during the achievement collection, *you will get this achievement showing* when you got **100 thousand users to favorite your server**. -
Here is a preview: - - -## 100 thousand total joins achievement -After getting 100 thousand total joins on Minehut, and your server is online during the achievement collection, *you will get this achievement showing* when you got **100 thousand users to join your server**. -
Here is a preview: - \ No newline at end of file diff --git a/apps/www/docs/advanced/command-bar.mdx b/apps/www/docs/advanced/command-bar.mdx deleted file mode 100644 index 21406ab..0000000 --- a/apps/www/docs/advanced/command-bar.mdx +++ /dev/null @@ -1,35 +0,0 @@ ---- -title: "Using the Command-bar" -folder: "Advanced" ---- - -# Using the Command-bar - -The command-bar has many mods and is a great tool for power-users to use as its built to be fast, while showing optimal information to the scenario - - - -## Triggering the command-bar - -There are two ways to trigger the command bar, using `Ctrl+K` and Ctrl + Shift + K. Both put you in a command-bar, however when using `Ctrl+K`, you go into a general page with other settings. -Using Ctrl + Shift + K opens a server viewer, and this may be faster then going through the general page. - -## Functions using Ctrl+K - -- **Servers** opens a server list, same as Ctrl + Shift + K -- **Sort Servers** allows you to go into a sorted server list quickly -- **Links** shows links useful for MHSF -- **Pick Random Server** picks a random server and shows the user what that server is, is similar to the one on [the server list](/) -

- **Profile (requires log-in):** -- **Favorites** shows the user their favorited servers -- **User Settings** shows the user the settings for Clerk - -## Servers - -This view shows the most popular 50 servers, and when searching, you can search for any server that exists (offline or online). -When clicking on a server, you see a simple view showing information about the server, along with a link to the server page. - -## Trigger from information popover - -Click the top-right info button, and click Open Commands. This will open the same `Ctrl+K` command-bar, if you would like to use it on mobile. diff --git a/apps/www/docs/advanced/external.mdx b/apps/www/docs/advanced/external.mdx deleted file mode 100644 index bccd615..0000000 --- a/apps/www/docs/advanced/external.mdx +++ /dev/null @@ -1,94 +0,0 @@ ---- -title: "Troubleshooting: Making external servers on Minehut" -folder: "Advanced" ---- - -# External Servers on Minehut -I think creating external servers on Minehut is an advanced subject, and it is not documented well enough for the circumstances that -might occur with server owners. This is a [extension/rephrasing of the offical wiki guide](Wiki:External). All points in **bold** are things you shouldn't miss, and are commonly misread. - -
- -_Note: This is an unoffical guide, but the offical way of connecting! This is safe!_ -## Getting started -You must pick a host that allows the following when making external servers: - - **Editing server flags** Editing flags for the server to run is essential. There are many cases where you were not able to continue because your provider was resetting your flags back - - **A supported server software** For standalone servers, you must run on [Paper](https://papermc.io/software/paper). For proxy networks, you can use [Velocity](https://velocitypowered.com/), [Waterfall](https://papermc.io/software/waterfall) & [Lilypad](https://www.lilypadmc.org/). **BungeeCord is not supported by any means!** - -Minehut offically recommends Velocity, which you can find instructions [here](https://docs.papermc.io/velocity/getting-started) to get going! If you do not wish to use a proxy, using Paper is recommended, which you can find a guide [here](https://docs.papermc.io/paper/getting-started). -Before doing below, **make sure your proxy _actually works!_** - -## Changing flags -To ensure that Minehut can properly connect your players to your server, you need to add flags when booting up your server. These are commonly in `start.bat` or `start.sh` for Linux-based hosts. **Players cannot join your server from Minehut without adding these flags!** - - -### Velocity -Add the following `sessionserver` flag to your start script: - ``` - -Dmojang.sessionserver=https://api.minehut.com/mitm/proxy/session/minecraft/hasJoined - ``` - All flags put together should look like the following: - ``` - java -Dmojang.sessionserver=https://api.minehut.com/mitm/proxy/session/minecraft/hasJoined -jar velocity.jar - ``` - -### Paper - standalone - Like said above, if you run a proxy, add the flags for Velocity. **Adding both the Velocity (or any other proxy server) & Paper flags will cause your server to be unauthenticatable!**
- Add the following `auth.host`, `account.host`, `services.host` & `session.host` flags: - ``` - -Dminecraft.api.auth.host=https://authserver.mojang.com/ - -Dminecraft.api.account.host=https://api.mojang.com/ - -Dminecraft.api.services.host=https://api.minecraftservices.com/ - -Dminecraft.api.session.host=https://api.minehut.com/mitm/proxy - ``` - All the script together - ``` - java -Dminecraft.api.auth.host=https://authserver.mojang.com/ -Dminecraft.api.account.host=https://api.mojang.com/ -Dminecraft.api.services.host=https://api.minecraftservices.com/ -Dminecraft.api.session.host=https://api.minehut.com/mitm/proxy -jar paper.jar - ``` - **Along with this,** make sure to set the `enforce-secure-profile` flag in the `server.properties` file to `false`. - ``` - enable-status=true - # Set this to false! - enforce-secure-profile=false - enforce-whitelist=false - ``` - - -### Lilypad -Set the following environment variable `LILYPAD_MOJANG_SESSIONSERVER_URL` to `https://api.minehut.com/mitm/proxy/session/minecraft/hasJoined`. Environment variables are set as a seperate command in the start script: -``` -LILYPAD_MOJANG_SESSIONSERVER_URL="https://api.minehut.com/mitm/proxy/session/minecraft/hasJoined" -``` -If above doesn't work, try this: -``` -export LILYPAD_MOJANG_SESSIONSERVER_URL="https://api.minehut.com/mitm/proxy/session/minecraft/hasJoined" -``` - -## Enable Proxy Protocol -_Note: Skip this step if you're using [TCPShield](https://tcpshield.com/) for DDoS protection._ - -Enable proxy protocol in your proxy's configuration file: -### Velocity - -In `velocity.toml` under advanced, set -``` -haproxy-protocol = true -``` -### Waterfall - -In `config.yml` under listeners, set -``` -proxy_protocol: true -``` -### Paper - -In `config/paper-global.yml` under proxies, set -``` -proxy-protocol: true -``` - -## Thats it! -After this, there are mostly no more common issues. Continue on [the wiki](Wiki:External#Connect_Your_External_Server_Plan_on_Minehut)! - -## Have any issues? -Go to the offical Minehut Discord server and go into the [#ask-for-help](https://discord.com/channels/239599059415859200/1014801630295760897) channel and create a thread. \ No newline at end of file diff --git a/apps/www/docs/advanced/tech-stack.mdx b/apps/www/docs/advanced/tech-stack.mdx deleted file mode 100644 index f8768cc..0000000 --- a/apps/www/docs/advanced/tech-stack.mdx +++ /dev/null @@ -1,24 +0,0 @@ ---- -title: "Tech-stack" -folder: "Advanced" ---- - -# Teck Stack of MHSF -The tech stack of MHSF is relatively modern to ensure MHSF keeps up with standards set for accessibility and usability. - -## Front-end -- **React** is used as a way to replicate components already used, and use the eco-system of pre-existing components -- **shadcn/ui** is the UI framework used to keep the whole website consistent. -- **Contentlayer** manages all the pages used for documentation -- **TailwindCSS** makes MHSF use (mostly) no CSS for better efficency -- **Sonner** provides the Toast used for MHSF - -## Back-end -- **Inngest** runs periodic tasks -- **MongoDB** is the database of choice for MHSF - -## Both -- **Clerk** is used for authentication of users -- **Next.js** is used to make sure API endpoints and front-end endpoints are on the same domain, along with lots of convient features -- **Vercel** is hosting MHSF (along with non-tracking analytics) - diff --git a/apps/www/docs/getting-started.mdx b/apps/www/docs/getting-started.mdx deleted file mode 100644 index b91b255..0000000 --- a/apps/www/docs/getting-started.mdx +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: "Getting Started" ---- - -# Getting Started to MHSF - -MHSF is an open-source wrapper for the traditional Minehut server list, either in the lobby or the one [built-in to the minehut.com website directly](https://app.minehut.com/servers). -The way MHSF communicates with Minehut is using the closed Minehut API discovered by using DevTools on the original Minehut page. -Along with this, there are entries that are completely third-party like for adding descriptions or banners. - -## What is a wrapper? - -Wrappers are usually free & open-source software that goes on-top of existing software that may be proprietary. There are many reasons for a wrapper to exist (privacy, automation, etc.), in MHSF's case, its because the Minehut server list provided by default just doesn't cut it. -Wrappers usually communicate using an API that was provided by the service its self, making software like MHSF completely legal. - -## Why to use MHSF - -- **Faster response times** MHSF is completely ad-free, and as a result of being open-source, constantly tries to cut down on unnecessary things slowing down the page. -- **Open-source & no tracking** As a result of being open-source, MHSF will never track or sell your data to advertisers. Anybody can look at the code, and can be verified to be completely secure. -- **Make your server stand out** Server owners can configure after appropriate verification banners, Discord widgets, descriptions & color schemes. -- **Customize your experience** Filters, sorts & different spacing settings can make your experience just how you like it while you are browsing servers. -- **Better & more intuitive UX/UI** UI is a big point for MHSF, using UI designed to be more user friendly, and to be more straight-forward then Minehut's -- **One focus** Because MHSF is only a server-list, it only has to be, _a server list!_ This means more updates and higher quality ones because all MHSF has to worry about, is the server list! - -## Will you get banned for this? - -No. Your Minehut account is not associated with your MHSF one, and consequently, you cannot be banned. There is no risk of getting banned by Minehut, as we are posing no threat to them. As long as you aren't spamming MHSF (or the API in general), you should be good. - -## Conclusion - -If you'd like to use MHSF, go to the server list [here](Special:Root) to try it out! You may also give MHSF a star on GitHub if you feel like this project deserves it. diff --git a/apps/www/docs/guides/customization.mdx b/apps/www/docs/guides/customization.mdx deleted file mode 100644 index 5f16cae..0000000 --- a/apps/www/docs/guides/customization.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: "Customization" -folder: "Guides" ---- - -# Customize your server -Customizing your server is very easy after you have [linked your account](Docs:guides/linking). Make sure you have done that before then. - -## Getting started -Make sure you've also [owned your server](Docs:guides/owning-a-server). - -## Customization Types -### Discord Server -Enable the server widget in your Discord server settings, and copy and paste in the Discord server ID, and your Discord server will appear! - -### Banner -Your server must have an image from [Imgur](https://imgur.com), and can be any image type that can be rendered on the web. Copy and paste the link (not the link after uploading the image, but by right clicking and hitting "Copy Image Address") into the input box! - -### Color Scheme -You can pick any color in the box and choosing a color scheme to show on your server specificly. - -### Description -You can use Markdown formatting to add a description to describe what your server is. - -## Thats it! -If you have additional customization types or other things you'd like us to add, [feel free to hit us with an issue on GitHub!](Special:GitHub) \ No newline at end of file diff --git a/apps/www/docs/guides/linking.mdx b/apps/www/docs/guides/linking.mdx deleted file mode 100644 index f5d0c5c..0000000 --- a/apps/www/docs/guides/linking.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -title: "Linking your account" -folder: "Guides" ---- - -# Linking your Minecraft account - -MHSF uses a safe & secure system to link your account that **doesn't use your Microsoft account in any way**. MHSF uses a simple system of logging into a server, and then putting a code into the website. - - - -## Prerequisites - -- An active account with MHSF (either linked through GitHub or Discord, or just a standard email account) -- A Minecraft Java Edition account (Bedrock accounts are not guaranteed to work, and could malfunction at some times) - -## Linking - -To get started, go into your account settings (your profile picture in top-right, and Profile & Security) and click Link Account. -Login to the server `MHSFPV.minehut.gg`. (its on a free plan, you may have to start it in the lobby) Take the code shown in chat, and put it into the OTP box. Hit Submit, and if the code is correct, your account will be linked! Congratulations! - -## Functions - -You can do many things with a linked account: - -- [Own a server](Docs:guides/owning-a-server) -- [Customize a server](Docs:guides/customization) - -More will be coming in future updates, however the only thing you can do with a linked account is server-based functions. diff --git a/apps/www/docs/guides/owning-a-server.mdx b/apps/www/docs/guides/owning-a-server.mdx deleted file mode 100644 index 702f0df..0000000 --- a/apps/www/docs/guides/owning-a-server.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -title: "Own a server" -folder: "Guides" ---- - -# Owning a server - -Owning a server is quite simple and allows you to [customize your server](/docs/guides/customization) and make it stand out from other servers. Before owning your server, make sure you agree to the [ECA](Docs:legal/external-content-agreement). - -## Linking - -Find the server you would like to own (either by looking for it, or using the keyboard shortcut Ctrl+Shift+K and searching for it), and make sure your account has [already been linked with your Minecraft account](Docs:guides/linking). Go to the server, and hit the Customization tab. If the owner of the server, and the user your linked to match, you will gain access to the server. -If they match, you should see a button named Click to own. Press that button, and you should automagically own the server. Congratulations! - -## I can't link my server, because my server doesn't have a author - -Your server must have an author in-order to be automagically linked, and if it doesn't have an author, that means you will have to manually link your server. To do that, make an issue on GitHub, showing that your server has no author, but needs to be linked. Show proof that you own the server, along with your account username, and your account will own the server you need. - -## There is an error while linking my server! -This most likely is because the Minehut API is blocking the server-side request to verify your the owner of that server, or your server [has no author](#i-cant-link-my-server-because-my-server-doesnt-have-a-author). -Try again in 30 minute intervals, or just make an issue on GitHub to link your server. \ No newline at end of file diff --git a/apps/www/docs/guides/reporting-server.mdx b/apps/www/docs/guides/reporting-server.mdx deleted file mode 100644 index 394ff81..0000000 --- a/apps/www/docs/guides/reporting-server.mdx +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: "Reporting a server" -folder: "Guides" ---- - -# Reporting a server - -If you believe a server that you've seen is under breach of the [ECA Agreement](Docs:legal/external-content-agreement), you may request the server in question to be taken down. -Make sure you are logged into a account, and go to the server page and hit the customization tab. Hit the Report button, and add a reason to your report. -Your report will be processed and the appropriate action will be taken. - -## Issue inside the server -If an issue is inside of the server, because MHSF doesn't provide the server list source (Minehut API), you must [go to Minehut and make a ticket](https://support.minehut.com/hc/en-us/requests/new?tf_subject=Reporting%20Server&tf_27062997154195=reports_appeals&tf_27063229498259=report_server). \ No newline at end of file diff --git a/apps/www/docs/legal/external-content-agreement.mdx b/apps/www/docs/legal/external-content-agreement.mdx deleted file mode 100644 index 8a322db..0000000 --- a/apps/www/docs/legal/external-content-agreement.mdx +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: "External Content Agreement" -folder: "Legal" -lastUpdated: "Sep. 10th 2024" ---- - -# External Content Agreement (ECA) - -By making external content available for anyone to see, there needs to -be an agreement to keep MHSF ("Minehut Server List") a friendly place -for anyone to look at. _As such, this agreement outlines what you can't and can do, when making content on the platform._ The goal by making an agreement like this, is not to make you worried -what you can upload, its just showing what the limits of content -uploaded onto the platform are. - -## Source Code - -The source code for MHSF is defined by the [MIT License](Special:GitHub/blob/main/LICENSE). You are free to use MHSF for commercial use, and you may modify the software however you'd like. Taking copies of the software (aka _"forking"_) is also freely allowed. - -## What your limits are - -When creating content, if its a matter of making a profile picture, -or editing the description for a server, (and more), you must follow -the underlying agreements below.
-For making banners & descriptions, you must follow [Minehuts Terms of Service](Wiki:Rules) _as all content made is associated to Minehut (as the server is mostly on a community for Minehut)._
-For making Discord server embeds, you must follow [Discords Terms of Service](https://discord.com/terms/) _as all content made is associated to Discord._ - -### All other content - -For all other content, they must follow the following: - -- No inappropriate/adult images -- No swear words of any kind or slurs -- Endorsing unethical client modifications (aka cheating or hacking) - -## When you agree to the ECA - -When you add customization to your server, or add a profile picture (linking an account is included), you must follow the ECA. - -## When linking an account - -When linking an account, you must follow the privacy policy and terms of service to the associated service that you linked your MHSF account to. Additionally, if you link an external account{" "} -_after_ account creation, everything said before is still true. - -## Violations - -Violations from above have 1 warning. Your first interaction is a warning by removing the content from MHSF, and your 2nd is banning/deleting your account. (some violations are an instant delete) - -## Reporting - -If you personally see a violation of the ECA, you can report it by clicking the customization tab on a server, and hitting the Report -button (it doesn't appear when the server was never owned). If you misuse this feature, you may get your account deleted. diff --git a/apps/www/docs/reading.mdx b/apps/www/docs/reading.mdx deleted file mode 100644 index 4505313..0000000 --- a/apps/www/docs/reading.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Reading the docs" ---- - -# Reading the docs -The documentation in MHSF has some special symbols used in the docs that might be useful to know. - - - -## Icons -When looking at a link, there will be symbols used that indicate where the link is going: *(these apply to the whole site)* - - indicates the link will link to the [official Minehut wiki](Wiki:/) - - indicates the link will link to another page on the docs - - indicates the link will go to an external site - -When contributing, these links are as follows: -``` -Wiki: -Docs: -Special:Root (links back to /) -https://example.com - -**Example:** -[Ranks](Wiki:Ranks) -[Getting Started](Docs:Getting-started) -https://google.com -``` - -The icons above will be automatically added when using the syntax above.
-The source code for above is stored [here](Special:GitHub/edit/main/src/components/misc/Link.tsx) \ No newline at end of file diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index a0e7716..0000000 --- a/docs/README.md +++ /dev/null @@ -1,32 +0,0 @@ -# Mintlify Starter Kit - -Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including - -- Guide pages -- Navigation -- Customizations -- API Reference pages -- Use of popular components - -### Development - -Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command - -``` -npm i -g mintlify -``` - -Run the following command at the root of your documentation (where docs.json is) - -``` -mintlify dev -``` - -### Publishing Changes - -Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard. - -#### Troubleshooting - -- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies. -- Page loads as a 404 - Make sure you are running in a folder with `docs.json` diff --git a/docs/docs.json b/docs/docs.json deleted file mode 100644 index 21bb28c..0000000 --- a/docs/docs.json +++ /dev/null @@ -1,71 +0,0 @@ -{ - "$schema": "https://mintlify.com/docs.json", - "theme": "maple", - "name": "MHSF Docs", - "colors": { - "primary": "#817abb", - "light": "#817abb", - "dark": "#c15281" - }, - "favicon": "/docs/content/favicon.svg", - "navigation": { - "tabs": [ - { - "tab": "Documentation", - "groups": [ - { - "group": "General", - "pages": ["docs/getting-started"] - }, - { - "group": "Guides", - "pages": [ - "docs/guides/customization", - "docs/guides/linking", - "docs/guides/owning-a-server", - "docs/guides/reporting-server" - ] - }, - { - "group": "Advanced", - "pages": [ - "docs/advanced/achievements", - "docs/advanced/command-bar", - "docs/advanced/tech-stack" - ] - }, - { - "group": "Legal", - "pages": ["docs/legal/rules"] - } - ] - }, - { - "tab": "Changelog", - "pages": ["docs/changelog"] - } - ] - }, - "logo": { - "light": "/docs/content/icon-gl.svg", - "dark": "/docs/content/icon-gd.svg" - }, - "navbar": { - "links": [ - { - "label": "Support", - "href": "mailto:support@mhsf.app" - } - ], - "primary": { - "type": "button", - "label": "MHSF", - "href": "https://mhsf.app" - } - }, - "footer": { - "socials": { - "github": "https://github.com/DeveloLongScript/MHSF" - } - } -} diff --git a/docs/docs/advanced/achievements.mdx b/docs/docs/advanced/achievements.mdx deleted file mode 100644 index f02021f..0000000 --- a/docs/docs/advanced/achievements.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Achievement Collection" -folder: "Advanced" ---- - -Achievements are a page that every server gets which contains certain requirements which could be embedded in an servers history. - - -These achievements are accessable using the "Achievements" tab on the left of any server page. -Achievements are *not* collected instantly, and are collected every 12 hours when the server is online (this is not timezone dependent). -There are currently 4 possible achievements to get, ranging from easiest to hardest. - -## 1 thousand favorites achievement -After getting 1 thousand favorites on MHSF, and your server is online during the achievement collection, *you will get this achievement showing* when you got **1,000 users to favorite your server**. - -## 1 thousand total joins achievement -After getting 1 thousand total joins on Minehut, and your server is online during the achievement collection, *you will get this achievement showing* when you got **1,000 users to join your server**. - -## 100 thousand favorites achievement -After getting 100 thousand favorites on MHSF, and your server is online during the achievement collection, *you will get this achievement showing* when you got **100 thousand users to favorite your server**. - -## 100 thousand total joins achievement -After getting 100 thousand total joins on Minehut, and your server is online during the achievement collection, *you will get this achievement showing* when you got **100 thousand users to join your server**. \ No newline at end of file diff --git a/docs/docs/advanced/command-bar.mdx b/docs/docs/advanced/command-bar.mdx deleted file mode 100644 index 038a617..0000000 --- a/docs/docs/advanced/command-bar.mdx +++ /dev/null @@ -1,34 +0,0 @@ ---- -title: "Using the Command-bar" -folder: "Advanced" ---- - - -The command-bar has many mods and is a great tool for power-users to use as its built to be fast, while showing optimal information to the scenario - - - -## Triggering the command-bar - -There are two ways to trigger the command bar, using `Ctrl+K` and Ctrl + Shift + K. Both put you in a command-bar, however when using `Ctrl+K`, you go into a general page with other settings. -Using Ctrl + Shift + K opens a server viewer, and this may be faster then going through the general page. - -## Functions using Ctrl+K - -- **Servers** opens a server list, same as Ctrl + Shift + K -- **Sort Servers** allows you to go into a sorted server list quickly -- **Links** shows links useful for MHSF -- **Pick Random Server** picks a random server and shows the user what that server is, is similar to the one on [the server list](/) -

- **Profile (requires log-in):** -- **Favorites** shows the user their favorited servers -- **User Settings** shows the user the settings for Clerk - -## Servers - -This view shows the most popular 50 servers, and when searching, you can search for any server that exists (offline or online). -When clicking on a server, you see a simple view showing information about the server, along with a link to the server page. - -## Trigger from information popover - -Click the top-right info button, and click Open Commands. This will open the same `Ctrl+K` command-bar, if you would like to use it on mobile. diff --git a/docs/docs/advanced/tech-stack.mdx b/docs/docs/advanced/tech-stack.mdx deleted file mode 100644 index 65b109f..0000000 --- a/docs/docs/advanced/tech-stack.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Tech-stack" -folder: "Advanced" ---- - -The tech stack of MHSF is relatively modern to ensure MHSF keeps up with standards set for accessibility and usability. - -## Front-end -- **React** is used as a way to replicate components already used, and use the eco-system of pre-existing components -- **shadcn/ui** is the UI framework used to keep the whole website consistent. -- **Contentlayer** manages all the pages used for documentation -- **TailwindCSS** makes MHSF use (mostly) no CSS for better efficency -- **Sonner** provides the Toast used for MHSF - -## Back-end -- **Inngest** runs periodic tasks -- **MongoDB** is the database of choice for MHSF - -## Both -- **Clerk** is used for authentication of users -- **Next.js** is used to make sure API endpoints and front-end endpoints are on the same domain, along with lots of convient features -- **Vercel** is hosting MHSF (along with non-tracking analytics) - diff --git a/docs/docs/changelog.mdx b/docs/docs/changelog.mdx deleted file mode 100644 index 3ecfce9..0000000 --- a/docs/docs/changelog.mdx +++ /dev/null @@ -1,142 +0,0 @@ ---- -title: "Changelog" ---- - - - -## Changelog -- Moved entire technical structure from single-project to mono-repo to prepare for v2. -- Added new banner - -## v2 -MHSF has been a great project of mine for nearly 9 months now, however the frontend of MHSF has always been buggy and complex to modify. MHSF was built at first as a project that was expected to only last a week & be one of my many abandoned projects, meaning it was not meant to have the best code. v2 is a complete redo of the frontend from the server-list to your settings, expecting to look even better than before. - -I always didn't have the best idea of UI concepts for the project, and when it started I was definitely worse than where I was at this point. v2 is expected to change that with my own custom UI that very much looks a lot better than pre-v2 MHSF. And of course, it will be fully open-source along-side MHSF and documented for others to use in their own projects, and will be aimed to be compatible with shadcn/ui for an ideal developer experience. - -From the bottom of my heart, I am very grateful for the relatively small amount of support we got with this project and with v2, we are expected to do even better and bring in more people. Always remember you can contact me on Discord (`@giftedly`) if you have any suggestions, bug issues (or use GitHub issues) or anything else related to MHSF done for you, it would be greatly appreciated. - -Happy valentines y'all. See you guys when v2 is done. 💗 - -[ View on GitHub](https://github.com/DeveloLongScript/MHSF/releases/tag/1.8) - - - -## Changelog -- Migrated accounts from development to production - -[ View on GitHub](https://github.com/DeveloLongScript/MHSF/releases/tag/1.7.5) - - - - -## Changelog -- Partnered with CoreBoxx! -- You can now link your Minecraft account on CoreBoxx! (check out CB 3.0.15) -- Revamped the server finding controls -- Fixed various bugs -- Made banners a different style -- Made Discord embed not inside a card -- Added incorrect server capitalization detection -- Made the MOTD area slightly bigger -- New footer -- Added padding for settings page -- Added new table mode -- Added new button for GitHub release on changelog - -[ View on GitHub](https://github.com/DeveloLongScript/MHSF/releases/tag/1.7) - - - - -## Changelog -- New MOTD engine that is over 3,000% faster, runs client-side, and doesn't need any requests to run. -- Adding snowfall finally (better late then ever) -- Fixed issue where GitHub link was broken if you were signed-out - -This is going to (probably) be the last version of 2024. Happy holidays to everyone! - -[ View on GitHub](https://github.com/DeveloLongScript/MHSF/releases/tag/1.6.5) - - - -## Changelog -- Completely redid top of server view -- New theme transition (smooth) -- New favorite button -- Favorite counts are now prominent on the server view -- Added more padding in the server view -- Separated the tabs on the side for sharing actions -- Added new QR code generator - -[ View on GitHub](https://github.com/DeveloLongScript/MHSF/releases/tag/1.6) - - - - - -## Changelog - -- New embeds -- More mobile friendly elements -- Better tabs in the server -- Fixed issue where some servers due to their age were not loading - -## More about our domain change - -For the past months or so, we were using the https://list.mlnehut.com domain. (yes, the website is still a rickroll 😆 ) I was not intending for the long-term to use this domain, but I didn't have the time to actually buy a domain then. The old domain was provided by Tarna, thanks! However, now I've moved MHSF to a simplistic domain, MHSF! - -I hope I can update MHSF more and more going into the holiday season! ❤️ - -[ View on GitHub](https://github.com/DeveloLongScript/MHSF/releases/tag/1.5) - - - -## Changelog -- Completely revamped the documentation using the new Sidebar component -- Completely redid the change log for different tabs and using the new Sidebar component -- New inbuilt joins chart inside of the hover menu of a server -- Added new server icons tab on servers with rarities and their names - -[ View on GitHub](https://github.com/DeveloLongScript/MHSF/releases/tag/1.4.5) - - - -## Changelog -- Some minor backend changes - -FYI: Hey! Recently I've broken my wrist, and I couldn't work on MHSF for longer. I've taken some weeks to take a break from MHSF & heal my wrist. Expect to see some new updates over the weekend and for the next weeks or so. I'm still not giving up on MHSF any time soon, and I'm working on affiliates for MHSF as well. - -Thank you for sticking around for the time ❤️ - -[ View on GitHub](https://github.com/DeveloLongScript/MHSF/releases/tag/1.3.2) - - - - - -## Changelog - -- New documentation linking -- Achievements are here! -- Finally fixed Cron actions for the final time™ -- Overhauled account preferences -- Better contributing documentation - -[ View on GitHub](https://github.com/DeveloLongScript/MHSF/releases/tag/1.3) - - - - - - -## Changelog - -- Brand new documentation -- Syncing server list customizations across account -- Fixed bugs & some more - -_PS_: This release took over 5 days from the last release, why? Because we have made a brand new system to add Cron actions. This will make the statistics more consistent. - -[ View on GitHub](https://github.com/DeveloLongScript/MHSF/releases/tag/1.2) - - diff --git a/docs/docs/content/favicon.svg b/docs/docs/content/favicon.svg deleted file mode 100644 index cb6ee88..0000000 --- a/docs/docs/content/favicon.svg +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - - - - - - - - - - - diff --git a/docs/docs/content/icon-gd.svg b/docs/docs/content/icon-gd.svg deleted file mode 100644 index 208859c..0000000 --- a/docs/docs/content/icon-gd.svg +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - - - - - - - - - - diff --git a/docs/docs/content/icon-gl.svg b/docs/docs/content/icon-gl.svg deleted file mode 100644 index 70541db..0000000 --- a/docs/docs/content/icon-gl.svg +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - - - - - - - - - - diff --git a/docs/docs/content/main-banner.png b/docs/docs/content/main-banner.png deleted file mode 100644 index 4323424..0000000 Binary files a/docs/docs/content/main-banner.png and /dev/null differ diff --git a/docs/docs/content/v1.2-banner.png b/docs/docs/content/v1.2-banner.png deleted file mode 100644 index 9354694..0000000 Binary files a/docs/docs/content/v1.2-banner.png and /dev/null differ diff --git a/docs/docs/content/v1.3-banner.png b/docs/docs/content/v1.3-banner.png deleted file mode 100644 index 1bd4b04..0000000 Binary files a/docs/docs/content/v1.3-banner.png and /dev/null differ diff --git a/docs/docs/content/v1.5-banner.png b/docs/docs/content/v1.5-banner.png deleted file mode 100644 index 3d37172..0000000 Binary files a/docs/docs/content/v1.5-banner.png and /dev/null differ diff --git a/docs/docs/content/v1.7-banner.png b/docs/docs/content/v1.7-banner.png deleted file mode 100644 index 01f21e0..0000000 Binary files a/docs/docs/content/v1.7-banner.png and /dev/null differ diff --git a/docs/docs/content/v2-banner.png b/docs/docs/content/v2-banner.png deleted file mode 100644 index 76c824a..0000000 Binary files a/docs/docs/content/v2-banner.png and /dev/null differ diff --git a/docs/docs/getting-started.mdx b/docs/docs/getting-started.mdx deleted file mode 100644 index 945ff41..0000000 --- a/docs/docs/getting-started.mdx +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: "Getting Started" ---- - - - - - -MHSF is an open-source wrapper for the traditional Minehut server list, either in the lobby or the one [built-in to the minehut.com website directly](https://app.minehut.com/servers). -The way MHSF communicates with Minehut is using the closed Minehut API discovered by using DevTools on the original Minehut page. -Along with this, there are entries that are completely third-party like for adding descriptions or banners. - -## What is a wrapper? - -Wrappers are usually free & open-source software that goes on-top of existing software that may be proprietary. There are many reasons for a wrapper to exist (privacy, automation, etc.), in MHSF's case, its because the Minehut server list provided by default just doesn't cut it. -Wrappers usually communicate using an API that was provided by the service its self, making software like MHSF completely legal. - -## Why to use MHSF - -- **Faster response times** MHSF is completely ad-free, and as a result of being open-source, constantly tries to cut down on unnecessary things slowing down the page. -- **Open-source & no tracking** As a result of being open-source, MHSF will never track or sell your data to advertisers. Anybody can look at the code, and can be verified to be completely secure. -- **Make your server stand out** Server owners can configure after appropriate verification banners, Discord widgets, descriptions & color schemes. -- **Customize your experience** Filters, sorts & different spacing settings can make your experience just how you like it while you are browsing servers. -- **Better & more intuitive UX/UI** UI is a big point for MHSF, using UI designed to be more user friendly, and to be more straight-forward then Minehut's -- **One focus** Because MHSF is only a server-list, it only has to be, _a server list!_ This means more updates and higher quality ones because all MHSF has to worry about, is the server list! - -## Will you get banned for this? - -No. Your Minehut account is not associated with your MHSF one, and consequently, you cannot be banned. There is no risk of getting banned by Minehut, as we are posing no threat to them. As long as you aren't spamming MHSF (or the API in general), you should be good. - -## Conclusion - -If you'd like to use MHSF, go to the server list [here](Special:Root) to try it out! You may also give MHSF a star on GitHub if you feel like this project deserves it. diff --git a/docs/docs/guides/customization.mdx b/docs/docs/guides/customization.mdx deleted file mode 100644 index 3a2a68d..0000000 --- a/docs/docs/guides/customization.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: "Customization" -folder: "Guides" ---- - -Customizing your server is very easy after you have [linked your account](Docs:guides/linking). Make sure you have done that before then. - -## Getting started -Make sure you've also [owned your server](Docs:guides/owning-a-server). - -## Customization Types -### Discord Server -Enable the server widget in your Discord server settings, and copy and paste in the Discord server ID, and your Discord server will appear! -You can see the people inside of your server, and how many are online, along with a link to your server. - -### Banner -Your server can have an image from anywhere, and can be any *static* image type that can be rendered on the web. Copy and paste the link (not the link after uploading the image, but by right clicking and hitting "Copy Image Address") into the input box! - - - Except for images hosted by Imgur, `wsrv.nl` is used to make sure users aren't IP logged. - - -### Color Scheme -You can pick any color in the box and choosing a color scheme to show on your server specificly. - -### Description -You can use Markdown formatting to add a description to describe what your server is. - -## Thats it! -If you have additional customization types or other things you'd like us to add, [feel free to hit us with an issue on GitHub!](Special:GitHub) \ No newline at end of file diff --git a/docs/docs/guides/linking.mdx b/docs/docs/guides/linking.mdx deleted file mode 100644 index 223d320..0000000 --- a/docs/docs/guides/linking.mdx +++ /dev/null @@ -1,57 +0,0 @@ ---- -title: "Linking your account" -folder: "Guides" ---- - - -MHSF uses a safe & secure system to link your account that **doesn't use your Microsoft account in any way**. MHSF uses a simple system of logging into a server, and then putting a code into the website. - - - -## Prerequisites - -- An active account with MHSF (either linked through GitHub or Discord, or just a standard email account) -- A Minecraft Java Edition account (Bedrock accounts are not guaranteed to work, and could malfunction at some times) - -## Linking - - - -Hit your profile on the top, and go to the settings - - -If your account hasn't already been linked, you should be able to hit the Link button. - - -You can pick either one of these options: -- **CoreBoxx**, a popular box server, is also a MHSF partner who has partnered to add the plugin to allow you to link through the server. - The server should be online all day, and is recommended to use. -- **MHSFPV** was a server designed for only linking. This option is not recommended because **the server is always offline** and must be turned on manually. - - -Join the server using either `CoreBoxx.minehut.gg` or `MHSFPV.minehut.gg` - - Like said above, MHSFPV will most likely need to be turned on via the lobby. - -If using CoreBoxx, type the `/mhsf` command. - -If either server denies you saying you were already linked, and you were linked before, hit the "Force unlink" link in the "Unlink" section. -This is a known bug. - - - -Use the code from this server and input it into MHSF, and then submit. - - -You should be linked. - - - -## Functions - -You can do many things with a linked account: - -- [Own a server](/guides/owning-a-server) -- [Customize a server](/guides/customization) - -More will be coming in future updates, however the only thing you can do with a linked account is server-based functions. diff --git a/docs/docs/guides/reporting-server.mdx b/docs/docs/guides/reporting-server.mdx deleted file mode 100644 index 076b18b..0000000 --- a/docs/docs/guides/reporting-server.mdx +++ /dev/null @@ -1,40 +0,0 @@ ---- -title: "Reporting a server" -folder: "Guides" ---- - -If you believe a server that you've seen is under breach of the [Rules](/docs/legal/rules), you may request the server in question to be taken down. - - - - - Make sure you are logged into a account - - - Find the server you would like to own (either by looking for it, or using - the keyboard shortcut Ctrl+Shift+K and - searching for it) - - Go to the customization tab - - - This will send a notification to MHSF maintainers. This server must be in - violation of the Rules to be a valid - report. Typical response times include 1 hour to 1 day, and you will not - be notified if your report is successful or not.{" "} - - Please do not spam this form with mindless reports. If you do, your - account will be banned. We are not Minehut support, we cannot help you - with a problem within the Minehut platform or within the server, we can - only moderate the customization of the server. - - (if the problem is within the server, [report it on - Minehut](https://support.minehut.com/hc/en-us/requests/new?tf_subject=Reporting%20Server&tf_27062997154195=reports_appeals&tf_27063229498259=report_server)) - - Hit the Report button, and add a reason to your report. Your report will be - processed and the appropriate action will be taken. - - - -## Issue inside the server - -If an issue is inside of the server, because MHSF doesn't provide the server list source (Minehut API), you must [go to Minehut and make a ticket](https://support.minehut.com/hc/en-us/requests/new?tf_subject=Reporting%20Server&tf_27062997154195=reports_appeals&tf_27063229498259=report_server). diff --git a/docs/docs/legal/rules.mdx b/docs/docs/legal/rules.mdx deleted file mode 100644 index ce16fc6..0000000 --- a/docs/docs/legal/rules.mdx +++ /dev/null @@ -1,127 +0,0 @@ ---- -title: "MHSF Platform Rules" ---- - -MHSF is a platform & wrapper for the popular server host, Minehut, designed to be a friendly and useful location to find information -about servers, whether provided by a human or from MHSF's automated systems. - -## Introduction - -We simply cannot provide a service like this without rules that regulate how content is created and shared. This rule agreement ensures that MHSF content meets our project standards and protects users from inappropriate content that may not be suitable for our primary user base: Minehut players & server owners. - -Generally, if you use MHSF as intended—sharing useful information about your server and engaging in appropriate interactions—you should have no issues. However, we've provided this resource to clearly define boundaries and expectations. - - - Code under MHSF is licensed under the [MIT - License](https://github.com/DeveloLongScript/MHSF). This document pertains to - platform usage and content, not to open-source code or how you interact on - other platforms *operated* by MHSF (for example, GitHub issues, pull requests, - Discord threads, etc.) - - -## Jurisdiction - -MHSF has a presence on various platforms. Our rules are enforced as follows: - -1. **MHSF Platform Content**: All content provided on our platform as part of our customization process is subject to these rules and **will** be moderated. - - See [Reporting](#reporting) for information on how to report violations -2. **Server Content**: Content directly on Minecraft servers should be addressed by server staff—we have **no control** over this content. -3. **Minehut-Provided Content**: Server names, MOTDs, and other content _provided by Minehut_ that appears on MHSF cannot and will not be moderated by MHSF. - - This content is governed by [Minehut's ruleset](https://support.minehut.com/hc/en-us/articles/27075816947731-Minehut-Rules) - - Please email [`support@minehut.com`](mailto:support@minehut.com) to report content that violates Minehut's rules. - -## Content & Behavior Rules - -### Prohibited Content and Behavior - -Users may not: - -1. **Personal Information** - - - Request, share, or disclose personally identifiable information that could negatively impact users - - Make threats to "dox" or "swat" other users - -2. **Harassment & Threats** - - - Engage in sexual harassment - - Threaten violence, assault, or property damage - - Harass other users in any form - - Use terminology that discriminates against others based on race, ethnicity, national origin, sexual orientation, gender identity, religion, disability, or other immutable characteristics - -3. **Harmful Content** - - - Encourage self-harm or suicide - - Encourage users to break platform rules - - Depict or encourage illegal activities (including drugs, weapon-making, gambling, DDoS attacks, and predatory behavior) - - Recreate tragic events (mass shootings, terrorism, natural disasters, human rights violations) - -4. **Platform Abuse** - - - Create multiple accounts to avoid punishment - - Upload disruptive content or perform operations that harm MHSF services - - Attempt to direct users off-platform unnecessarily - - Attack another server's content - - Spam, abuse, or misuse the MHSF API - -5. **Scams & Manipulation** - - Conduct scams or manipulate users into sharing personal information or valuable items - - Sell or transfer MHSF accounts, server claims, or other platform privileges - -## Enforcement & Punishment - -### Standard Enforcement Process - -For most violations, MHSF follows this process: - -1. **First Violation**: Warning and content removal -2. **Repeated Violation**: Permanent removal from the MHSF platform - -### Types of Enforcement Actions - -Depending on the severity of the violation, actions may include: - -- Content removal -- Temporary suspension -- Account ban -- IP ban - - - MHSF staff may use any enforcement action necessary to effectively address - threats to the platform. Certain serious violations will result in immediate - permanent bans without warning. - - -## Appeals Process - -If you believe your punishment was unjustified, you may appeal by contacting [support@mhsf.app](mailto:support@mhsf.app). - - - You may only file **one appeal per punishment**. You can only have one active - appeal at a time. - - -## Reporting violations - -If you believe another user has violated these rules, you can submit a report after logging in by following our [reporting guide](/docs/guides/reporting-server). - -## Additional Information - -### Age Requirement - -Users must be at least 13 years old to use, interact with, or sign up for MHSF and its services. Users found to be under 13 will be banned in compliance with data protection laws and Minehut regulations. - -### API Usage - -When using the MHSF API: - -- Include a proper `User-Agent` HTTP header with your project name and link -- Do not spam or abuse the API -- Do not use the API to violate Minehut, Discord, Minecraft, or legal regulations - -### Rule Changes - -These rules may be modified without prior notice. MHSF staff may take action against content or behavior that undermines the platform's interests, even if not explicitly covered in this document. - -For questions, contact us at [support@mhsf.app](mailto:support@mhsf.app) - -Last modified: Mar. 1, 2025 diff --git a/docs/package.json b/docs/package.json deleted file mode 100644 index 3d44316..0000000 --- a/docs/package.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "name": "docs", - "version": "1.0.0", - "main": "index.js", - "license": "MIT", - "scripts": { - "dev": "mintlify dev" - }, - "devDependencies": { - "mintlify": "^4.0.417" - } -}