diff --git a/README.md b/README.md index 950babdfef..3f1fdd4cb3 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,17 @@ -# ๐Ÿ“ setup.md +
+ + + + + Minecraft Bookshelf + + +--- Welcome to the Minecraft server administration knowledgebase designed to provide accurate and meaningful data in one place. +
+ ## ๐Ÿ‘จโ€๐Ÿ’ป Contributing - Contributions make the open source community such an amazing place to learn, inspire, and create. @@ -9,19 +19,18 @@ Welcome to the Minecraft server administration knowledgebase designed to provide ## ๐Ÿ’ป Development -1. Fork the project: Click the gray `Fork` button in the top right of this page. This creates _your_ copy of the project and saves it as a new repository in your github account -2. Click on the green `Code` button, then either the HTTPS or SSH option and, click the icon to copy the URL. Now you have a copy of the project. Thus, you can play around with it locally on your computer. -3. Run the following commands into a terminal window (Command Prompt, Powershell, Terminal, Git Bash, ZSH): +1. Fork the project: Click the gray `Fork` button in the top right of this page. This creates _your_ own copy of the project and saves it as a new repository in your GitHub account. +2. Run the following commands into a terminal window (Command Prompt, Powershell, Terminal, Git Bash, ZSH): Do this to download the forked copy of this repository to your computer: ```bash -$ git clone https://github.com/setupmd/docs.git +git clone https://github.com/YOUR_GITHUB_USERNAME/docs.git ``` - Step into the directory: +Step into the directory: ```bash -$ cd docs +cd docs ``` All commands are run from the root of the project, from a terminal: diff --git a/astro.config.mjs b/astro.config.mjs index f3d071e476..324679c390 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -1,13 +1,11 @@ // astro.config.mjs import { defineConfig } from "astro/config"; import starlight from "@astrojs/starlight"; -import vue from "@astrojs/vue"; import tailwindcss from "@tailwindcss/vite"; import sitemap from "@astrojs/sitemap"; import path from "node:path"; -import starlightThemeObsidian from 'starlight-theme-obsidian'; -import starlightSidebarTopics from 'starlight-sidebar-topics'; -import starlightHeadingBadges from 'starlight-heading-badges' +import starlightThemeObsidian from "starlight-theme-obsidian"; +import starlightSidebarTopics from "starlight-sidebar-topics"; export default defineConfig({ site: "https://www.setup.md", @@ -27,11 +25,11 @@ export default defineConfig({ } } }, - + build: { format: "file", }, - + integrations: [ starlight({ plugins: [ @@ -39,102 +37,280 @@ export default defineConfig({ backlinks: false, graph: false }), - starlightHeadingBadges({}), starlightSidebarTopics([ { - label: 'Home', - icon: 'starlight', - link: '/', - }, - { - label: 'Project', - link: 'contribute', - icon: 'heart', - items: [ - { label: 'Project Information', autogenerate: { directory: 'project' } }, - ], - }, - { - label: 'Deploy', - link: 'deploy/considerations', - icon: 'open-book', - items: [ - { label: 'Considerations', autogenerate: { directory: 'deploy/considerations' } }, - { label: 'Self Hosted', autogenerate: { directory: 'deploy/create' } }, - { label: 'Shared Hosting', autogenerate: { directory: 'deploy/hosted' } }, - ], - }, - { - label: 'Customise', - link: 'customisation', - icon: 'puzzle', + id: "getting-started", + label: "Getting Started", + link: "getting-started", + icon: "heart", items: [ { - label: 'Breakdown', - items: ['customisation'], + label: "Project Information", + items: [ + "getting-started/contribute", + "getting-started/discord", + { + slug: "getting-started/jar-api", + badge: { text: "FREE", variant: "success" }, + }, + "getting-started/license", + { + label: "Our Lab", + collapsed: true, + items: [{ + label: "Core", + collapsed: true, + autogenerate: { directory: "getting-started/our-lab/core" } + }, + { + label: "Optional", + collapsed: true, + autogenerate: { directory: "getting-started/our-lab/optional" } + }], + }, + ], }, - { label: 'Plugins', autogenerate: { directory: 'customise/plugins' }, collapsed: true}, - { label: 'Mods', autogenerate: { directory: 'customise/mods' }, collapsed: true }, ], }, { - label: 'Administration', - link: 'administer/sftp', - icon: 'setting', + id: "deploy", + label: "Deploy", + link: "deploy", + icon: "open-book", items: [ - { label: 'Administration Basics', autogenerate: { directory: 'administer' }, collapsed: true }, + { + label: "Considerations", + items: [ + "deploy/considerations", + "deploy/considerations/hosting-types", + "deploy/considerations/operating-systems", + "deploy/considerations/panels", + "deploy/considerations/server-software", + ], + }, + { + label: "Self Hosted", + items: [ + "deploy/create/install-java", + "deploy/create/download-jars", + "deploy/create/startup-scripts", + ], + }, + { + label: "Shared Hosting", + items: [ + "deploy/hosted", + "deploy/hosted/providers", + "deploy/hosted/hardware", + "deploy/hosted/purchased-what-next", + "deploy/hosted/oracle", + ], + }, + { + label: "Game Panels", + collapsed: true, + items: [ + { + label: "Pterodactyl", + autogenerate: { directory: "deploy/game-panels/pterodactyl" } + }, + { + label: "PufferPanel", + autogenerate: { directory: "deploy/game-panels/pufferpanel" } + } + ], + }, ], }, { - label: 'Optimisation', - link: 'optimise/basics/temp', - icon: 'rocket', + id: "customise", + label: "Customise", + link: "customise", + icon: "puzzle", items: [ - { label: 'Basics', autogenerate: { directory: 'optimise/basics' } }, - { label: 'Advanced', autogenerate: { directory: 'optimise/advanced' } }, + { + label: "Plugins", + items: [ + "customise/plugins", + { + label: "Core", + collapsed: true, + items: [ + "customise/plugins/core/essentialsx", + "customise/plugins/core/luckperms", + "customise/plugins/core/worldedit", + "customise/plugins/core/worldguard", + "customise/plugins/core/vault", + ] + }, + { + label: "Economy", + collapsed: true, + items: [ + "customise/plugins/economy/chestshop", + "customise/plugins/economy/playerauctions", + "customise/plugins/economy/quickshop", + { + label: "zAuctionHouse", + slug: "customise/plugins/economy/zauctionhouse", + badge: { + text: "PREMIUM", + variant: "note", + }, + }, + ] + }, + { + label: "Administration", + collapsed: true, + items: [ + { + label: "LiteBans", + slug: "customise/plugins/administration/security/litebans", + badge: { + text: "PREMIUM", + variant: "note", + }, + }, + ] + }, + { + label: "Gameplay", + collapsed: true, + items: [ + "customise/plugins/gameplay/terra", + ] + }, + { + label: "Integration", + collapsed: true, + items: [ + "customise/plugins/integration/discordsrv", + "customise/plugins/integration/dynmap", + ] + }, + ], + }, + { + label: "Mods", + items: [ + "customise/mods", + ], + }, ], }, { - label: 'Troubleshoot', - link: 'fix/connectivity', - icon: 'error', + id: "administration", + label: "Administration", + link: "administration", + icon: "setting", items: [ - { label: 'Technical Issues', autogenerate: { directory: 'troubleshoot/compute' } }, - { label: 'Network Issues', autogenerate: { directory: 'troubleshoot/network' } }, + { + label: "Server Administration", + items: [ + "administration/databases", + "administration/offline-mode", + "administration/sftp", + "administration/textures", + "administration/advertising", + { + label: "Permissions", + items: [ + "administration/permissions", + "administration/permissions/plugins" + ], + badge: { + text: "IMPORTANT", + variant: "danger" + }, + }, + { + label: "Security", + items: [ + "administration/security", + "administration/security/anticheat", + "administration/security/antixray", + "administration/security/antiexploit", + "administration/security/antilag", + "administration/security/signed-chat", + "administration/security/tls", + ], + }, + { + label: "Economy", + items: [ + "administration/economy", + "administration/economy/gui", + "administration/economy/chest", + "administration/economy/shop", + ], + }, + { + label: "Performance", + items: [ + "administration/performance", + "administration/performance/basic", + "administration/performance/advanced", + ], + }, + ], + }, ], }, { - label: 'Extras', - link: 'extra/tls', - icon: 'star', + id: "troubleshooting", + label: "Troubleshooting", + link: "troubleshooting", + icon: "error", items: [ - { label: 'Additional Content', autogenerate: { directory: 'extras' }, collapsed: true }, + { + label: "Technical Issues", + items: [ + "troubleshooting/compute/java" + ], + }, + { + label: "Network Issues", + items: [ + "troubleshooting/network/connectivity", + "troubleshooting/network/latency", + "troubleshooting/network/nat", + "troubleshooting/network/tunnels", + ], + }, ], }, ]) ], components: { - Sidebar: './src/components/Sidebar.astro', + Sidebar: "./src/components/Sidebar.astro", }, title: "setup.md", customCss: [ - './src/styles/custom.css', - './src/fonts/font-face.css', + "./src/styles/custom.css", + "./src/fonts/font-face.css", ], logo: { replacesTitle: true, - light: "./src/assets/logo_dark-2.svg", - dark: "./src/assets/logo_light-2.svg", + light: "./src/assets/logos/logo-dark.svg", + dark: "./src/assets/logos/logo-light.svg", }, editLink: { - baseUrl: "https://github.com/setupmd/docs/edit/v3", + baseUrl: "https://github.com/setupmd/docs/tree/restructure", }, social: [ - { icon: 'github', label: 'GitHub', href: 'https://github.com/setupmd' }, - { icon: 'discord', label: 'Discord', href: 'http://www.setup.md/discord-invite' }, + { + icon: "github", + label: "GitHub", + href: "https://github.com/setupmd" + }, + { + icon: "discord", + label: "Discord", + href: "http://www.setup.md/discord-invite" + }, ], }), - vue(), sitemap(), ], }); \ No newline at end of file diff --git a/package.json b/package.json index def3c58804..2a94f0bed1 100644 --- a/package.json +++ b/package.json @@ -14,17 +14,13 @@ "@astrojs/check": "^0.9.4", "@astrojs/sitemap": "^3.6.0", "@astrojs/starlight": "^0.36.1", - "@astrojs/vue": "^5.1.1", "@tailwindcss/vite": "^4.1.14", - "@vitejs/plugin-vue": "^6.0.1", "astro": "^5.14.5", "sharp": "^0.34.4", - "starlight-heading-badges": "^0.6.1", "starlight-sidebar-topics": "0.6.2", "starlight-sidebar-topics-dropdown": "^0.5.1", "starlight-theme-obsidian": "^0.4.1", "tailwindcss": "^4.1.14", - "typescript": "^5.4.5", - "vue": "^3.5.22" + "typescript": "^5.4.5" } } diff --git a/src/assets/images/fix-server-lag-noob.png b/src/assets/images/fix-server-lag-noob.png new file mode 100644 index 0000000000..092e6a05f2 Binary files /dev/null and b/src/assets/images/fix-server-lag-noob.png differ diff --git a/src/assets/bookshelf.png b/src/assets/logos/bookshelf.png similarity index 100% rename from src/assets/bookshelf.png rename to src/assets/logos/bookshelf.png diff --git a/src/assets/logo_dark-2.svg b/src/assets/logos/logo-dark.svg similarity index 100% rename from src/assets/logo_dark-2.svg rename to src/assets/logos/logo-dark.svg diff --git a/src/assets/logo_light-2.svg b/src/assets/logos/logo-light.svg similarity index 100% rename from src/assets/logo_light-2.svg rename to src/assets/logos/logo-light.svg diff --git a/src/components/sidebar.astro b/src/components/sidebar.astro deleted file mode 100644 index 781719678e..0000000000 --- a/src/components/sidebar.astro +++ /dev/null @@ -1,24 +0,0 @@ ---- -import Default from '@astrojs/starlight/components/Sidebar.astro'; -import Search from '@astrojs/starlight/components/Search.astro'; -import SiteTitle from '@astrojs/starlight/components/SiteTitle.astro'; -import MobileMenuFooter from '@astrojs/starlight/components/MobileMenuFooter.astro'; -import config from 'virtual:starlight/user-config'; -import { TopicsDropdown } from 'starlight-sidebar-topics-dropdown'; - -const shouldRenderSearch = config.pagefind || config.components.Search !== '@astrojs/starlight/components/Search.astro'; ---- - -{/* (STARLIGHT-THEME-OBSIDIAN): Reorder site sidebar to always contain site title */} -
-
- -
- - - {shouldRenderSearch && } - - -
- - \ No newline at end of file diff --git a/src/content.config.ts b/src/content.config.ts new file mode 100644 index 0000000000..95a4ffc8d4 --- /dev/null +++ b/src/content.config.ts @@ -0,0 +1,12 @@ +import { defineCollection } from 'astro:content'; +import { docsSchema } from '@astrojs/starlight/schema'; +import { pageThemeObsidianSchema } from 'starlight-theme-obsidian/schema'; +import { topicSchema } from 'starlight-sidebar-topics/schema'; + +const docs = defineCollection({ + schema: docsSchema({ + extend: pageThemeObsidianSchema.merge(topicSchema), + }), +}); + +export const collections = { docs }; \ No newline at end of file diff --git a/src/content/config.ts b/src/content/config.ts deleted file mode 100644 index cc728f8399..0000000000 --- a/src/content/config.ts +++ /dev/null @@ -1,12 +0,0 @@ -import { defineCollection } from 'astro:content'; -import { docsSchema, i18nSchema } from '@astrojs/starlight/schema'; -import { pageThemeObsidianSchema } from 'starlight-theme-obsidian/schema'; - - -export const collections = { - docs: defineCollection({ - schema: docsSchema({ - extend: pageThemeObsidianSchema - }) - }) -}; \ No newline at end of file diff --git a/src/content/docs/extras/advertising.mdx b/src/content/docs/administration/advertising.mdx similarity index 98% rename from src/content/docs/extras/advertising.mdx rename to src/content/docs/administration/advertising.mdx index 275cf0e915..063d7c414a 100644 --- a/src/content/docs/extras/advertising.mdx +++ b/src/content/docs/administration/advertising.mdx @@ -1,10 +1,11 @@ --- -description: The common advertising practices for Minecraft servers. -slug: extra/advertising title: Advertising Your Server +description: The common advertising practices for Minecraft servers. lastUpdated: 2025-10-19 --- +import { Badge } from '@astrojs/starlight/components'; + How do you advertise a Minecraft server? The answer is often gatekept, since winning strategies become saturated when more server owners find out about them. Below you will find a collection of known advertising methods, as well as information about their effectiveness. ### Social Media @@ -75,7 +76,7 @@ Creating another proxy server to use with Minehut's External Server Plan is not In order to break away from the pack, a combination of the above or other creative ways of advertising will help ensure your success. -#### DM Advertising :badge[FROWNED UPON]{variant="danger"} +#### DM Advertising This is one of the most annoying, shameful advertising practices that you can engage in. Nobody wants to be solicited, and Discord server owners especially hate when solicitors show up to poach their members. This will likely get you banned from any Discord server you try to do this in. #### SEO diff --git a/src/content/docs/administer/database.mdx b/src/content/docs/administration/databases.mdx similarity index 85% rename from src/content/docs/administer/database.mdx rename to src/content/docs/administration/databases.mdx index f87e63c619..3d91e317ed 100644 --- a/src/content/docs/administer/database.mdx +++ b/src/content/docs/administration/databases.mdx @@ -1,7 +1,7 @@ --- -description: This page covers centralised plugin data storage using databases. -slug: administer/database title: Databases +description: This page covers centralised plugin data storage using databases. +lastUpdated: 2025-10-21 --- Before you go and implement a database you should first understand what a database can help to achieve, this will ensure that you're not burning time unnecessarily deploying things you don't need. @@ -31,7 +31,7 @@ You should also be able to move your databases between all three without any maj ### When to use a database -In a Minecraft environment you're most likely going to come across databases in a 'Network' environment e.g. when you're using a tool such as ['Velocity'](/administer/server-software#velocity), or ['Bungee'](/administer/server-software#bungeecord), this will allow you to share information between your backend servers and have one consistent dataset e.g. economy balances, synced ranks and permissions etc just to name a few examples. +In a Minecraft environment you're most likely going to come across databases in a 'Network' environment e.g. when you're using a tool such as ['Velocity'](/administration/server-software#velocity), or ['Bungee'](/administration/server-software#bungeecord), this will allow you to share information between your backend servers and have one consistent dataset e.g. economy balances, synced ranks and permissions etc just to name a few examples. If you're running a server with a hosting provider they too will most likely give you the ability to create databases for your plugin data, if you're limited on local disk space using SQL for plugin data may off-lift some local capacity constraints. diff --git a/src/content/docs/administer/Economy/chest.mdx b/src/content/docs/administration/economy/chest.mdx similarity index 90% rename from src/content/docs/administer/Economy/chest.mdx rename to src/content/docs/administration/economy/chest.mdx index 46c966c696..753eb80c02 100644 --- a/src/content/docs/administer/Economy/chest.mdx +++ b/src/content/docs/administration/economy/chest.mdx @@ -1,7 +1,7 @@ --- -description: A focus on traditional chest based plugins for your servers economy. -slug: administer/eco-chest -title: Chest Based +title: Chest Based Economy +description: A focus on traditional chest based plugins for your server's economy. +lastUpdated: 2025-10-21 --- A chest shop is a Minecraft resource buying - selling enhancement that is fully craftable in game using normally a standard chest and a wooden sign. These solutions normally bring a more player-to-player style interraction with players chosing to rent space in an admin market / build their own market. diff --git a/src/content/docs/administer/Economy/gui.mdx b/src/content/docs/administration/economy/gui.mdx similarity index 79% rename from src/content/docs/administer/Economy/gui.mdx rename to src/content/docs/administration/economy/gui.mdx index 77c3bf38c9..699110245e 100644 --- a/src/content/docs/administer/Economy/gui.mdx +++ b/src/content/docs/administration/economy/gui.mdx @@ -1,8 +1,7 @@ --- -description: A focus on GUI based plugins for your servers economy. -slug: administer/eco-gui -title: GUI Based -lastUpdated: 2024-01-01 +title: GUI Based Economy +description: A focus on GUI based plugins for your server's economy. +lastUpdated: 2025-10-21 --- A GUI based shop plugin allows users to buy and sell using an interface, normally that of chests and can sometimes be more accessible for your players. diff --git a/src/content/docs/administer/Economy/intro.mdx b/src/content/docs/administration/economy/index.mdx similarity index 76% rename from src/content/docs/administer/Economy/intro.mdx rename to src/content/docs/administration/economy/index.mdx index f070c4b4fe..4cbedbd43a 100644 --- a/src/content/docs/administer/Economy/intro.mdx +++ b/src/content/docs/administration/economy/index.mdx @@ -1,9 +1,7 @@ --- +title: Overview description: Recommended plugins to kick start your Minecraft server's economy. -slug: administer/eco -title: What is an economy? -sidebar: - order: 1 +lastUpdated: 2025-10-21 --- An economy is essential to your Minecraft server, it allows for players to buy and sell between one another or between your players and the server for in-game ranks / items etc. @@ -12,16 +10,14 @@ Economies within Minecraft, much like the real world, can dictate supply and dem The goal with this section is to highlight some viable options for your server along with some example plugins that will allow you to build the framework for your own server's economy to take place. - - ### Requirements Most, if not all plugins require your server to have an Economy API (such as [Vault](/plugin/vault)) and an Economy Handler installed. Some example economy handlers are below: \ No newline at end of file diff --git a/src/content/docs/administer/Economy/shop.mdx b/src/content/docs/administration/economy/shop.mdx similarity index 94% rename from src/content/docs/administer/Economy/shop.mdx rename to src/content/docs/administration/economy/shop.mdx index eb5ed4a1ab..a3eeb1ef50 100644 --- a/src/content/docs/administer/Economy/shop.mdx +++ b/src/content/docs/administration/economy/shop.mdx @@ -1,7 +1,7 @@ --- -description: A focus on /shop based plugins for your servers economy. -slug: administer/eco-shop -title: Command Based +title: Command Based Economy +description: A focus on /shop based plugins for your server's economy. +lastUpdated: 2025-10-21 --- import { LinkCard, CardGrid } from '@astrojs/starlight/components'; diff --git a/src/content/docs/administration/index.mdx b/src/content/docs/administration/index.mdx new file mode 100644 index 0000000000..af58f96bf2 --- /dev/null +++ b/src/content/docs/administration/index.mdx @@ -0,0 +1,8 @@ +--- +title: Administration +description: Learn how to effectively manage and maintain your Minecraft server on a day-to-day basis. +lastUpdated: 2025-10-21 +topic: administration +--- + +Master the essential tasks of Minecraft server administration, from user management to backups and maintenance routines. \ No newline at end of file diff --git a/src/content/docs/administer/offline-mode.mdx b/src/content/docs/administration/offline-mode.mdx similarity index 98% rename from src/content/docs/administer/offline-mode.mdx rename to src/content/docs/administration/offline-mode.mdx index ba4f764b15..7dd2dccd49 100644 --- a/src/content/docs/administer/offline-mode.mdx +++ b/src/content/docs/administration/offline-mode.mdx @@ -1,7 +1,7 @@ --- -slug: administer/offline-mode -description: What is offline mode and what are the implications? title: Offline Mode +description: What is offline mode and what are the implications? +lastUpdated: 2025-10-21 --- Offline mode is a legacy feature of Minecraft servers that disables the requirement for Mojang user authentication, allowing cracked Minecraft clients such as TLauncher et al. to join. diff --git a/src/content/docs/optimise/advanced.mdx b/src/content/docs/administration/performance/advanced.mdx similarity index 98% rename from src/content/docs/optimise/advanced.mdx rename to src/content/docs/administration/performance/advanced.mdx index f3ad7c2199..3b0843a7e9 100644 --- a/src/content/docs/optimise/advanced.mdx +++ b/src/content/docs/administration/performance/advanced.mdx @@ -1,9 +1,7 @@ --- -slug: optimise/advanced title: Advanced Checklist -description: A more focused approach on squeezing out every last drop of performance at scale. -sidebar: - order: 3 +description: A more focused approach on squeezing out every last drop of performance at scale. +lastUpdated: 2025-10-21 --- import { LinkCard, CardGrid } from '@astrojs/starlight/components'; diff --git a/src/content/docs/optimise/basic.mdx b/src/content/docs/administration/performance/basic.mdx similarity index 90% rename from src/content/docs/optimise/basic.mdx rename to src/content/docs/administration/performance/basic.mdx index 5b71b31034..43b5b88e68 100644 --- a/src/content/docs/optimise/basic.mdx +++ b/src/content/docs/administration/performance/basic.mdx @@ -1,9 +1,7 @@ --- -slug: optimse/basic title: Basic Checklist -description: Your starting point for improving your Minecraft servers performance. -sidebar: - order: 2 +description: Your starting point for improving your Minecraft servers performance. +lastUpdated: 2025-10-21 --- import { LinkCard, CardGrid } from '@astrojs/starlight/components'; diff --git a/src/content/docs/optimise/intro.mdx b/src/content/docs/administration/performance/index.mdx similarity index 91% rename from src/content/docs/optimise/intro.mdx rename to src/content/docs/administration/performance/index.mdx index 32648a20fa..de1104ddd4 100644 --- a/src/content/docs/optimise/intro.mdx +++ b/src/content/docs/administration/performance/index.mdx @@ -1,10 +1,7 @@ --- -description: This section of setup.md goes in-depth for server optimisation -slug: optimise -title: Introduction -lastUpdated: 2025-07-22 -sidebar: - order: 1 +title: Overview +description: Optimize your Minecraft server for better speed, stability, and player experience. +lastUpdated: 2025-10-21 --- A section for optimising Minecraft servers. Optimising your server means to improve the performance of the server by implementing tweaks without heavily modifying desired mechanics. Advanced optimisation is only recommended for large servers suffering from poor performance. @@ -13,9 +10,7 @@ A section for optimising Minecraft servers. Optimising your server means to impr Use the Spark Profiler for monitoring server performance e.g. vanilla mechanics, plugins, GC pauses and cycles, memory usage etc. Spark is also able to profile all threads generated by your server using the `--thread *` flag. You may use this to diagnose high CPU usage, for example. -
Spark Website -
### Server JAR JAR | Summary diff --git a/src/content/docs/administer/Permissions/breakdown.mdx b/src/content/docs/administration/permissions/index.mdx similarity index 87% rename from src/content/docs/administer/Permissions/breakdown.mdx rename to src/content/docs/administration/permissions/index.mdx index aeec4dfff4..5036a4fb97 100644 --- a/src/content/docs/administer/Permissions/breakdown.mdx +++ b/src/content/docs/administration/permissions/index.mdx @@ -1,13 +1,7 @@ --- -sidebar_position: 1 -slug: administer/permissions -title: How They Work -lastUpdated: 2024-01-01 -sidebar: - order: 4 - badge: - text: Important - variant: danger +title: Overview +description: Understanding how Minecraft server permissions work and how to use them effectively. +lastUpdated: 2025-10-21 --- When you're setting up a new server, a very important part of the process is managing permissions and **configuring them as you go**. diff --git a/src/content/docs/administer/Permissions/plugins.mdx b/src/content/docs/administration/permissions/plugins.mdx similarity index 72% rename from src/content/docs/administer/Permissions/plugins.mdx rename to src/content/docs/administration/permissions/plugins.mdx index f6c5f0b856..cfd8c0ee5b 100644 --- a/src/content/docs/administer/Permissions/plugins.mdx +++ b/src/content/docs/administration/permissions/plugins.mdx @@ -1,8 +1,7 @@ --- -description: A focus on permission manager plugins for your server. -slug: administer/permission-plugins -title: Plugins -lastUpdated: 2024-01-01 +title: Permission Plugins +description: A guide to permission manager plugins for your Minecraft server. +lastUpdated: 2025-10-21 --- Permission manager plugins allow you to define groups (ranks), and permission levels for all of your players on your server. diff --git a/src/content/docs/administer/Anti-X Tools/anticheat.mdx b/src/content/docs/administration/security/anticheat.mdx similarity index 86% rename from src/content/docs/administer/Anti-X Tools/anticheat.mdx rename to src/content/docs/administration/security/anticheat.mdx index 39416fc51a..2ef581c899 100644 --- a/src/content/docs/administer/Anti-X Tools/anticheat.mdx +++ b/src/content/docs/administration/security/anticheat.mdx @@ -1,11 +1,10 @@ --- -description: A brief introduction to Anti-Cheats and the community recommended solutions. -slug: administer/anti-cheat -title: Anti-Cheats -lastUpdated: 2024-02-25 +title: Anti-Cheat Solutions +description: A guide to anti-cheat solutions and recommended plugins for your Minecraft server. +lastUpdated: 2025-10-21 --- -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; +import { Badge, LinkCard, CardGrid } from '@astrojs/starlight/components'; :::info Throughout this guide 'Anti-Cheat(s)' may be referred to as 'AC' or 'ACs' @@ -34,7 +33,7 @@ Within the `spigot.yml` file you should also set the following values. ... ``` -For the recommended anti-xray settings [click here](/administer/anti-xray). +For the recommended anti-xray settings [click here](/administration/anti-xray). :::warning We highly discourage the usage of auto-bans as no anti-cheat is perfect. If you want to auto-ban, consider having something like AntiCheatReplay so that you can undo false bans. @@ -45,7 +44,7 @@ We highly discourage the usage of auto-bans as no anti-cheat is perfect. If you This list consists common ACs and some pros and cons of each AC. -#### Grim :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +#### Grim ##### Pros @@ -68,7 +67,7 @@ This list consists common ACs and some pros and cons of each AC. href="https://github.com/GrimAnticheat/Grim" /> -#### NoCheatPlus :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +#### NoCheatPlus ##### Pros @@ -90,7 +89,7 @@ This list consists common ACs and some pros and cons of each AC. href="https://github.com/Updated-NoCheatPlus/NoCheatPlus" /> -#### Vulcan :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +#### Vulcan ##### Pros @@ -112,7 +111,7 @@ This list consists common ACs and some pros and cons of each AC. href="https://www.spigotmc.org/resources/83626/" /> -#### Spartan :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +#### Spartan ##### Pros @@ -137,7 +136,7 @@ This list consists common ACs and some pros and cons of each AC. href="https://www.spigotmc.org/resources/25638/" /> -#### Matrix :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +#### Matrix ##### Pros
    @@ -158,7 +157,7 @@ This list consists common ACs and some pros and cons of each AC. href="https://matrix.rip" /> -#### Themis :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +#### Themis ##### Pros
      diff --git a/src/content/docs/administer/Anti-X Tools/antiexploit.mdx b/src/content/docs/administration/security/antiexploit.mdx similarity index 89% rename from src/content/docs/administer/Anti-X Tools/antiexploit.mdx rename to src/content/docs/administration/security/antiexploit.mdx index 35b14397ca..32ce820faf 100644 --- a/src/content/docs/administer/Anti-X Tools/antiexploit.mdx +++ b/src/content/docs/administration/security/antiexploit.mdx @@ -1,8 +1,7 @@ --- -description: A brief introduction to Anti-Exploits and the community recommended solutions. -slug: administer/anti-exploit -title: Anti-Exploit -lastUpdated: 2024-02-25 +title: Anti-Exploit Protection +description: A guide to anti-exploit solutions and recommended plugins for your Minecraft server. +lastUpdated: 2025-10-21 --- import { LinkCard, CardGrid } from '@astrojs/starlight/components'; diff --git a/src/content/docs/administer/Anti-X Tools/antilag.mdx b/src/content/docs/administration/security/antilag.mdx similarity index 99% rename from src/content/docs/administer/Anti-X Tools/antilag.mdx rename to src/content/docs/administration/security/antilag.mdx index a5921754ff..2abc47f6f8 100644 --- a/src/content/docs/administer/Anti-X Tools/antilag.mdx +++ b/src/content/docs/administration/security/antilag.mdx @@ -1,7 +1,6 @@ --- -description: A brief introduction to Anti-Lag and alternative performance management tools. -slug: administer/anti-lag title: Anti-Lag +description: A brief introduction to Anti-Lag and alternative performance management tools. lastUpdated: 2024-02-25 --- diff --git a/src/content/docs/administer/Anti-X Tools/antixray.mdx b/src/content/docs/administration/security/antixray.mdx similarity index 98% rename from src/content/docs/administer/Anti-X Tools/antixray.mdx rename to src/content/docs/administration/security/antixray.mdx index d729d0d826..cdf400302f 100644 --- a/src/content/docs/administer/Anti-X Tools/antixray.mdx +++ b/src/content/docs/administration/security/antixray.mdx @@ -1,7 +1,6 @@ --- -description: A brief introduction to Anti-Xray and the community recommended solutions. -slug: administer/anti-xray title: Anti-Xray +description: A brief introduction to Anti-Xray and the community recommended solutions. lastUpdated: 2024-02-25 --- diff --git a/src/content/docs/administer/Anti-X Tools/intro.mdx b/src/content/docs/administration/security/index.mdx similarity index 81% rename from src/content/docs/administer/Anti-X Tools/intro.mdx rename to src/content/docs/administration/security/index.mdx index 27ae797c22..1b93487d69 100644 --- a/src/content/docs/administer/Anti-X Tools/intro.mdx +++ b/src/content/docs/administration/security/index.mdx @@ -1,8 +1,7 @@ --- -sidebar_position: 1 -slug: administer/anti-x -description: Understand the types of 'preventative' tools that exist for Minecraft servers. -title: Introduction +title: Overview +description: Understand the types of protective and preventative security tools that exist for Minecraft servers. +lastUpdated: 2025-10-21 --- import { LinkCard, CardGrid } from '@astrojs/starlight/components'; diff --git a/src/content/docs/extras/signed-chat.mdx b/src/content/docs/administration/security/signed-chat.mdx similarity index 89% rename from src/content/docs/extras/signed-chat.mdx rename to src/content/docs/administration/security/signed-chat.mdx index 0e634da9ed..50baa3e4a3 100644 --- a/src/content/docs/extras/signed-chat.mdx +++ b/src/content/docs/administration/security/signed-chat.mdx @@ -1,11 +1,11 @@ --- -description: 1.19.1 overhauled the current reporting features and therefore caused a lot of panic, this page is written to cut through the misinformation and provide the facts. title: Signed Chat -slug: extra/signed-chat +description: 1.19.1 overhauled the current reporting features and therefore caused a lot of panic, this page is written to cut through the misinformation and provide the facts. lastUpdated: 2025-10-19 --- -import { LinkCard } from '@astrojs/starlight/components'; +import { Image } from 'astro:assets'; +import { Badge, LinkCard } from '@astrojs/starlight/components'; First things first, it's important to set the story straight. Mojang had always had a reporting toolset for anyone who wished to use it however with the introduction of 1.19.1 changes were made to this system that a reasonable portion of the community didn't like. @@ -49,7 +49,7 @@ The 'process' now works as follows: Every time a message is sent in chat the last 2 steps are repeated.
      - +Chat Signing Technical Details #### User Reports @@ -80,7 +80,7 @@ Option one is disabling 'chat-signing' within your client, this will prevent you If you're running your own server there are a few options that can be used depending if you're running vanilla, modded or a plugin based server, these are as follows. -##### Edit server.properties file :badge[GLOBAL]{variant="success"} +##### Edit server.properties file You can edit the following switch to 'false' which will disable the requirement for users to use chat-signing. @@ -92,7 +92,7 @@ enforce-secure-profile = false ... ``` -##### No Chat Reports :badge[MODDED ONLY]{variant="caution"} +##### No Chat Reports No Chat Reports is a Minecraft mod created by Aizistral that works on both the client and server sides. It strips cryptographic signatures from player chat messages, effectively converting them to system messages, thus making them non-reportable. @@ -106,7 +106,7 @@ Joining a server with `enforce-secure-profile=true` on a client with No Chat Rep href="https://modrinth.com/mod/no-chat-reports" /> -##### FreedomChat :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +##### FreedomChat FreedomChat effectively serves the same purpose as No Chat Reports would on a modded server, it converts player chat messages to system messages at the packet level, making them once again non-reportable by players. @@ -116,7 +116,7 @@ FreedomChat effectively serves the same purpose as No Chat Reports would on a mo href="https://modrinth.com/mod/freedomchat" /> -##### AntiPopup :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +##### AntiPopup While this plugin works, manual setup is required - the command `/antipopup setup` must be ran in console unless `enforce-secure-profile` is set to `false` already. @@ -126,7 +126,7 @@ While this plugin works, manual setup is required - the command `/antipopup setu href="https://www.spigotmc.org/resources/%E2%9C%A8-antipopup-no-chat-reports-and-popup-%E2%9C%A8.103782/" /> -##### UnSignedVelocity :badge[VELOCITY ONLY]{variant="caution"} +##### UnSignedVelocity This plugin works by removing signed information from commands and messages sent by clients 1.19.1 or higher, allowing plugins that cancel proxy messages to work again. Requires VPacketEvents diff --git a/src/content/docs/extras/tls.mdx b/src/content/docs/administration/security/tls.mdx similarity index 98% rename from src/content/docs/extras/tls.mdx rename to src/content/docs/administration/security/tls.mdx index 6df01c8c9b..6d1a80957c 100644 --- a/src/content/docs/extras/tls.mdx +++ b/src/content/docs/administration/security/tls.mdx @@ -1,8 +1,6 @@ --- -sidebar_position: 2 -description: Identifiy the different tools available that can be used to help you deploy SSL certificates. -slug: extra/tls title: Using SSL / TLS +description: Identifiy the different tools available that can be used to help you deploy SSL certificates. lastUpdated: 2025-10-19 --- diff --git a/src/content/docs/administer/sftp.mdx b/src/content/docs/administration/sftp.mdx similarity index 80% rename from src/content/docs/administer/sftp.mdx rename to src/content/docs/administration/sftp.mdx index f3dd7065db..1f1ac3615e 100644 --- a/src/content/docs/administer/sftp.mdx +++ b/src/content/docs/administration/sftp.mdx @@ -1,10 +1,10 @@ --- -description: Learn how to upload files to Pterodactyl panels using SFTP. -slug: administer/sftp title: Using SFTP -lastUpdated: 2024-08-10 +description: Learn how to upload files to Pterodactyl panels using SFTP. +lastUpdated: 2025-10-21 --- +import { Image } from 'astro:assets'; import { LinkCard, CardGrid } from '@astrojs/starlight/components'; If you're new to hosting a Minecraft server and you are looking to bring across a world file of your own or upload some plugins / mods to make your experience a little bit better, @@ -47,7 +47,7 @@ For simplicity we're also recommending FileZilla for Debian based distros. ### Identifying your Credentials Once you have installed FileZilla the next step is for you to get connected to your Minecraft server. You can find the information within your provider panel, most providers are now using Pterodactyl so you need to find the following block of information below*. - +SFTP Credentials *Depending on your provider your panel will look different but they will all display this set of information
      Copy the information from the `SFTP Address` and `Username` fields we will need this information within our FileZilla client. @@ -63,16 +63,16 @@ Your SFTP password will be the same password you use to login to the panel, you Once you have the information we're going to 'create a site' so we don't need to input this data everytime we want to file transfer, to do this select the site manager in the top left corner. - +FileZilla Site Manager Select 'New Site' and you can now fill in the section on the right hand side, you should change Protocol from FTP to SFTP else you will run into issues while connecting. - +FileZilla New Site Once you have copied this information over you should press 'Connect' and you will be presented with one final confirmation window, select 'Always trust this host' and then press 'Ok'. - +FileZilla Confirmation You will now be connected to your server via SFTP, you can upload/download, edit or delete files from the highlighted window below. - +FileZilla File Browser diff --git a/src/content/docs/administer/textures.mdx b/src/content/docs/administration/textures.mdx similarity index 97% rename from src/content/docs/administer/textures.mdx rename to src/content/docs/administration/textures.mdx index 82e9bb6e11..c9e4bf6b9b 100644 --- a/src/content/docs/administer/textures.mdx +++ b/src/content/docs/administration/textures.mdx @@ -1,7 +1,7 @@ --- -description: Hosting texture packs for your server. -slug: administer/textures title: Resource Pack Hosting +description: Hosting texture packs for your server. +lastUpdated: 2025-10-21 --- If you're looking to host your texture pack for your Minecraft community you can use a third party file hosting service to deliver your pack to Minecraft clients. diff --git a/src/content/docs/customise/customisation.mdx b/src/content/docs/customise/customisation.mdx deleted file mode 100644 index 5053f29f57..0000000000 --- a/src/content/docs/customise/customisation.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -description: Helping you understand the different types of customisation available for your server depending on if you're running modded or "vanilla". -title: Types of Customisation -slug: customisation -lastUpdated: 2025-10-16 ---- - -When you're running a Minecraft server, vanilla gets boring quick so you naturally look for ways to make the experience more rewarding. There are two main ways to do this, either by using plugins or mods. But what's the difference? - -### Plugins - -If you've ever played on a multiplayer server before and customisations have worked without you needing to download a modpack, chances are they were using plugins. Plugins are server-side only modifications that can add new features, commands, and gameplay mechanics to your server without requiring players to install anything on their end. They are typically used on servers running Spigot, Paper, or other similar server software. - ---- - -### Mods - -Mods, on the other hand, are client-side modifications that players need to install on their own Minecraft game in order to access the custom features. Mods can change almost anything about the game, from adding new items and blocks to completely overhauling gameplay mechanics. Servers running mods usually require a specific modpack that players must download and install before they can join. \ No newline at end of file diff --git a/src/content/docs/customise/index.mdx b/src/content/docs/customise/index.mdx new file mode 100644 index 0000000000..422d0b8ced --- /dev/null +++ b/src/content/docs/customise/index.mdx @@ -0,0 +1,8 @@ +--- +title: Customisation +description: Enhance your Minecraft server with plugins, mods, and configuration changes. +lastUpdated: 2025-10-21 +topic: customise +--- + +Explore ways to customize your Minecraft server experience through plugins, mods, and server-side modifications. \ No newline at end of file diff --git a/src/content/docs/customise/mods/index.mdx b/src/content/docs/customise/mods/index.mdx new file mode 100644 index 0000000000..aebccabf6b --- /dev/null +++ b/src/content/docs/customise/mods/index.mdx @@ -0,0 +1,15 @@ +--- +title: Listing Criteria +description: Criteria for listing popular mods for Minecraft servers. +lastUpdated: 2025-10-24 +--- + +Our goal is to highlight some must have mods for Minecraft, in order for them to make the list they have to meet the below criteria. +
        +
      • Publish to reputable marketplaces
        • +
      • Premium mods should be on Modrinth or CurseForge
        • +
      • Provide a benefit to either server owners or it's players
        • +
      • Reputable development team
        • +
      + +This is not a definitive list and may change as we add more mods \ No newline at end of file diff --git a/src/content/docs/customise/plugins/Free/Cinema Mod/commands.mdx b/src/content/docs/customise/plugins/Free/Cinema Mod/commands.mdx deleted file mode 100644 index 2d81e90506..0000000000 --- a/src/content/docs/customise/plugins/Free/Cinema Mod/commands.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -slug: plugin/cinemamod/commands -description: A list of commands for CinemaMod -title: Commands -sidebar: - order: 3 ---- - -* `/request (url)` - * Requests a video to be added to the queue -* `/forceskip` - * Force skips a video -* `/voteskip` - * Votes to skip a video -* `/lockqueue` - * Locks queue -* `/volume` - * Opens volume GUI. You can change volume, playback resolution and a few other mod options - ![Mod settings](https://i.imgur.com/QBF3OvU.png) -* `/playing` - * Shows currently playing video URL -* `/history` - * Show your video request history \ No newline at end of file diff --git a/src/content/docs/customise/plugins/Free/Cinema Mod/intro.mdx b/src/content/docs/customise/plugins/Free/Cinema Mod/intro.mdx deleted file mode 100644 index 1b15cc0195..0000000000 --- a/src/content/docs/customise/plugins/Free/Cinema Mod/intro.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -slug: plugin/cinemamod -description: Learn about the CinemaMod Minecraft plugin and how it can be used in a Minecraft server. -title: Introduction -sidebar: - order: 1 ---- - -CinemaMod is a free plugin for your Minecraft server that allows you to play YouTube videos, Twitch streams and video files (.mp4, etc...) -This guide will show you how to install it in your server and how to create theatres to watch contents - -:::warning -This plugin is still in development, and it may not be 100% stable -::: \ No newline at end of file diff --git a/src/content/docs/customise/plugins/Free/Cinema Mod/setup.mdx b/src/content/docs/customise/plugins/Free/Cinema Mod/setup.mdx deleted file mode 100644 index d485fd4649..0000000000 --- a/src/content/docs/customise/plugins/Free/Cinema Mod/setup.mdx +++ /dev/null @@ -1,132 +0,0 @@ ---- -slug: plugin/cinemanod/setup -description: A short guide on how to add the Dynamp plugin to your server and some basic configuration lines you should change. -title: Setup -sidebar: - order: 2 ---- - -## Requirements - -- [WorldEdit](https://dev.bukkit.org/projects/worldedit/files) -- [WorldGuard](https://dev.bukkit.org/projects/worldguard/files/3903109) -- [ProtocolLib (Use Build 616 for 1.19.3)](https://ci.dmulloy2.net/job/ProtocolLib/) -- [CinemaMod Bukkit (Not latest version, instructions for building it from source provided)](https://github.com/CinemaMod/CinemaMod-Bukkit/releases/tag/1.2-SNAPSHOT) - ---- - - -## Step 1: Build the CinemaMod plugin from source - -:::info -This step is optional if you don't mind using an old version, it will work with the old version provided -::: - -You'll want to have git and maven installed in your computer for this. - -1. Open the terminal and run `git clone https://github.com/CinemaMod/CinemaMod` -2. Go into the bukkit folder (`cd CinemaMod\bukkit` if you're on Windows, `cd CinemaMod/bukkit` if you're on Linux or MacOS) -3. Build the plugin with maven by running `mvn clean install` -4. You'll have a folder in the bukkit folder called target. Open it and you'll see the CinemaMod plugin jar, move it into the plugins folder - -## Step 2: Create the theatres - - You'll want to know the coords of the screens. I recommend making the screens have a ratio of 16:9 (16 blocks lenght, 9 blocks height), so most videos will work with no issues. You can also make a preview screen, and the recommended size for it is 3 \* 2. - - ![Screen](https://i.imgur.com/iac3hps.png) - -## Step 3: Setting up the WorldGuard regions - -After setting up the theatre, you'll want to grab a WorldEdit want (wooden axe), and select 2 corners that cover the entire theatre - - ![Region selection](https://i.imgur.com/pEi1eE3.jpg) - -and then create a region with the command `/rg define (region name)`, I recommend putting the area of the theatre + theatre as the region name, so for example, if it's in a cave, use `cave_theatre` -as the region name and etcetera. This will determine who can hear and see the screen (within restrictions). If you donโ€™t create a region, CinemaMod will auto-generate a temporary 200x200x64 region around the screen, as long you have that enabled in `config.yml`, which is probably a bit too big for you. - -The region isnโ€™t the only deciding factor, in the current version, if you go out of a 64 block -radius of the screen location, the video stops rendering but audio still plays. Make sure to keep -your theater under a 64 block radius from the upper left corner of the screen. - -## Step 4: Getting theater info - -We need to get some info about the theatre before we can plug it into the config file, these thing are: - -* Coordinates of the upper left corner of your screen -* Direction your screen will be facing -* Width and height of your screen -* World the screen is in (by default, this is `world`) - -### Finding coordinates of screen - -You can just use WorldEdit for this, just put a block in your top left corner, and left click it with the wand, you'll see a message with the coords of the block - - ![Top Left](https://i.imgur.com/avn51wm.png) - ![Top left corner WE](https://i.imgur.com/6IP40w1.png) - -### Getting the direction of the screen - -To figure out the direction, look at the screen, as if you were watching it, then turn around backwards, open you F3 menu and look for Facing - - ![Direction](https://i.imgur.com/8Jmm7iz.png) - -Then, you'll want to mark down the opposite direction (In this example, I have east, so I would put west), Input this in all capital letters - -### Finding Width and Height of screen - -We'll also use WorldEdit for this, since it's the easiest. Just put 3 blocks in each of the corners. - - ![Screen Corners](https://i.imgur.com/Gdqmw5I.png) - -Measure the distance between A and B, that will be your lenght, - - ![lenght](https://i.imgur.com/ydmzDLv.png) - -and measure the distance between B and C, that will be your height. - - ![height](https://i.imgur.com/CjiZoAS.png) - -### Finding world of the screen - -Unless you're running Multiverse Core 2, this should be `world`, although if you're in the nether or end, it will be `world_nether` and `world_the_end` respectively - -## Step 5: Changing the configuration - -### Setting up YouTube support: - -If you want to play YouTube videos with CinemaMod, you'll need to get an API key. You can do that by: - -1. Going into the [Google Cloud page for the API](https://console.cloud.google.com/apis/library/youtube.googleapis.com) - - ![Enable API](https://i.imgur.com/vaWX57m.png) - -1. Click on `Credentials` - - ![Credentials menu](https://i.imgur.com/7BCDOQ1.png) - -1. Click on `Create Credentials` and then `API Key` . - - ![Cloud credentials](https://i.imgur.com/BBmmAsy.png) - -After getting the API key, we need to input it in the `config.yml` of the plugin, where it says `youtube-data-api-key:`, it should be around the top. - -### Setting up the theatres: - -:::note -If you join in a theater region while a video is playing, it may not play for you. To fix this just leave the theater region and walk back in. -::: - -After getting all the info in Step 5, we can just drop the dimensions and everything about the theatre in the config file, and change the name if you want. This would be the example config following the the examples in the screenshots - - ![Theatre config](https://i.imgur.com/LIO8ZyO.png) - -And with that, you've finished! All that's left to do is restart the server, and that's it! - - ![Bad Apple](https://i.imgur.com/LlkOSW0.png) - -The supported services are YouTube videos/streams, Twitch streams, and direct links to videos -(For example, https://www.example.com/videos/test.mp4) - -:::note -If you are going to self-host videos, you must have SSL (https) certified link, and a publicly accessible server -::: diff --git a/src/content/docs/customise/plugins/Free/Dynmap/intro.mdx b/src/content/docs/customise/plugins/Free/Dynmap/intro.mdx deleted file mode 100644 index 238c5df5fc..0000000000 --- a/src/content/docs/customise/plugins/Free/Dynmap/intro.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -slug: plugin/dynmap -description: Learn about the Dynmap Minecraft plugin and how it can be used in a Minecraft server. -sidebar: - order: 1 -title: Breakdown ---- - -Dynmap is a free plugin for your Minecraft server that ships with a HTTP server that hosts a Google Maps-like view of your Minecraft world that can be viewed from your browser. -It also comes with many other features, including: -- Configurable maps per world -- Real-time updates -- Players and their chat messages are visible on the map as balloons -- Built-in webchat system linked to the Minecraft server chat -- In-game time and weather are visible on the map -- Add-ons for Towny, EssentialsX, WorldGuard among others \ No newline at end of file diff --git a/src/content/docs/customise/plugins/Free/Dynmap/proxy.mdx b/src/content/docs/customise/plugins/Free/Dynmap/proxy.mdx deleted file mode 100644 index 1fc9953a39..0000000000 --- a/src/content/docs/customise/plugins/Free/Dynmap/proxy.mdx +++ /dev/null @@ -1,98 +0,0 @@ ---- -slug: plugin/dynmap/proxy -description: Deploy a Caddy webserver and automate SSL deployment in only a few minutes. -sidebar: - order: 3 -title: Reverse Proxy ---- - -This tutorial covers how to proxy your Dynmap server behind Nginx with a free SSL certificate from Let's Encrypt installed - -### Requirements - -* A Minecraft server with Dynmap configured -* A VPS with atleast Ubuntu 22.04 deployed -* A [ZeroSSL account](https://zerossl.com/?fpr=setupmd) (Optional) -* Root access to the aforementioned VPS - -If you haven't got access to the above, you should consult your service providers. - ---- - -### Caddy Deployment - -#### Installation - -First off, we need to install Caddy and add allow rules for both HTTP and HTTPS traffic to the UFW firewall. - -``` -... - -sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https -curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/gpg.key' | sudo gpg --dearmor -o /usr/share/keyrings/caddy-stable-archive-keyring.gpg -curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-stable.list -sudo apt update && sudo apt install caddy -sudo ufw allow http -sudo ufw allow https - -... -``` - -#### Generate ZeroSSL API Keys (Optional) - -This step is optiona if you don't want to use ZeroSSL as you're provider. If you chose not to use ZeroSSL your certs will be deployed via LetsEncrypt however support for Google Trust Services can also be configured. - -You can go to the [ZeroSSL developer console](https://app.zerossl.com/developer) and select 'Generate' under 'EAB Credentials'. - - -#### Caddyfile Config - -Below is an example configuration file. Edit it and save it as `/etc/caddy/Caddyfile` - -```yaml -... - -# Define ACME credentials (Optional but required for ZeroSSL) -{ - acme_ca https://acme.zerossl.com/v2/DV90 - acme_eab { - key_id - mac_key - } -} - -# Required for all deployments -map.mydomain.com { - reverse_proxy http://: -} - -... -``` - -To enable the site run the following command - -```bash -... - -caddy reload - -... -``` - -If you get an error with formatting you should run the following command and then re-run the reload command. - -```bash -... - -sudo caddy fmt --overwrite - -... -``` - ---- - -### Testing Configuration - -If you're using ZeroSSL you should check you see a provisioned SSL certificate under you account dashboard, when you select 'Certificates' > 'Issued' it will be marked as a 'Certificate' and not '90-Day SSL'. - -All users should be able to use https://map.mydomain.com, if you're not using the ACME setup within \ No newline at end of file diff --git a/src/content/docs/customise/plugins/Free/Dynmap/setup.mdx b/src/content/docs/customise/plugins/Free/Dynmap/setup.mdx deleted file mode 100644 index 1ac9f63ec2..0000000000 --- a/src/content/docs/customise/plugins/Free/Dynmap/setup.mdx +++ /dev/null @@ -1,42 +0,0 @@ ---- -slug: plugin/dynmap/setup -description: A short guide on how to add the Dynamp plugin to your server and some basic configuration lines you should change. -sidebar: - order: 2 -title: Setup ---- - -This page details the setup process for the Dynmap plugin, assuming the Paper Minecraft server is being used and Dynmap's internal web server is being used. - -### You Will Need - -* A Minecraft server with Spigot or any of its forks -* A secondary port allocation for the web server to listen on if you are using a shared host - ---- - -### Installation - -First things first, we need to install the Dynmap plugin on our server. Download it from [here](https://www.spigotmc.org/resources/dynmap%C2%AE.274/) and upload it to `/plugins` on your server, whether through (S)FTP or the web. Restart your server and go to `/plugins/dynmap`. - -#### Configuring Dynmap - -Once you're in the Dynmap plugin directory, we'll need to tweak the `configuration.txt` file a bit. Open it with your favourite text editor or web editor. - -* To adjust the resolution of tiles, find the line that says `deftemplatesuffix` - this'll be the first thing you see when you open up the file - change it to one of [`vlowres`, `lowres`, `medres`, `hires`] -:::warning -Fully-generated high resolution maps will take up to hundreds of gigabytes of disk space -::: -* To use an SQL database for map storage rather than flat files, comment `type: filetree` and uncomment `#type: sqlite` or `#type: mysql` along with the filename for SQLite or MySQL credentials depending on which you are using. -Alternatively, you can use Amazon S3 for storing maps, uncomment the lines below `# AWS S3 bucket web site` and change the region and access credentials to match yours -* To customise the title of the webpage, uncomment the line containing `webpage-title` and change the value as you wish. -* To save on disk space for while preserving most quality of tile images, find the line that begins with `image-format` and set it to `jpg-q90`. Alternatively, you can use the more efficient WEBP format - make sure to also uncomment the `cwebpPath` and `dwebpPath` lines as well as installing the appropriate packages -* To enable the outbound web server, find the line that says `webserver-bindaddress` and uncomment it. Change the `webserver-port` to whatever port you plan to use - if you're on a host with a shared IP, this'll be something way different from the default `8123`. This is practically a must for this guide as it's the whole point - unless you want to use an external web server, which isn't covered here. -* To enable login support, change `login-enabled` to true - change `login-required` to true to require login for access -* To require login for the webchat, go back up and find the line that says `webchat-requires-login` - uncomment and change to true. -:::note -If you plan to use the login system, SSL is a must to encrypt traffic between users and the web server - unencrypted logins are prone to attacks from hackers. The next page contains a tutorial on how to do this -::: - -Restart your Minecraft server to apply the changes. When done, type `http://:` into your web browser - if a webpage shows up, then ta-da! Dynmap's internal web server is working fine and dandy! -The next page will detail how to set up an Caddy proxy and enable HTTPS for your map. \ No newline at end of file diff --git a/src/content/docs/customise/plugins/Free/Luckperms/luckperms.mdx b/src/content/docs/customise/plugins/Free/Luckperms/luckperms.mdx deleted file mode 100644 index df52444db7..0000000000 --- a/src/content/docs/customise/plugins/Free/Luckperms/luckperms.mdx +++ /dev/null @@ -1,21 +0,0 @@ ---- -description: Learn about the Luckperms plugin and how to get a basic configuration up and running. -slug: plugin/luckperms -title: Luckperms -lastUpdated: 2024-01-01 -sidebar: - badge: - text: Essential - variant: success ---- - -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; - -#### This enhancement supports :badge[BUNGEE, WATERFALL & VELOCITY]{variant="success"} :badge[ALL MAJOR JAVA & BEDROCK PLATFORMS]{variant="success"} - -LuckPerms is probably the most feature-rich permissions plugin in existence currently. It supports many different kinds of servers, like Bukkit/Spigot or Sponge, but also all the major proxies like Velocity and Bungeecord. - - - - - \ No newline at end of file diff --git a/src/content/docs/customise/plugins/Free/auctionhouse.mdx b/src/content/docs/customise/plugins/Free/auctionhouse.mdx deleted file mode 100644 index 8a2cd5eb2e..0000000000 --- a/src/content/docs/customise/plugins/Free/auctionhouse.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -description: A GUI based player shop plugin to enhance your economy. -slug: plugin/auctionhouse -title: AuctionHouse -lastUpdated: 2024-01-01 ---- - -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; - -#### This enhancement supports :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} - -A decent /ah plugin. Unfortunately, it does have it's fair share of issues. For example, it is one of the most laggiest plugins in every server and also has caused dupes here and there (rare but still possible). - -There are better options out there with far more customizability. - - \ No newline at end of file diff --git a/src/content/docs/customise/plugins/Free/dukesmart.mdx b/src/content/docs/customise/plugins/Free/dukesmart.mdx deleted file mode 100644 index d5a046d799..0000000000 --- a/src/content/docs/customise/plugins/Free/dukesmart.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -description: A chest based player shop plugin to enhance your economy. -slug: plugin/dukesmart -title: DukesMart -lastUpdated: 2024-01-01 ---- - -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; - -#### This enhancement supports :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} - -A plugin to watch as the light weight chest shop plugin was rumoured to be getting one final breath of life with a fork. - - \ No newline at end of file diff --git a/src/content/docs/customise/plugins/Free/playershops.mdx b/src/content/docs/customise/plugins/Free/playershops.mdx deleted file mode 100644 index 4e56fccb9e..0000000000 --- a/src/content/docs/customise/plugins/Free/playershops.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -description: A GUI based player shop plugin to enhance your economy. -slug: plugin/playershops -title: PlayerShops (BSP) -lastUpdated: 2024-01-01 ---- - -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; - -#### This enhancement supports :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} - -It allows every player to create their own shop GUI, similarly to BossShopPro. Players may sell their items in said shop. Might replacement for ChestShops. this plugin hasn't been updated in a while, though. - - \ No newline at end of file diff --git a/src/content/docs/customise/plugins/Free/powerranks.mdx b/src/content/docs/customise/plugins/Free/powerranks.mdx deleted file mode 100644 index 1d80ad0f48..0000000000 --- a/src/content/docs/customise/plugins/Free/powerranks.mdx +++ /dev/null @@ -1,17 +0,0 @@ ---- -description: Learn about the PowerRanks plugin and how to get a basic configuration up and running. -slug: plugin/powerranks -title: PowerRanks -lastUpdated: 2024-01-01 ---- - -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; - -#### This enhancement supports :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} - -PowerRanks is an alternative to Luckperms, it's a Bukkit plugin that support Spigot and it's forks. PowerRanks does have support for NukkitX but has not been updated since Dec 2023. - - - - - diff --git a/src/content/docs/customise/plugins/Free/ultimatetimber.mdx b/src/content/docs/customise/plugins/Free/ultimatetimber.mdx deleted file mode 100644 index e9a40b99c4..0000000000 --- a/src/content/docs/customise/plugins/Free/ultimatetimber.mdx +++ /dev/null @@ -1,26 +0,0 @@ ---- -description: A free plugin that freshens up the most basic task in Minecraft - cutting down a tree. -slug: plugin/ultimatetimber -title: Ultimate Timber -lastUpdated: 2024-01-01 ---- - -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; - -#### This enhancement supports :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} -Give your players a new and exciting way to cut down trees in Minecraft. - -### Features - -
        -
      • Auto pickup
        • -
      • Auto replant
        • -
      • Custom animations (inc block falling)
        • -
      • Custom item drops
        • -
      • Custom sounds
        • -
      - - - - - diff --git a/src/content/docs/customise/plugins/Premium/litebans.mdx b/src/content/docs/customise/plugins/administration/security/litebans.mdx similarity index 72% rename from src/content/docs/customise/plugins/Premium/litebans.mdx rename to src/content/docs/customise/plugins/administration/security/litebans.mdx index 59277e1f02..b0e616820b 100644 --- a/src/content/docs/customise/plugins/Premium/litebans.mdx +++ b/src/content/docs/customise/plugins/administration/security/litebans.mdx @@ -1,17 +1,12 @@ --- -description: Litebans is a premium plugin that centralises ban management for 'networked' servers. -slug: plugin/litebans -title: Litebans -lastUpdated: 2024-01-01 -sidebar: - badge: - text: Recommended - variant: tip +title: LiteBans +description: LiteBans is a premium plugin that centralises ban management for 'networked' servers. +lastUpdated: 2025-10-21 --- -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; +import { Badge, LinkCard, CardGrid } from '@astrojs/starlight/components'; -#### This enhancement supports :badge[BUNGEE, WATERFALL & VELOCITY]{variant="success"} :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +#### This enhancement supports If you're looking for a method of syncing Minecraft bans between multiple Minecraft proxies, servers (or both) or perhaps you're looking for a way to give your end users some transparency over the punishments that are handed out within your community. If this sounds of interest then Litebans is the tool for you. diff --git a/src/content/docs/customise/plugins/Free/essentialsx.mdx b/src/content/docs/customise/plugins/core/essentialsx.mdx similarity index 60% rename from src/content/docs/customise/plugins/Free/essentialsx.mdx rename to src/content/docs/customise/plugins/core/essentialsx.mdx index 756a9e67f8..479706b652 100644 --- a/src/content/docs/customise/plugins/Free/essentialsx.mdx +++ b/src/content/docs/customise/plugins/core/essentialsx.mdx @@ -1,17 +1,12 @@ --- -description: EssentalsX introduces over 130 commands for servers of all sizes which will enhance the gameplay with QoL features for all. -slug: plugin/essentialsx title: EssentialsX -lastUpdated: 2024-01-01 -sidebar: - badge: - text: Essential - variant: success +description: EssentialsX introduces over 130 commands for servers of all sizes which will enhance the gameplay with QoL features for all. +lastUpdated: 2025-10-21 --- -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; +import { Badge, LinkCard, CardGrid } from '@astrojs/starlight/components'; -#### This enhancement supports :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +#### This enhancement supports EssentialsX, formerly just Essentials is the core backbone to any Minecraft server, it introduces a wide range of utility commands (all of which are permission toggle controllable) that can be used to enhance the base gameplay over the vanilla commands. diff --git a/src/content/docs/customise/plugins/Free/Luckperms/luckperms-config.mdx b/src/content/docs/customise/plugins/core/luckperms.mdx similarity index 90% rename from src/content/docs/customise/plugins/Free/Luckperms/luckperms-config.mdx rename to src/content/docs/customise/plugins/core/luckperms.mdx index ca1f6689fe..6bcfd593db 100644 --- a/src/content/docs/customise/plugins/Free/Luckperms/luckperms-config.mdx +++ b/src/content/docs/customise/plugins/core/luckperms.mdx @@ -1,17 +1,23 @@ --- -description: Learn about the Luckperms plugin and how to get a basic configuration up and running. -slug: plugin/luckperms-config -title: Luckperms +title: LuckPerms +description: Learn about the LuckPerms plugin and how to get a basic configuration up and running. lastUpdated: 2024-01-01 -sidebar: - badge: - text: Configuration - variant: note --- + import { LinkCard, CardGrid } from '@astrojs/starlight/components'; +#### This enhancement supports + +LuckPerms is probably the most feature-rich permissions plugin in existence currently. It supports many different kinds of servers, like Bukkit/Spigot or Sponge, but also all the major proxies like Velocity and Bungeecord. + + + + + + ### The Basics -LuckPerms embraces many concepts like "Inheritance" or " Contexts" that might be confusing for a beginner. Consider this section a breakdown of those. + +LuckPerms embraces many concepts like "Inheritance" or "Contexts" that might be confusing for a beginner. Consider this section a breakdown of those. :::info For a more in depth explanation of the plugin, one might use the [official wiki](https://luckperms.net/wiki). @@ -78,4 +84,4 @@ The entire story is a different one when we move to the Tablist part of this gui - + \ No newline at end of file diff --git a/src/content/docs/customise/plugins/Free/vault.mdx b/src/content/docs/customise/plugins/core/vault.mdx similarity index 76% rename from src/content/docs/customise/plugins/Free/vault.mdx rename to src/content/docs/customise/plugins/core/vault.mdx index 87191adcdd..84c46e5d65 100644 --- a/src/content/docs/customise/plugins/Free/vault.mdx +++ b/src/content/docs/customise/plugins/core/vault.mdx @@ -1,17 +1,12 @@ --- -description: Vault API is a core framework for most economy, permission and chat plugins and has become a key dependency for many plugins. -slug: plugin/vault title: Vault API +description: Vault API is a core framework for most economy, permission and chat plugins and has become a key dependency for many plugins. lastUpdated: 2023-12-16 -sidebar: - badge: - text: Essential - variant: success --- -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; +import { Badge, LinkCard, CardGrid } from '@astrojs/starlight/components'; -#### This enhancement supports :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +#### This enhancement supports The Vault API is the longest standing, most reliable permissions, chat and economy API backbone for Minecraft. It's been around for about a decade at this point in time and with every update that passes reliability has always remained. diff --git a/src/content/docs/customise/plugins/Free/worldedit.mdx b/src/content/docs/customise/plugins/core/worldedit.mdx similarity index 82% rename from src/content/docs/customise/plugins/Free/worldedit.mdx rename to src/content/docs/customise/plugins/core/worldedit.mdx index 4b5681d66e..f81acc8289 100644 --- a/src/content/docs/customise/plugins/Free/worldedit.mdx +++ b/src/content/docs/customise/plugins/core/worldedit.mdx @@ -1,17 +1,12 @@ --- -description: WorldEdit is a plugin that's been around for over a decade and can be used to help speed up large builds / world changes. -slug: plugin/worldedit title: WorldEdit +description: WorldEdit is a plugin that's been around for over a decade and can be used to help speed up large builds / world changes. lastUpdated: 2024-01-01 -sidebar: - badge: - text: Essential - variant: success --- -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; +import { Badge, LinkCard, CardGrid } from '@astrojs/starlight/components'; -#### This enhancement supports :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +#### This enhancement supports Worldedit is a no-brainer, this is a plugin that's been around for the entire lifespan of Minecraft multiplayer as we know it and it's not going anywhere fast. If you need to move large buildings in your world, export or import schematics this is the tool for you and your build team. Consider using WETS (WorldEdit Tick Spreader) OR AsyncWorldEdit OR FastAsyncWorldEdit, as they can perform tasks faster & prevent crashes. diff --git a/src/content/docs/customise/plugins/Free/worldguard.mdx b/src/content/docs/customise/plugins/core/worldguard.mdx similarity index 78% rename from src/content/docs/customise/plugins/Free/worldguard.mdx rename to src/content/docs/customise/plugins/core/worldguard.mdx index d6ed544e8c..8edd54a3eb 100644 --- a/src/content/docs/customise/plugins/Free/worldguard.mdx +++ b/src/content/docs/customise/plugins/core/worldguard.mdx @@ -1,17 +1,12 @@ --- -description: WorldGuard is one of the oldest forms of 'admin land claim' systems and has been a core plugin for many servers over the last decade or so. -slug: plugin/worldguard title: WorldGuard +description: WorldGuard is one of the oldest forms of 'admin land claim' systems and has been a core plugin for many servers over the last decade or so. lastUpdated: 2024-01-01 -sidebar: - badge: - text: Essential - variant: success --- -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; +import { Badge, LinkCard, CardGrid } from '@astrojs/starlight/components'; -#### This enhancement supports :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +#### This enhancement supports If you're using WorldEdit then you've most likely already heard of WorldGuard but for those who haven't WorldGuard allows you to create 'admin land claims' which will prevent certain regions from being griefable. This is a perfect solution for building playershops, central landmarks in your server such as spawns and admin shops and more. Some plugins can even hook into the WorldGuard plugin and enhance it's capability offering a better overall experience to your players. diff --git a/src/content/docs/customise/plugins/Premium/citizens.mdx b/src/content/docs/customise/plugins/cosmetic/citizens.mdx similarity index 72% rename from src/content/docs/customise/plugins/Premium/citizens.mdx rename to src/content/docs/customise/plugins/cosmetic/citizens.mdx index eff1929dc3..99da9e5040 100644 --- a/src/content/docs/customise/plugins/Premium/citizens.mdx +++ b/src/content/docs/customise/plugins/cosmetic/citizens.mdx @@ -1,13 +1,12 @@ --- -description: An NPC plugin for your Minecraft server. -slug: plugin/citizens title: Citizens -lastUpdated: 2024-01-01 +description: An NPC plugin for your Minecraft server. +lastUpdated: 2025-10-21 --- -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; +import { Badge, LinkCard } from '@astrojs/starlight/components'; -#### This enhancement supports :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +#### This enhancement supports Citizens is the most popular and widely supported NPC plugin in the market. It is purchasable on Spigot and open source as well. Free downloads can be found on it's Jenkins server. Not recommended for servers with high player counts as it can eat a lot of ticks. diff --git a/src/content/docs/customise/plugins/Free/MiniMOTD.mdx b/src/content/docs/customise/plugins/cosmetic/minimotd.mdx similarity index 98% rename from src/content/docs/customise/plugins/Free/MiniMOTD.mdx rename to src/content/docs/customise/plugins/cosmetic/minimotd.mdx index e1aa8da47f..0a3b1cc4d0 100644 --- a/src/content/docs/customise/plugins/Free/MiniMOTD.mdx +++ b/src/content/docs/customise/plugins/cosmetic/minimotd.mdx @@ -1,7 +1,6 @@ --- -description: MiniMOTD has the functionality to add an MOTD (Message Of The Day) to your server, which shows on the Multiplayer page of Minecraft before a player logs into your server. -slug: plugin/minimotd title: MiniMOTD +description: MiniMOTD has the functionality to add an MOTD (Message Of The Day) to your server, which shows on the Multiplayer page of Minecraft before a player logs into your server. lastUpdated: 2024-01-01 --- diff --git a/src/content/docs/customise/plugins/Free/znpc.mdx b/src/content/docs/customise/plugins/cosmetic/znpcs.mdx similarity index 80% rename from src/content/docs/customise/plugins/Free/znpc.mdx rename to src/content/docs/customise/plugins/cosmetic/znpcs.mdx index b9d0cfdaea..5efc8c3ba3 100644 --- a/src/content/docs/customise/plugins/Free/znpc.mdx +++ b/src/content/docs/customise/plugins/cosmetic/znpcs.mdx @@ -1,13 +1,12 @@ --- +title: ZNPCs description: An NPC plugin for your Minecraft server. -slug: plugin/znpc -title: ZPNCs lastUpdated: 2024-01-01 --- -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; +import { Badge, LinkCard, CardGrid } from '@astrojs/starlight/components'; -#### This enhancement supports :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +#### This enhancement supports ### ZNPCs diff --git a/src/content/docs/customise/plugins/Free/chestshop.mdx b/src/content/docs/customise/plugins/economy/chestshop.mdx similarity index 74% rename from src/content/docs/customise/plugins/Free/chestshop.mdx rename to src/content/docs/customise/plugins/economy/chestshop.mdx index 584aad9d23..13470a94a0 100644 --- a/src/content/docs/customise/plugins/Free/chestshop.mdx +++ b/src/content/docs/customise/plugins/economy/chestshop.mdx @@ -1,13 +1,12 @@ --- -description: A chest based player shop plugin to enhance your economy. -slug: plugin/chestshop title: ChestShop +description: A chest based player shop plugin to enhance your economy. lastUpdated: 2024-01-01 --- -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; +import { Badge, LinkCard, CardGrid } from '@astrojs/starlight/components'; -#### This enhancement supports :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +#### This enhancement supports A simple bare bones chest shop plugin, think 'QuickShop' without all the fancy bells and whistles. ChestShop makes a great plugin for anyone who just wants to get some simple buying and selling going in their server. diff --git a/src/content/docs/customise/plugins/Free/playerauctions.mdx b/src/content/docs/customise/plugins/economy/playerauctions.mdx similarity index 76% rename from src/content/docs/customise/plugins/Free/playerauctions.mdx rename to src/content/docs/customise/plugins/economy/playerauctions.mdx index f9d5d888e1..ab838fc191 100644 --- a/src/content/docs/customise/plugins/Free/playerauctions.mdx +++ b/src/content/docs/customise/plugins/economy/playerauctions.mdx @@ -1,13 +1,12 @@ --- -description: A GUI based player shop plugin to enhance your economy. -slug: plugin/playerauctions title: PlayerAuctions +description: A GUI based player shop plugin to enhance your economy. lastUpdated: 2024-01-01 --- -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; +import { Badge, LinkCard, CardGrid } from '@astrojs/starlight/components'; -#### This enhancement supports :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +#### This enhancement supports It has great levels of customizability and flexibility, to the point where you can edit pretty much every aspect of every single menu. It also has compatibility with lots of other plugins and also an author who is always there to provide support. diff --git a/src/content/docs/customise/plugins/Free/quickshop.mdx b/src/content/docs/customise/plugins/economy/quickshop.mdx similarity index 83% rename from src/content/docs/customise/plugins/Free/quickshop.mdx rename to src/content/docs/customise/plugins/economy/quickshop.mdx index 97d3a52127..d2faf5a863 100644 --- a/src/content/docs/customise/plugins/Free/quickshop.mdx +++ b/src/content/docs/customise/plugins/economy/quickshop.mdx @@ -1,13 +1,12 @@ --- -description: A chest based player shop plugin to enhance your economy. -slug: plugin/quickshop title: Quick Shop Remake +description: A chest based player shop plugin to enhance your economy. lastUpdated: 2024-01-01 --- -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; +import { Badge, LinkCard, CardGrid } from '@astrojs/starlight/components'; -#### This enhancement supports :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +#### This enhancement supports QuickShop Remake is a forked and maintained version of the long standing '[QuickShop](https://dev.bukkit.org/projects/quickshop)' plugin of the earlier Minecraft days. It allows players to buy and sell between one another and the 'admin store' using chests. diff --git a/src/content/docs/customise/plugins/Premium/zauctionhouse.mdx b/src/content/docs/customise/plugins/economy/zauctionhouse.mdx similarity index 76% rename from src/content/docs/customise/plugins/Premium/zauctionhouse.mdx rename to src/content/docs/customise/plugins/economy/zauctionhouse.mdx index 92b8ddc69a..32af84103b 100644 --- a/src/content/docs/customise/plugins/Premium/zauctionhouse.mdx +++ b/src/content/docs/customise/plugins/economy/zauctionhouse.mdx @@ -1,12 +1,12 @@ --- -description: A GUI based player shop plugin to enhance your economy. -slug: plugin/zauctionhouse title: zAuctionHouse -lastUpdated: 2024-01-01 +description: A GUI based player shop plugin to enhance your economy. +lastUpdated: 2025-10-21 --- -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; -#### This enhancement supports :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +import { Badge, LinkCard, CardGrid } from '@astrojs/starlight/components'; + +#### This enhancement supports A premium version of Player Auctions. You may find greater performance in addition to a few extra features, notably the Shulker viewer and a Sell inventory but that's about it. diff --git a/src/content/docs/customise/plugins/Free/Terra/terra-config.mdx b/src/content/docs/customise/plugins/gameplay/terra.mdx similarity index 97% rename from src/content/docs/customise/plugins/Free/Terra/terra-config.mdx rename to src/content/docs/customise/plugins/gameplay/terra.mdx index a3dad4eb9e..07b3e69d0e 100644 --- a/src/content/docs/customise/plugins/Free/Terra/terra-config.mdx +++ b/src/content/docs/customise/plugins/gameplay/terra.mdx @@ -1,12 +1,7 @@ --- -description: Configure a Terra world gen world for use in both Single and Multiplayer environments. -slug: guides/terra title: Terra World Generation +description: Configure a Terra world gen world for use in both Single and Multiplayer environments. lastUpdated: 2024-03-04 -sidebar: - badge: IMG MISSING - variant: danger - --- import { LinkCard, CardGrid } from '@astrojs/starlight/components'; diff --git a/src/content/docs/customise/plugins/intro.mdx b/src/content/docs/customise/plugins/index.mdx similarity index 79% rename from src/content/docs/customise/plugins/intro.mdx rename to src/content/docs/customise/plugins/index.mdx index 9af638cdcb..f72a9af26e 100644 --- a/src/content/docs/customise/plugins/intro.mdx +++ b/src/content/docs/customise/plugins/index.mdx @@ -1,8 +1,7 @@ --- -slug: plugins -title: Criteria for listing -sidebar: - order: 1 +title: Listing Criteria +description: Criteria for listing popular plugins for Minecraft servers. +lastUpdated: 2025-10-21 --- Our goal is to highlight some must have plugins for Minecraft, in order for them to make the list they have to meet the below criteria. diff --git a/src/content/docs/customise/plugins/Free/discordsrv.mdx b/src/content/docs/customise/plugins/integration/discordsrv.mdx similarity index 85% rename from src/content/docs/customise/plugins/Free/discordsrv.mdx rename to src/content/docs/customise/plugins/integration/discordsrv.mdx index 596238d310..8071d04a30 100644 --- a/src/content/docs/customise/plugins/Free/discordsrv.mdx +++ b/src/content/docs/customise/plugins/integration/discordsrv.mdx @@ -1,13 +1,12 @@ --- -description: DiscordSRV acts as a bridge between a Discord server and your Minecraft server, allowing them to communicate. -slug: plugin/discordsrv title: DiscordSRV +description: DiscordSRV acts as a bridge between a Discord server and your Minecraft server, allowing them to communicate. lastUpdated: 2024-01-01 --- -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; +import { Badge, LinkCard, CardGrid } from '@astrojs/starlight/components'; -#### This enhancement supports :badge[SPIGOT/PAPER & FORKS ONLY]{variant="caution"} +#### This enhancement supports DiscordSRV is a very commonly used plugin that acts as a bridge between your Minecraft and Discord servers, allowing them to communicate and for actions to be called via interactions in Discord and vice-versa. DiscordSRV also supports livechat functionality between your Minecraft and Discord server so players that aren't logged in can still chat. Moreover, DiscordSRV allows for linking a users Discord account to their Minecraft account on a per-instance basis. That said, the setup of DiscordSRV relies on the creation of an application and Bot on Discord's Developer Portal. diff --git a/src/content/docs/customise/plugins/integration/dynmap.mdx b/src/content/docs/customise/plugins/integration/dynmap.mdx new file mode 100644 index 0000000000..c55b3e59e8 --- /dev/null +++ b/src/content/docs/customise/plugins/integration/dynmap.mdx @@ -0,0 +1,140 @@ +--- +title: Dynmap +description: Learn about the Dynmap Minecraft plugin and how it can be used in a Minecraft server. +lastUpdated: 2024-06-12 +--- + +Dynmap is a free plugin for your Minecraft server that ships with a HTTP server that hosts a Google Maps-like view of your Minecraft world that can be viewed from your browser. +It also comes with many other features, including: +- Configurable maps per world +- Real-time updates +- Players and their chat messages are visible on the map as balloons +- Built-in webchat system linked to the Minecraft server chat +- In-game time and weather are visible on the map +- Add-ons for Towny, EssentialsX, WorldGuard among others + +### You Will Need + +* A Minecraft server with Spigot or any of its forks +* A secondary port allocation for the web server to listen on if you are using a shared host + +--- + +### Installation + +First things first, we need to install the Dynmap plugin on our server. Download it from [here](https://www.spigotmc.org/resources/dynmap%C2%AE.274/) and upload it to `/plugins` on your server, whether through (S)FTP or the web. Restart your server and go to `/plugins/dynmap`. + +#### Configuring Dynmap + +Once you're in the Dynmap plugin directory, we'll need to tweak the `configuration.txt` file a bit. Open it with your favourite text editor or web editor. + +* To adjust the resolution of tiles, find the line that says `deftemplatesuffix` - this'll be the first thing you see when you open up the file - change it to one of [`vlowres`, `lowres`, `medres`, `hires`] +:::warning +Fully-generated high resolution maps will take up to hundreds of gigabytes of disk space +::: +* To use an SQL database for map storage rather than flat files, comment `type: filetree` and uncomment `#type: sqlite` or `#type: mysql` along with the filename for SQLite or MySQL credentials depending on which you are using. +Alternatively, you can use Amazon S3 for storing maps, uncomment the lines below `# AWS S3 bucket web site` and change the region and access credentials to match yours +* To customise the title of the webpage, uncomment the line containing `webpage-title` and change the value as you wish. +* To save on disk space for while preserving most quality of tile images, find the line that begins with `image-format` and set it to `jpg-q90`. Alternatively, you can use the more efficient WEBP format - make sure to also uncomment the `cwebpPath` and `dwebpPath` lines as well as installing the appropriate packages +* To enable the outbound web server, find the line that says `webserver-bindaddress` and uncomment it. Change the `webserver-port` to whatever port you plan to use - if you're on a host with a shared IP, this'll be something way different from the default `8123`. This is practically a must for this guide as it's the whole point - unless you want to use an external web server, which isn't covered here. +* To enable login support, change `login-enabled` to true - change `login-required` to true to require login for access +* To require login for the webchat, go back up and find the line that says `webchat-requires-login` - uncomment and change to true. +:::note +If you plan to use the login system, SSL is a must to encrypt traffic between users and the web server - unencrypted logins are prone to attacks from hackers. The next page contains a tutorial on how to do this +::: + +Restart your Minecraft server to apply the changes. When done, type `http://:` into your web browser - if a webpage shows up, then ta-da! Dynmap's internal web server is working fine and dandy! +The next page will detail how to set up an Caddy proxy and enable HTTPS for your map. + +## Reverse Proxy + +This tutorial covers how to proxy your Dynmap server behind Nginx with a free SSL certificate from Let's Encrypt installed + +### Requirements + +* A Minecraft server with Dynmap configured +* A VPS with atleast Ubuntu 22.04 deployed +* A [ZeroSSL account](https://zerossl.com/?fpr=setupmd) (Optional) +* Root access to the aforementioned VPS + +If you haven't got access to the above, you should consult your service providers. + +--- + +### Caddy Deployment + +#### Installation + +First off, we need to install Caddy and add allow rules for both HTTP and HTTPS traffic to the UFW firewall. + +``` +... + +sudo apt install -y debian-keyring debian-archive-keyring apt-transport-https +curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/gpg.key' | sudo gpg --dearmor -o /usr/share/keyrings/caddy-stable-archive-keyring.gpg +curl -1sLf 'https://dl.cloudsmith.io/public/caddy/stable/debian.deb.txt' | sudo tee /etc/apt/sources.list.d/caddy-stable.list +sudo apt update && sudo apt install caddy +sudo ufw allow http +sudo ufw allow https + +... +``` + +#### Generate ZeroSSL API Keys (Optional) + +This step is optiona if you don't want to use ZeroSSL as you're provider. If you chose not to use ZeroSSL your certs will be deployed via LetsEncrypt however support for Google Trust Services can also be configured. + +You can go to the [ZeroSSL developer console](https://app.zerossl.com/developer) and select 'Generate' under 'EAB Credentials'. + + +#### Caddyfile Config + +Below is an example configuration file. Edit it and save it as `/etc/caddy/Caddyfile` + +```yaml +... + +# Define ACME credentials (Optional but required for ZeroSSL) +{ + acme_ca https://acme.zerossl.com/v2/DV90 + acme_eab { + key_id + mac_key + } +} + +# Required for all deployments +map.mydomain.com { + reverse_proxy http://: +} + +... +``` + +To enable the site run the following command + +```bash +... + +caddy reload + +... +``` + +If you get an error with formatting you should run the following command and then re-run the reload command. + +```bash +... + +sudo caddy fmt --overwrite + +... +``` + +--- + +### Testing Configuration + +If you're using ZeroSSL you should check you see a provisioned SSL certificate under you account dashboard, when you select 'Certificates' > 'Issued' it will be marked as a 'Certificate' and not '90-Day SSL'. + +All users should be able to use https://map.mydomain.com, if you're not using the ACME setup within \ No newline at end of file diff --git a/src/content/docs/deploy/considerations/hosting-types.mdx b/src/content/docs/deploy/considerations/hosting-types.mdx index 682fa24286..ae82c6edf7 100644 --- a/src/content/docs/deploy/considerations/hosting-types.mdx +++ b/src/content/docs/deploy/considerations/hosting-types.mdx @@ -1,25 +1,31 @@ --- +title: Hosting Types description: Understand the different types of hosting services available and what may be the best fit for your project. -slug: deploy/hosting-types -title: Cloud Hosting Types +lastUpdated: 2025-10-21 --- -:::note - -You can skip this article if you're looking to self-host your server on your own hardware, if that's the case please see our [self-hosting considerations](/deploy/selfhosted-considerations) article instead. -::: +import { Badge } from '@astrojs/starlight/components'; When you start looking at hosting your server online you'll see many different answers of which none are wrong, but they're not always suited to your needs. This page has a goal of helping you identify when you may need each type of hosting. +## Commercial Hosting Options -The three most common types you'll find in forum responses are: +The three most common commercial hosting types you'll find in forum responses are:
      • Shared Hosting
      • Virtual Private Servers (VPS)
      • Dedicated Servers (Bare Metal / VDS)
      -### Shared Hosting :badge[BEST OPTION FOR MOST PEOPLE]{variant=success} +## Self-Hosting Options + +When it comes to running everything yourself you have two options: +
        +
      • Rent hardware / compute in the 'cloud'
        • +
      • Provide your own hardware and run at a data centre / your house
        • +
      + +### Shared Hosting The most common type you'll find is 'Shared Hosting', this is where a hosting provider will own a physical server and partition the resources out to clients and you will connect to / manage your server via a [web panel](/deploy/panels) and SFTP. If you select this style of hosting you should be careful and note that some providers will oversell the resources. Overselling allows for them to provide cheaper monthly plans but may come at a performance hit due to this over allocation. Others will provide a dedicated quota that is only allocated to yourself, this will be slightly more expensive but you will have the entire quota to your disposal whenever you need it (plus it will still be cheaper than a VPS / Bare Metal). @@ -27,7 +33,7 @@ Traditionally this space was dominated by the likes of Nitrado, MCProHosting, Sh --- -### Virtual Private Servers +### Virtual Private Servers The other common response you'll see people mention is 'grab yourself a VPS from Digital Ocean or Linode'. While you certainly can, it won't be much better than using [oracle cloud](/extra/oracle-cloud) on ARM (which is free). @@ -44,11 +50,11 @@ There are times when a VPS can make sense, a prime example is using a VPS provid --- -### Bare Metal / VDS +### Bare Metal / VDS The final common type of hosting you'll see people mention is, "go all out and own your hardware". While yes, this has some advantages for a novice the prospect of having no one around for support can be unsettling. Bare metal gives you full, dedicated, system normally in 32 / 64 or 128 GB RAM configurations with 256 / 512 or multi-TB disk configs. Bare metal can either be built yourself and shipped to a data centre for a monthly fee or you can rent from providers such as Hetzner, OVH or ReliableSite for a monthly fee. This option can set you back multiple hundreds of dollars per month and would only be recommended for larger scale deployments. -Bare metal has a few advantages over the other types of solutions such as. +Bare metal has a few advantages over the other types of solutions such as:
      • Complete ownership of the server data
      • Complete ownership of physical and networking resources
        • @@ -56,6 +62,26 @@ Bare metal has a few advantages over the other types of solutions such as.
      Bare metal also carries the same differences to shared hosting as a VPS. +## Self-Hosting Considerations + +### Option 1: Rented Hardware + +If you can afford it, this is your better option. While this is the most expensive option your monthly bill does include hardware, electricity, internet and in some cases DDoS protection. A mid-range to high-end service will cost you anywhere from $100 per month, so it may not be suitable for those who don't already have an established community. + +This option is essentially the same as the Bare Metal option described above, but you take on full responsibility for software configuration and maintenance. + +### Option 2: Home Hosting + +The cheapest option but does require some additional considerations. For one or two people this option may still make the most sense. +
        +
      • Do you have a suitable internet connection? Firstly run a speed test, this will give you an idea of where your current connection sits. A 50mbps connection for both upload and download should be sufficient for your regular household activities **and** your Minecraft server, remember your connection is shared between all devices so downloading something on your internet e.g. steam games will reduce the available connection to Minecraft.
        • +
      • Do you have proper IPv4 addresses? Yes, Minecraft *can* support IPv6 but it requires all parties involved to also support V6 connectivity. You also need to consider if you have a [static IPv4 address](/fix/nat).
        • +
      • Have you considered the overhead to security, power utilisation, heat generated, noise produced and cost of hardware? Protecting the rest of your network can cost you either in man-hours or hardware if you need to purchase additional tools to get operational. This should all be considered before you commit to running things from home.
        • +
      • 24/7 Availability? If you're not prepared to run a server 24/7 from your home are you players happy with the fact a server will only be online for a few hours a day.
        • +
      + +If you do want to host things yourself we have documentation on how to do such things [here](/deploy/create/standalone/windows). + :::tip If you don't already know what level of hardware you should be looking at then please consider reading our [hardware guide](hardware) first, then once you know what hardware and solution you're looking for head on over to our [recommendation page](providers) for vendors that can deliver what you're looking for. diff --git a/src/content/docs/deploy/considerations/intro.mdx b/src/content/docs/deploy/considerations/index.mdx similarity index 81% rename from src/content/docs/deploy/considerations/intro.mdx rename to src/content/docs/deploy/considerations/index.mdx index 8ab458787b..ee8d340454 100644 --- a/src/content/docs/deploy/considerations/intro.mdx +++ b/src/content/docs/deploy/considerations/index.mdx @@ -1,10 +1,7 @@ --- -description: How to deploy a Minecraft server using a third party service provider. -slug: deploy/considerations -title: Getting Started -lastUpdated: 2025-10-18 -sidebar: - order: 1 +title: Introduction +description: Things to consider before deploying your Minecraft server. +lastUpdated: 2025-10-21 --- Getting a Minecraft can be a simple process, if you already know what you're looking to do and just want instructions on the *how* you can skip to the pre-requisite articles for either self-hosting or 'Shared Hosting' articles if you're using a third party provider. @@ -16,6 +13,5 @@ With that in mind it is worth checking out the following articles to help you ma | Topic | KB Article URL | Summary | | ----------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------- | | Cloud Hosting Types | [/deploy/hosting-types](/deploy/hosting-types) | If you know you want to pay for a dedicated service and not use your own PC, checkout this article on the types of available hosting to you. | -| Self-Hosting Considerations | [/deploy/self-hosted](/deploy/self-hosted) | If you're looking to run the server on your own hardware at home or at a data centre, checkout this article to help you make the right decision. | | Operating Systems | [/deploy/operating-systems](/deploy/operating-systems) | Helping you idenfity what Operating System you should use for a standalone dedicated device running your Minecraft server. | | Control Panels | [/deploy/panels](/deploy/panels) | If you're hosting on your own dedicated environment and you're looking to have a web-ui to manage your server, check out this article. | diff --git a/src/content/docs/deploy/considerations/operating-systems.mdx b/src/content/docs/deploy/considerations/operating-systems.mdx index fca176cceb..44fd8f30bf 100644 --- a/src/content/docs/deploy/considerations/operating-systems.mdx +++ b/src/content/docs/deploy/considerations/operating-systems.mdx @@ -1,7 +1,7 @@ --- -description: Let's discuss the major operating systems that you will come across when hosting a Minecraft server. -slug: deploy/operating-systems title: Operating Systems +description: Let's discuss the major operating systems that you will come across when hosting a Minecraft server. +lastUpdated: 2025-10-21 --- When running a Minecraft server on [bare metal](/deploy/hosting-types#bare-metal--vds), or a [VPS](/deploy/hosting-types#virtual-private-servers) you'll need to install a base operating system before you can get started. Unless you're running an apple device your options are Windows / Windows Server or Linux and the abundance of distros that come along with it. diff --git a/src/content/docs/deploy/considerations/panels.mdx b/src/content/docs/deploy/considerations/panels.mdx index 4251d783a3..34caf454cc 100644 --- a/src/content/docs/deploy/considerations/panels.mdx +++ b/src/content/docs/deploy/considerations/panels.mdx @@ -1,10 +1,10 @@ --- -description: You don't always want to be using the CLI to manage your server, consider a web panel and share the responsibility with your other administrators. -slug: deploy/panels title: Control Panels +description: You don't always want to be using the CLI to manage your server, consider a web panel and share the responsibility with your other administrators. +lastUpdated: 2025-10-21 --- -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; +import { Badge, LinkCard, CardGrid } from '@astrojs/starlight/components'; If you're running a Minecraft server the chances are you'll want an easier method of management, this is where panels come into play. Every [shared hosting](/deploy/hosting-types#shared-hosting) provider will come with a control panel, this is how you'll interface with your server normally at a URL similar to https://panel.mydomain.com. Depending on how long the provider has been in business they'll either be using Multicraft or Pterodactyl (newer hosts using the latter). @@ -19,7 +19,7 @@ The top 4 shortlisted panels this article will be covering are.
    • PufferPanel
    -### AMP :badge[WINDOWS & LINUX] +### AMP AMP is a licensed panel produced by CubeCoders which supports both Windows and Linux including Ubuntu, Debian, Arch, Cent OS and more. CubeCrafters are by no means new to the hosting game, their previous product McMyAdmin launched all the way back in 2013. @@ -50,7 +50,7 @@ At this time there is **NO** Apple builds so for legacy McMyAdmin2 users this pr --- -### Moonlight :badge[LINUX] +### Moonlight :::note We will revisit Moonlight once V2.1 has been released, our review is based on the legacy V1.0 release and does not reflect the current V2.0 release. @@ -81,7 +81,7 @@ Moonlight is an up and coming panel solution that is aimed towards those looking --- -### Pterodactyl :badge[LINUX] +### Pterodactyl Multicraft had to die for Pterodactyl to breathe, an open source panel in active development and great support behind it. For those who like the sound of pterodactyl but not the self-hosting setup process you can look at the SaaS version [WISP](https://wisp.gg) which will cost you around $5 a month for the community plan. @@ -109,7 +109,7 @@ Pterodactyl boasts a two part setup, a web-server and a docker agent (wings) tha --- -### PufferPanel :badge[LINUX] +### PufferPanel PufferPanel could have been the Pterodactyl industry standard tool today, a panel formerly developed by a Pterodactyl team member prior to a clashing of heads and a splitting of the product, however PufferPanel remains open source and in active development by the original founder and an long-time dev. diff --git a/src/content/docs/deploy/considerations/self-hosted.mdx b/src/content/docs/deploy/considerations/self-hosted.mdx deleted file mode 100644 index c11c662dd0..0000000000 --- a/src/content/docs/deploy/considerations/self-hosted.mdx +++ /dev/null @@ -1,30 +0,0 @@ ---- -description: So you want to host a Minecraft server yourself? Checkout your options and find the solution that suits your requirements. -slug: deploy/self-hosted -title: Self Hosting ---- - -When it comes to running everything yourself you have two options -
      -
    • Rent hardware / compute in the 'cloud'
      • -
    • Provide your own hardware and run at a data centre / your house
      • -
    - -### Option 1 - -If you can afford it, this is your better option. While this is the most expensive option your monthly bill does include hardware, electricity, internet and in some cases ddos protection. A mid-range to high end service will cost you anywhere from 100$ per month in this regards so may not be suitable for those who don't already have an established community, we discuss this option a in a bit more depth [here](/deploy/hosting-types#bare-metal--vds). - ---- - -### Option 2 - -The cheapest option but is does require some additional thought however for one or two people this option may still make the most sense. -
      -
    • Do you have a suitable internet connection? Firstly run a speed test, this will give you an idea of where your current connection sits. A 50mbps connection for both upload and download should be sufficient for your regular household activities **and** your Minecraft server, remember your connection is shared between all devices so downloading something on your internet e.g. steam games will reduce the available connection to Minecraft.
      • -
    • Do you have proper IPv4 addresses? Yes, Minecraft *can* support IPv6 but it requires all parties involved to also support V6 connectivity. You also need to consider if you have a [static IPv4 address](/fix/nat).
      • -
    • Have you considered the overhead to security, power utilisation, heat generated, noise produced and cost of hardware? Protecting the rest of your network can cost you either in man-hours or hardware if you need to purchase additional tools to get operational. This should all be considered before you commit to running things from home.
      • -
    • 24/7 Availability? If you're not prepared to run a server 24/7 from your home are you players happy with the fact a server will only be online for a few hours a day.
      • -
    - - -If you do want to host things yourself we have documentation on how to do such things [here](/deploy/win). diff --git a/src/content/docs/administer/server-software.mdx b/src/content/docs/deploy/considerations/server-software.mdx similarity index 97% rename from src/content/docs/administer/server-software.mdx rename to src/content/docs/deploy/considerations/server-software.mdx index 3402029f1c..aab117c529 100644 --- a/src/content/docs/administer/server-software.mdx +++ b/src/content/docs/deploy/considerations/server-software.mdx @@ -1,11 +1,10 @@ --- -slug: administer/server-software -description: This page covers a list of well known server.jars. title: Server Software -lastUpdated: 2024-03-27 +description: This page covers a list of well known server.jars. +lastUpdated: 2025-10-21 --- -import { LinkCard, CardGrid } from '@astrojs/starlight/components'; +import { Badge, LinkCard, CardGrid } from '@astrojs/starlight/components'; When creating a server there are multiple different names you will come across. Each server software has its own uses. @@ -19,7 +18,7 @@ A "Fork" is a modified version of server software. These often share the same co There are hundreds (if not thousands) of different forks. This document will only include the recommended, stable, widely-used ones. -#### Vanilla :badge[NO PLUGIN SUPPORT]{variant="danger"} +#### Vanilla As the name suggests, it is a completely Vanilla server from Mojang itself without any modifications. Great for those who want to host a small server for a couple of friends without altering any mechanics, but definitely not good for large servers. @@ -29,7 +28,7 @@ As the name suggests, it is a completely Vanilla server from Mojang itself witho href="https://jar.setup.md/download/vanilla/latest" /> -#### Paper :badge[RECOMMENDED]{variant="success"} +#### Paper Paper is the most widely-used Server Jar nowadays. A fork of Spigot with its own API, numerous optimizations alongside tons of glitch/dupe fixes make Paper the main choice for most server owners. diff --git a/src/content/docs/deploy/create/download-jars.mdx b/src/content/docs/deploy/create/download-jars.mdx index 07ec4173f2..839f241552 100644 --- a/src/content/docs/deploy/create/download-jars.mdx +++ b/src/content/docs/deploy/create/download-jars.mdx @@ -1,10 +1,7 @@ --- -description: A guide to ensure you have the relevant Jar file for your Minecraft server. title: Downloading Jars -slug: deploy/download-jars -lastUpdated: 2025-10-16 -sidebar: - order: 3 +description: A guide to ensure you have the relevant Jar file for your Minecraft server. +lastUpdated: 2025-10-21 --- import { LinkCard, CardGrid } from '@astrojs/starlight/components'; @@ -67,4 +64,4 @@ drwx------ 7 root root 4096 Jul 9 16:59 .. ### Alternative Server Jars -If you are looking for alternative server jars outside of our API, you can use [this link](/administer/server-software) to view a list of popular server jars along with their download links. \ No newline at end of file +If you are looking for alternative server jars outside of our API, you can use [this link](/administration/server-software) to view a list of popular server jars along with their download links. \ No newline at end of file diff --git a/src/content/docs/deploy/create/install-java.mdx b/src/content/docs/deploy/create/install-java.mdx index 9dcad047cb..329a9588e8 100644 --- a/src/content/docs/deploy/create/install-java.mdx +++ b/src/content/docs/deploy/create/install-java.mdx @@ -1,11 +1,7 @@ --- -description: A guide to download and install OpenJDK for Mac, Windows, and Ubuntu. title: Install Java -slug: deploy/install-java -lastUpdated: 2025-10-16 -sidebar: - order: 2 - badge: "PREREQUISITE" +description: A guide to download and install OpenJDK for Mac, Windows, and Ubuntu. +lastUpdated: 2025-10-21 --- You should already have Java installed, but if you don't because you're using a spare PC to host your Minecraft server, follow the instructions below to download and install the Java Runtime Environment (JRE) for your operating system. diff --git a/src/content/docs/deploy/create/Standalone (Java)/docker.mdx b/src/content/docs/deploy/create/standalone/docker.mdx similarity index 99% rename from src/content/docs/deploy/create/Standalone (Java)/docker.mdx rename to src/content/docs/deploy/create/standalone/docker.mdx index 62f0d6f53c..945c9ccf79 100644 --- a/src/content/docs/deploy/create/Standalone (Java)/docker.mdx +++ b/src/content/docs/deploy/create/standalone/docker.mdx @@ -1,7 +1,7 @@ --- +title: Docker Deployment description: If you've already got a Docker deployment that you're able to access then using our Compose template is the quickest and easiest way to get your server up and running. -slug: deploy/docker -title: Docker +lastUpdated: 2025-10-21 --- It's 2022, per application VMs are out and containers are in! We're at chapter 2 of the tech buzzword catalogue except Docker is actually cool. [NetworkChuck](https://www.youtube.com/@NetworkChuck) has a great introductory video for [Docker](https://youtu.be/eGz9DS-aIeY) and [Docker networking](https://youtu.be/bKFMS5C4CG0) and it's recommended to watch those first before continuing. diff --git a/src/content/docs/deploy/create/Standalone (Java)/linux.mdx b/src/content/docs/deploy/create/standalone/linux.mdx similarity index 95% rename from src/content/docs/deploy/create/Standalone (Java)/linux.mdx rename to src/content/docs/deploy/create/standalone/linux.mdx index e306eef013..24df4dde08 100644 --- a/src/content/docs/deploy/create/Standalone (Java)/linux.mdx +++ b/src/content/docs/deploy/create/standalone/linux.mdx @@ -1,8 +1,7 @@ --- -description: If you're just looking to setup a Minecraft server within Linux on your own personal machine then this is the tutorial for you. -slug: deploy/linux -title: Linux -lastUpdated: 2024-11-23 +title: Linux Deployment +description: If you're looking to setup a Minecraft server within Linux on your own personal machine then this is the tutorial for you. +lastUpdated: 2025-10-21 --- If you're in the position where you want to host a Minecraft server but you don't want to learn or interface with the command line too frequently then Windows will most likely be your OS of choice either on your own PC or a spare machine you have around the house. @@ -103,7 +102,7 @@ cd minecraft-server-folder ... ``` -Now we can deploy the server jar we're wanting to use, this tutorial will reference [paper](https://papermc.io) but there are plenty of other server platforms and [this page](/administer/server-software) explains the pros and cons of the major ones. +Now we can deploy the server jar we're wanting to use, this tutorial will reference [paper](https://papermc.io) but there are plenty of other server platforms and [this page](/administration/server-software) explains the pros and cons of the major ones. ```bash ... diff --git a/src/content/docs/deploy/create/Standalone (Java)/win.mdx b/src/content/docs/deploy/create/standalone/windows.mdx similarity index 96% rename from src/content/docs/deploy/create/Standalone (Java)/win.mdx rename to src/content/docs/deploy/create/standalone/windows.mdx index c2565433a3..11afb87e7b 100644 --- a/src/content/docs/deploy/create/Standalone (Java)/win.mdx +++ b/src/content/docs/deploy/create/standalone/windows.mdx @@ -1,7 +1,7 @@ --- -description: If you're just looking to setup a Minecraft server within Windows on your own personal machine then this is the tutorial for you. -slug: deploy/win -title: Windows +title: Windows Deployment +description: If you're looking to setup a Minecraft server within Windows on your own personal machine then this is the tutorial for you. +lastUpdated: 2025-10-21 --- If you're in the position where you want to host a Minecraft server but you don't want to learn or interface with the command line too frequently then Windows will most likely be your OS of choice either on your own PC or a spare machine you have around the house. diff --git a/src/content/docs/deploy/create/startup.mdx b/src/content/docs/deploy/create/startup-scripts.mdx similarity index 98% rename from src/content/docs/deploy/create/startup.mdx rename to src/content/docs/deploy/create/startup-scripts.mdx index 63e99b133b..a2a8c15fd0 100644 --- a/src/content/docs/deploy/create/startup.mdx +++ b/src/content/docs/deploy/create/startup-scripts.mdx @@ -1,7 +1,7 @@ --- -description: Understand the startup file used when hosting a server. -slug: deploy/startup-script title: Startup Scripts +description: Understand the startup file used when hosting a server. +lastUpdated: 2025-10-21 --- ### Basics @@ -30,7 +30,7 @@ You should set your RAM allocation according to your average server load - alloc `nogui` hides the Minecraft server GUI panel, only leaving the console visible. Remove the flag if you choose to use the panel. It has basic features like a player list, performance metrics and console output. -`-jar .jar` points to the server .jar - see [Server Software](/administer/server-software). +`-jar .jar` points to the server .jar - see [Server Software](/administration/server-software). --- diff --git a/src/content/docs/extras/Game Panels/Pterodactyl/intro.mdx b/src/content/docs/deploy/game-panels/pterodactyl/index.mdx similarity index 98% rename from src/content/docs/extras/Game Panels/Pterodactyl/intro.mdx rename to src/content/docs/deploy/game-panels/pterodactyl/index.mdx index 11f862b6a8..bcbddc3029 100644 --- a/src/content/docs/extras/Game Panels/Pterodactyl/intro.mdx +++ b/src/content/docs/deploy/game-panels/pterodactyl/index.mdx @@ -1,10 +1,7 @@ --- -description: Pterodactyl introuction page, understand what the product is and when it's ideal to use it. -slug: pterodactyl title: Breakdown +description: Pterodactyl introuction page, understand what the product is and when it's ideal to use it. lastUpdated: 2025-10-19 -sidebar: - order: 1 --- If you're new to hosting you first need to understand a couple of concepts before you continue here, the diff --git a/src/content/docs/extras/Game Panels/Pterodactyl/modifications.mdx b/src/content/docs/deploy/game-panels/pterodactyl/modifications.mdx similarity index 97% rename from src/content/docs/extras/Game Panels/Pterodactyl/modifications.mdx rename to src/content/docs/deploy/game-panels/pterodactyl/modifications.mdx index 56795c7baf..4c3cb90399 100644 --- a/src/content/docs/extras/Game Panels/Pterodactyl/modifications.mdx +++ b/src/content/docs/deploy/game-panels/pterodactyl/modifications.mdx @@ -1,9 +1,6 @@ --- -description: Getting more out of your Pterodactyl panel with modifications -slug: pterodactyl/mods title: Modifications -sidebar: - order: 5 +description: Getting more out of your Pterodactyl panel with modifications lastUpdated: 2025-10-19 --- diff --git a/src/content/docs/extras/Game Panels/Pterodactyl/node.mdx b/src/content/docs/deploy/game-panels/pterodactyl/node.mdx similarity index 98% rename from src/content/docs/extras/Game Panels/Pterodactyl/node.mdx rename to src/content/docs/deploy/game-panels/pterodactyl/node.mdx index 796386ddc7..2395b79411 100644 --- a/src/content/docs/extras/Game Panels/Pterodactyl/node.mdx +++ b/src/content/docs/deploy/game-panels/pterodactyl/node.mdx @@ -1,9 +1,6 @@ --- -slug: pterodactyl/node -description: Creating and configuring a 'Node' within the Pterodactyl panel. -sidebar: - order: 4 title: Node +description: Creating and configuring a 'Node' within the Pterodactyl panel. lastUpdated: 2025-10-19 --- diff --git a/src/content/docs/extras/Game Panels/Pterodactyl/panel.mdx b/src/content/docs/deploy/game-panels/pterodactyl/panel.mdx similarity index 99% rename from src/content/docs/extras/Game Panels/Pterodactyl/panel.mdx rename to src/content/docs/deploy/game-panels/pterodactyl/panel.mdx index be98b6e30b..e48de1e271 100644 --- a/src/content/docs/extras/Game Panels/Pterodactyl/panel.mdx +++ b/src/content/docs/deploy/game-panels/pterodactyl/panel.mdx @@ -1,9 +1,6 @@ --- -slug: pterodactyl/panel -description: A short guide based on Ubuntu for how to deploy the Pterodactyl web panel. -sidebar: - order: 2 title: Panel +description: A short guide based on Ubuntu for how to deploy the Pterodactyl web panel. lastUpdated: 2025-10-19 --- diff --git a/src/content/docs/extras/Game Panels/Pterodactyl/wings.mdx b/src/content/docs/deploy/game-panels/pterodactyl/wings.mdx similarity index 99% rename from src/content/docs/extras/Game Panels/Pterodactyl/wings.mdx rename to src/content/docs/deploy/game-panels/pterodactyl/wings.mdx index bcf7316219..021501ce86 100644 --- a/src/content/docs/extras/Game Panels/Pterodactyl/wings.mdx +++ b/src/content/docs/deploy/game-panels/pterodactyl/wings.mdx @@ -1,9 +1,6 @@ --- -slug: pterodactyl/wings -description: A short guide that runs through the deployment steps for the Wings docker agent used by Pterodactyl. title: Wings -sidebar: - order: 3 +description: A short guide that runs through the deployment steps for the Wings docker agent used by Pterodactyl. lastUpdated: 2025-10-19 --- diff --git a/src/content/docs/extras/Game Panels/Pufferpanel/installation.mdx b/src/content/docs/deploy/game-panels/pufferpanel/index.mdx similarity index 98% rename from src/content/docs/extras/Game Panels/Pufferpanel/installation.mdx rename to src/content/docs/deploy/game-panels/pufferpanel/index.mdx index ea8ea5d9f1..f3fab10bbc 100644 --- a/src/content/docs/extras/Game Panels/Pufferpanel/installation.mdx +++ b/src/content/docs/deploy/game-panels/pufferpanel/index.mdx @@ -1,9 +1,6 @@ --- -description: A short deployment guide for Puffer panel on Ubuntu LTS -slug: pufferpanel/deployment title: Deployment -sidebar: - order: 1 +description: A short deployment guide for Puffer panel on Ubuntu LTS --- PufferPanel is a open source web-based Game Server Management System. PufferPanel allows you to run multiple different game servers all from one central location, and give other users their own servers, or access to your own servers. diff --git a/src/content/docs/extras/Game Panels/Pufferpanel/ssl.mdx b/src/content/docs/deploy/game-panels/pufferpanel/ssl.mdx similarity index 98% rename from src/content/docs/extras/Game Panels/Pufferpanel/ssl.mdx rename to src/content/docs/deploy/game-panels/pufferpanel/ssl.mdx index 9ed30c3965..bcba5a9a13 100644 --- a/src/content/docs/extras/Game Panels/Pufferpanel/ssl.mdx +++ b/src/content/docs/deploy/game-panels/pufferpanel/ssl.mdx @@ -1,9 +1,6 @@ --- -description: A guide for configuring the Puffer panel with SSL. -slug: pufferpanel/ssl title: SSL Configuration -sidebar: - order: 2 +description: A guide for configuring the Puffer panel with SSL. --- ### SSL requirements diff --git a/src/content/docs/deploy/hosted/hardware.mdx b/src/content/docs/deploy/hosted/hardware.mdx index ec8f914690..a26601b341 100644 --- a/src/content/docs/deploy/hosted/hardware.mdx +++ b/src/content/docs/deploy/hosted/hardware.mdx @@ -1,11 +1,9 @@ --- +title: Hardware Requirements description: Picking the right hardware is the most important thing when it comes to hosting as it will determine how far you can push your ideas before you have to throttle back or risk destroying the user experience. -slug: deploy/hardware -title: Hardware -lastUpdated: 2025-10-19 +lastUpdated: 2025-10-21 --- - ### CPU When it comes to finding a CPU (for Minecraft) the most important factor is the [IC](https://www.youtube.com/watch?v=Z5JC9Ve1sfI), this consists of a fetch, decode, read and execute cycle all taking place to complete a single cycle. diff --git a/src/content/docs/deploy/hosted/intro.mdx b/src/content/docs/deploy/hosted/index.mdx similarity index 95% rename from src/content/docs/deploy/hosted/intro.mdx rename to src/content/docs/deploy/hosted/index.mdx index 20c09c9067..3552524cda 100644 --- a/src/content/docs/deploy/hosted/intro.mdx +++ b/src/content/docs/deploy/hosted/index.mdx @@ -1,10 +1,7 @@ --- +title: Introduction description: How to deploy a Minecraft server using a third party service provider. -slug: deploy/hosted -title: Getting Started -lastUpdated: 2025-10-18 -sidebar: - order: 1 +lastUpdated: 2025-10-21 --- There are multiple instances where hosting a Minecraft server in the cloud using "shared" hosting makes sense, for example: a Christmas Minecraft server with your friends, a small - medium sized communtiy server that can scale out to large networks the size of Hypixel and beyond with your own dedicated hardware. diff --git a/src/content/docs/extras/oracle.mdx b/src/content/docs/deploy/hosted/oracle.mdx similarity index 98% rename from src/content/docs/extras/oracle.mdx rename to src/content/docs/deploy/hosted/oracle.mdx index db90b56aad..01ee1b153d 100644 --- a/src/content/docs/extras/oracle.mdx +++ b/src/content/docs/deploy/hosted/oracle.mdx @@ -1,7 +1,7 @@ --- -description: A modified version of the guide produced by u/Belaboy1095969 on the Admincraft reddit using Ubuntu LTS. title: Oracle Cloud -slug: extra/oracle-cloud +description: A modified version of the guide produced by u/Belaboy1095969 on the Admincraft reddit using Ubuntu LTS. +lastUpdated: 2025-10-21 --- :::note @@ -163,7 +163,7 @@ cd minecraft-server-folder ... ``` -Now we can deploy the server jar we're wanting to use, this tutorial will reference [purpur](https://purpurmc.org) but there are plenty of other server platforms and [this page](/administer/server-software) explains the pros and cons of the major ones. +Now we can deploy the server jar we're wanting to use, this tutorial will reference [purpur](https://purpurmc.org) but there are plenty of other server platforms and [this page](/administration/server-software) explains the pros and cons of the major ones. ```bash ... diff --git a/src/content/docs/deploy/hosted/providers.mdx b/src/content/docs/deploy/hosted/providers.mdx index 096be5fda4..ed30a0f046 100644 --- a/src/content/docs/deploy/hosted/providers.mdx +++ b/src/content/docs/deploy/hosted/providers.mdx @@ -1,8 +1,7 @@ --- -description: This page should be used as a reference to hosting providers and is not a substitute for their trustpilot and / or other clients real world experiences. -slug: deploy/providers -title: Providers -lastUpdated: 2025-10-18 +title: Recommended Providers +description: This page should be used as a reference to hosting providers and is not a substitute for their trustpilot and/or other clients' real-world experiences. +lastUpdated: 2025-10-21 --- import { LinkCard, CardGrid } from '@astrojs/starlight/components'; diff --git a/src/content/docs/deploy/hosted/purchased-what-next.mdx b/src/content/docs/deploy/hosted/purchased-what-next.mdx index 4fd8e4b54a..cf5437ce8e 100644 --- a/src/content/docs/deploy/hosted/purchased-what-next.mdx +++ b/src/content/docs/deploy/hosted/purchased-what-next.mdx @@ -1,8 +1,7 @@ --- +title: Purchased, What Next? description: Helping you through those next steps immediately after you have purchased a Minecraft server. -slug: deploy/purchased-what-next -title: Purchased, what next? -lastUpdated: 2025-10-18 +lastUpdated: 2025-10-21 --- While we cannot make a purchase decision for you, if you selected from one of the hosting providers in our list here's what you can expect to happen next. diff --git a/src/content/docs/deploy/index.mdx b/src/content/docs/deploy/index.mdx new file mode 100644 index 0000000000..45cc2df2f4 --- /dev/null +++ b/src/content/docs/deploy/index.mdx @@ -0,0 +1,8 @@ +--- +title: Deployment +description: Learn how to set up and deploy your Minecraft server using various hosting options. +lastUpdated: 2025-10-21 +topic: deploy +--- + +Discover the different methods for deploying your Minecraft server, from self-hosting to professional services. \ No newline at end of file diff --git a/src/content/docs/extras/folia.mdx b/src/content/docs/extras/folia.mdx deleted file mode 100644 index b6bc9c3b49..0000000000 --- a/src/content/docs/extras/folia.mdx +++ /dev/null @@ -1,70 +0,0 @@ ---- -description: How to run test builds of folia without having pre-compiled JARs provided from PaperMC. -slug: extra/build-folia -title: Folia ---- - -It should be worth noting that everything in this document is provided "as-is" and does not guarantee any level of functionality for this product. You will also not be provided support for any Folia related issues outside of bug reports to the respective developers. - -You will need: - -- Git (or a clone of the [GitHub Repo](https://github.com/PaperMC/Folia)) -- Patience -- Time - -### Clone the Repo - -You can download a copy of Git from https://git-scm.com/downloads. If you're on a Mac you will most likely already have Git if you're downloaded `xcode-tools` from Terminal. - -Once you've downloaded Git from your preferred platform you now need to clone the directory, open a command prompt or terminal window and type one of the following command - -- Windows : `cd %username%/Desktop` -- Mac / Linux : `cd ~/Desktop` - -Now we're at the Desktop we can clone the repository into a new folder. - -```bash -... - -git clone https://github.com/PaperMC/Folia - -... -``` - ---- - -### Building JAR - -Now we have successfully cloned the Repo we need to apply the Folia patches, if you haven't already run the following command to move your Command Prompt / Terminal session into the Folia directory. - -```bash -... - -cd Folia/ - -... -``` - -We firstly need to apply the Folia patches using the following command - -```bash -... - -./gradlew applyPatches - -... -``` - -This process may take a few minutes depending on the speed of your computer, on a Mid-Range 2020 Macbook Pro it took 8 mins 40 sec. Once this process has completed we need to make the final JAR, this can be done using the following command. - -```bash -... - -./gradlew createReobfBundlerJar - -... -``` - -This build took us around 2 mins 1 sec to complete but YMMV. - -You can now use your file explorer to navigate to the newly created `builds/lib` folder and collect your newly compiled JAR file. diff --git a/src/content/docs/project/contribute.mdx b/src/content/docs/getting-started/contribute.mdx similarity index 97% rename from src/content/docs/project/contribute.mdx rename to src/content/docs/getting-started/contribute.mdx index b7a591dbd2..567a247b6f 100644 --- a/src/content/docs/project/contribute.mdx +++ b/src/content/docs/getting-started/contribute.mdx @@ -1,10 +1,7 @@ --- title: Contribute -slug: contribute description: We're an administration wiki for Minecraft server administrators who are looking to enhance their server experience. -lastUpdated: 2025-10-16 -sidebar: - position: 2 +lastUpdated: 2025-10-21 --- We're building the ultimate Minecraft documentation project and if you're interested in making things even better this is the page for you. diff --git a/src/content/docs/project/discord.mdx b/src/content/docs/getting-started/discord.mdx similarity index 97% rename from src/content/docs/project/discord.mdx rename to src/content/docs/getting-started/discord.mdx index 4bd2a41746..adc3db3495 100644 --- a/src/content/docs/project/discord.mdx +++ b/src/content/docs/getting-started/discord.mdx @@ -1,10 +1,7 @@ --- -description: We have a Discord server, check out the basics here. title: Discord Server -lastUpdated: 2025-10-16 -slug: discord -sidebar: - position: 1 +description: We have a Discord server, check out the basics here. +lastUpdated: 2025-10-21 --- All project contributors are volunteers and will have the `project contributor` role in our server. diff --git a/src/content/docs/getting-started/index.mdx b/src/content/docs/getting-started/index.mdx new file mode 100644 index 0000000000..07d36b7c60 --- /dev/null +++ b/src/content/docs/getting-started/index.mdx @@ -0,0 +1,10 @@ +--- +title: Getting Started +description: We're an administration wiki for Minecraft server administrators who are looking to enhance their server experience. +lastUpdated: 2025-10-21 +topic: getting-started +--- + +This is the setup.md wiki. We've collated some of our most useful information that anyone can use as a reference point for developing their Minecraft server. This wiki is primarily maintained by the wonderful Admincraft community, though we thank external contributors who have added to our project. + +We have attempted to cover all of the key areas when it comes to running a server. You can find these top-level categories on the left-hand side (minus guides, which are walkthroughs for deployment). \ No newline at end of file diff --git a/src/content/docs/project/jar-api.mdx b/src/content/docs/getting-started/jar-api.mdx similarity index 93% rename from src/content/docs/project/jar-api.mdx rename to src/content/docs/getting-started/jar-api.mdx index b6e4eb3a29..27efe692e5 100644 --- a/src/content/docs/project/jar-api.mdx +++ b/src/content/docs/getting-started/jar-api.mdx @@ -1,20 +1,13 @@ --- -description: The setup.md team provides their own Jar API for the most common server types. title: Jar API -lastUpdated: 2025-10-16 -slug: jar-api -sidebar: - position: 4 - badge: - text: FREE - variant: success +description: The setup.md team provides their own Jar API for the most common server types. +lastUpdated: 2025-10-21 --- import { LinkCard, CardGrid } from '@astrojs/starlight/components'; We took a cool idea produced by PenguiLoader on GitHub and we fixed some bugs then made it faster by distributing the workload to Cloudflare workers and running it on their amazing edge network. - | Quick Start | Example URLs | | :------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Base Domain | https://jar.setup.md | diff --git a/src/content/docs/project/license.mdx b/src/content/docs/getting-started/license.mdx similarity index 98% rename from src/content/docs/project/license.mdx rename to src/content/docs/getting-started/license.mdx index 2e2871d352..5740a537d2 100644 --- a/src/content/docs/project/license.mdx +++ b/src/content/docs/getting-started/license.mdx @@ -1,9 +1,7 @@ --- title: License description: We're licensed under the "Attribution Non-Commercial ShareAlike 4.0 International" model. -slug: license -sidebar: - position: 3 +lastUpdated: 2025-10-21 --- We're licensed under the **CC BY-NC-SA 4.0 license**. This page outlines what you can and cannot do with materials from our wiki. diff --git a/src/content/docs/extras/setup.md Lab/Core/ovh.mdx b/src/content/docs/getting-started/our-lab/core/ovh.mdx similarity index 99% rename from src/content/docs/extras/setup.md Lab/Core/ovh.mdx rename to src/content/docs/getting-started/our-lab/core/ovh.mdx index a7ca081733..32337fd9d9 100644 --- a/src/content/docs/extras/setup.md Lab/Core/ovh.mdx +++ b/src/content/docs/getting-started/our-lab/core/ovh.mdx @@ -1,7 +1,6 @@ --- sidebar_position: 1 description: Changes we needed to make within OVH in order for our setup to work as expected. -slug: lab/ovh title: OVH Setup --- diff --git a/src/content/docs/extras/setup.md Lab/Core/ports.mdx b/src/content/docs/getting-started/our-lab/core/ports.mdx similarity index 99% rename from src/content/docs/extras/setup.md Lab/Core/ports.mdx rename to src/content/docs/getting-started/our-lab/core/ports.mdx index 31d77bc02d..43ce4c2b6b 100644 --- a/src/content/docs/extras/setup.md Lab/Core/ports.mdx +++ b/src/content/docs/getting-started/our-lab/core/ports.mdx @@ -1,7 +1,6 @@ --- sidebar_position: 4 description: How to port forward to allow external access to services hosted within your virtual environment. -slug: lab/pforward title: Port Forwarding --- diff --git a/src/content/docs/extras/setup.md Lab/Core/proxmox.mdx b/src/content/docs/getting-started/our-lab/core/proxmox.mdx similarity index 99% rename from src/content/docs/extras/setup.md Lab/Core/proxmox.mdx rename to src/content/docs/getting-started/our-lab/core/proxmox.mdx index 0bb62eb9e3..e456326cad 100644 --- a/src/content/docs/extras/setup.md Lab/Core/proxmox.mdx +++ b/src/content/docs/getting-started/our-lab/core/proxmox.mdx @@ -1,7 +1,6 @@ --- sidebar_position: 2 description: How we configured Proxmox to work in the OVH bare metal cloud environment. -slug: lab/proxmox title: Proxmox Setup --- diff --git a/src/content/docs/extras/setup.md Lab/Core/remote.mdx b/src/content/docs/getting-started/our-lab/core/remote.mdx similarity index 99% rename from src/content/docs/extras/setup.md Lab/Core/remote.mdx rename to src/content/docs/getting-started/our-lab/core/remote.mdx index 29b506a217..2799c9186c 100644 --- a/src/content/docs/extras/setup.md Lab/Core/remote.mdx +++ b/src/content/docs/getting-started/our-lab/core/remote.mdx @@ -1,7 +1,6 @@ --- sidebar_position: 5 description: How we configured remote access to the internal network for our environment -slug: lab/remote title: Remote Access --- diff --git a/src/content/docs/extras/setup.md Lab/Core/vms.mdx b/src/content/docs/getting-started/our-lab/core/vms.mdx similarity index 99% rename from src/content/docs/extras/setup.md Lab/Core/vms.mdx rename to src/content/docs/getting-started/our-lab/core/vms.mdx index ff2e161260..f346ecd92d 100644 --- a/src/content/docs/extras/setup.md Lab/Core/vms.mdx +++ b/src/content/docs/getting-started/our-lab/core/vms.mdx @@ -1,7 +1,6 @@ --- sidebar_position: 3 description: How we configured Proxmox to work in the OVH bare metal cloud environment. -slug: lab/vms title: Virtual Machines --- diff --git a/src/content/docs/extras/setup.md Lab/intro.mdx b/src/content/docs/getting-started/our-lab/index.mdx similarity index 97% rename from src/content/docs/extras/setup.md Lab/intro.mdx rename to src/content/docs/getting-started/our-lab/index.mdx index 09e7b5140f..e4338f6b46 100644 --- a/src/content/docs/extras/setup.md Lab/intro.mdx +++ b/src/content/docs/getting-started/our-lab/index.mdx @@ -1,12 +1,7 @@ --- -sidebar: - order: 1 - badge: - text: PENDING UPDATE - variant: danger -description: A breakdown of how our contributor lab was deployed in the cloud. title: The Lab -slug: lab +description: A breakdown of how our contributor lab was deployed in the cloud. +lastUpdated: 2025-10-21 --- :::danger diff --git a/src/content/docs/extras/setup.md Lab/Optional/Configuration/aad.mdx b/src/content/docs/getting-started/our-lab/optional/configuration/aad.mdx similarity index 89% rename from src/content/docs/extras/setup.md Lab/Optional/Configuration/aad.mdx rename to src/content/docs/getting-started/our-lab/optional/configuration/aad.mdx index b15ba15a2b..c79e390d1f 100644 --- a/src/content/docs/extras/setup.md Lab/Optional/Configuration/aad.mdx +++ b/src/content/docs/getting-started/our-lab/optional/configuration/aad.mdx @@ -1,5 +1,4 @@ --- -description: How we use Entra ID to manage authentication in a Modern zero trust environment. -slug: lab/aad title: Entra ID +description: How we use Entra ID to manage authentication in a Modern zero trust environment. --- diff --git a/src/content/docs/extras/setup.md Lab/Optional/Configuration/azure.mdx b/src/content/docs/getting-started/our-lab/optional/configuration/azure.mdx similarity index 99% rename from src/content/docs/extras/setup.md Lab/Optional/Configuration/azure.mdx rename to src/content/docs/getting-started/our-lab/optional/configuration/azure.mdx index 39bcc6ae9e..20fbe0bb35 100644 --- a/src/content/docs/extras/setup.md Lab/Optional/Configuration/azure.mdx +++ b/src/content/docs/getting-started/our-lab/optional/configuration/azure.mdx @@ -1,7 +1,6 @@ --- -description: How to setup, configure and deploy Azure Arc for patch management. -slug: lab/arc title: Azure Arc +description: How to setup, configure and deploy Azure Arc for patch management. --- Azure is a wonderful platform and everything we are currently doing in Azure could be done with either group policy or standalone packages within linux. Azure was chosen due to it already being apart of our product stack for Azure AD authentication and it's universal. diff --git a/src/content/docs/extras/setup.md Lab/Optional/Configuration/hardening.mdx b/src/content/docs/getting-started/our-lab/optional/configuration/hardening.mdx similarity index 99% rename from src/content/docs/extras/setup.md Lab/Optional/Configuration/hardening.mdx rename to src/content/docs/getting-started/our-lab/optional/configuration/hardening.mdx index e3565f3599..704095ff5d 100644 --- a/src/content/docs/extras/setup.md Lab/Optional/Configuration/hardening.mdx +++ b/src/content/docs/getting-started/our-lab/optional/configuration/hardening.mdx @@ -1,11 +1,6 @@ --- -description: Device hardening guide and and explantion of the tools used to complete such activities. -slug: lab/hardening title: Hardening -sidebar: - badge: - text: Recommended - variant: tip +description: Device hardening guide and and explantion of the tools used to complete such activities. --- This document is designed specifcally for those who want to tighten up windows and add some preventative measures to lock down their machine, it should be made known that the more you lock down a machine the less functionality it will have. diff --git a/src/content/docs/extras/setup.md Lab/Optional/Services/docker.mdx b/src/content/docs/getting-started/our-lab/optional/services/docker.mdx similarity index 99% rename from src/content/docs/extras/setup.md Lab/Optional/Services/docker.mdx rename to src/content/docs/getting-started/our-lab/optional/services/docker.mdx index a913ce6f4b..ea3181c6f2 100644 --- a/src/content/docs/extras/setup.md Lab/Optional/Services/docker.mdx +++ b/src/content/docs/getting-started/our-lab/optional/services/docker.mdx @@ -1,7 +1,6 @@ --- -description: Our Docker environment and how we use containerisation. -slug: lab/docker title: Docker +description: Our Docker environment and how we use containerisation. --- The purpose of this document is to outline the build of our Docker LXC that we use internally to host our services and manage them with Portainer. While for us Docker is a core essential part of our network everything completed in our Lab tutorials can be put in it's own Virtual Machine without too much more additional effort minus system management. diff --git a/src/content/docs/extras/setup.md Lab/Optional/Services/maas.mdx b/src/content/docs/getting-started/our-lab/optional/services/maas.mdx similarity index 99% rename from src/content/docs/extras/setup.md Lab/Optional/Services/maas.mdx rename to src/content/docs/getting-started/our-lab/optional/services/maas.mdx index d97990412f..71f5e46bb3 100644 --- a/src/content/docs/extras/setup.md Lab/Optional/Services/maas.mdx +++ b/src/content/docs/getting-started/our-lab/optional/services/maas.mdx @@ -1,7 +1,6 @@ --- -description: Learn how to setup a PXE boot environment and save time on all new VMs -slug: lab/maas title: Ubuntu MaaS +description: Learn how to setup a PXE boot environment and save time on all new VMs --- When it comes to your LAB spinning up and spinning down VMs becomes part of the job, the most common problem you'll face is deploying VM and finding out you have an old ISO that needs a multiple patches before it's fit for business. This is where MAAS or 'Machines as a Service' come in, it's a product developed by the Ubuntu team allows you to deploy a management environment for all of your network bootable devices. Right out of the box MAAS ensures your images remain up-to-date and periodically will fetch the latest ISOs from their respective download locations. diff --git a/src/content/docs/extras/setup.md Lab/Optional/Services/macos.mdx b/src/content/docs/getting-started/our-lab/optional/services/macos.mdx similarity index 96% rename from src/content/docs/extras/setup.md Lab/Optional/Services/macos.mdx rename to src/content/docs/getting-started/our-lab/optional/services/macos.mdx index d275fc717e..436cc8be80 100644 --- a/src/content/docs/extras/setup.md Lab/Optional/Services/macos.mdx +++ b/src/content/docs/getting-started/our-lab/optional/services/macos.mdx @@ -1,7 +1,6 @@ --- -description: Deploying a macOS virtual machine inside of Proxmox. -slug: lab/mac title: MacOS +description: Deploying a macOS virtual machine inside of Proxmox. --- One of the reasons the Intel based servers were chosen is due to the requirement of macOS, in the past any attempts to run macOS on AMD based CPUs has proven difficult in both Physical and Virtual environments. diff --git a/src/content/docs/extras/setup.md Lab/Optional/Services/uptimekuma.mdx b/src/content/docs/getting-started/our-lab/optional/services/uptimekuma.mdx similarity index 88% rename from src/content/docs/extras/setup.md Lab/Optional/Services/uptimekuma.mdx rename to src/content/docs/getting-started/our-lab/optional/services/uptimekuma.mdx index 208d048aaa..3fb6efee11 100644 --- a/src/content/docs/extras/setup.md Lab/Optional/Services/uptimekuma.mdx +++ b/src/content/docs/getting-started/our-lab/optional/services/uptimekuma.mdx @@ -1,7 +1,6 @@ --- -description: Learn how to setup a PXE boot environment and save time on all new VMs -slug: lab/monitoring title: Uptime Kuma +description: Learn how to setup a PXE boot environment and save time on all new VMs --- Knowing when your services go down is a must, you have multiple options when it comes to this requirement either in the form of SaaS or self-hosted. In following on with the nature of this project a self-hosted instance will be deployed. @@ -16,11 +15,9 @@ If you're completely new to monitoring products Uptime Kuma is basically a self- ### Deploying in Docker -You can conver the docker run command from the github repo to a compose file manually or you can use the one below. +You can convert the docker run command from the github repo to a compose file manually or you can use the one below. ```yml -... - version: '3.8' services: @@ -35,12 +32,8 @@ services: volumes: uptime-kuma: - -... ``` You should save the above configuration file as `docker-compose.yml`. You can run the command `docker-compose up -d` from your terminal window to spin up the instance. - - diff --git a/src/content/docs/extras/setup.md Lab/Optional/Services/Zero Trust/cloudflare.mdx b/src/content/docs/getting-started/our-lab/optional/services/zero-trust/cloudflare.mdx similarity index 99% rename from src/content/docs/extras/setup.md Lab/Optional/Services/Zero Trust/cloudflare.mdx rename to src/content/docs/getting-started/our-lab/optional/services/zero-trust/cloudflare.mdx index 0f97b8723e..7db0511d72 100644 --- a/src/content/docs/extras/setup.md Lab/Optional/Services/Zero Trust/cloudflare.mdx +++ b/src/content/docs/getting-started/our-lab/optional/services/zero-trust/cloudflare.mdx @@ -1,7 +1,6 @@ --- -description: A step-by-step walk through of how to configure the Cloudflare dashboard in preparation for using Zero-Trust tunnels. -slug: lab/cloudflare title: Cloudflare One +description: A step-by-step walk through of how to configure the Cloudflare dashboard in preparation for using Zero-Trust tunnels. --- This guide makes the following assumptions diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index 4b0aa9e8e5..119390d818 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -5,10 +5,10 @@ template: splash hero: tagline: setup.md - Your home for Minecraft server administration. image: - file: '@assets/bookshelf.png' + file: '@assets/logos/bookshelf.png' actions: - text: View the docs - link: /contribute + link: /getting-started icon: right-arrow variant: primary - text: Visit us on GitHub! diff --git a/src/content/docs/troubleshoot/compute/java.mdx b/src/content/docs/troubleshooting/compute/java.mdx similarity index 99% rename from src/content/docs/troubleshoot/compute/java.mdx rename to src/content/docs/troubleshooting/compute/java.mdx index 54d254f737..1e2ae1cea1 100644 --- a/src/content/docs/troubleshoot/compute/java.mdx +++ b/src/content/docs/troubleshooting/compute/java.mdx @@ -1,8 +1,9 @@ --- -description: Understand and troubleshoot some of the most common issues with Java when setting up your Minecraft server. -slug: fix/java title: Java +description: Understand and troubleshoot some of the most common issues with Java when setting up your Minecraft server. +lastUpdated: 2025-10-21 --- + Sometimes you can have issues at the first hurdle, getting your server to boot. Some of these issues are to do with your Java deployment and we will cover some quick fixes to get you up and running. ### Missing PATH variable diff --git a/src/content/docs/troubleshooting/index.mdx b/src/content/docs/troubleshooting/index.mdx new file mode 100644 index 0000000000..4f2dfe9eb6 --- /dev/null +++ b/src/content/docs/troubleshooting/index.mdx @@ -0,0 +1,8 @@ +--- +title: Troubleshooting +description: Solutions for common Minecraft server problems and issues that administrators face. +lastUpdated: 2025-10-21 +topic: troubleshooting +--- + +Server issues happen to everyone. This section provides solutions for common problems you might encounter while running your Minecraft server. \ No newline at end of file diff --git a/src/content/docs/troubleshoot/network/connectivity.mdx b/src/content/docs/troubleshooting/network/connectivity.mdx similarity index 97% rename from src/content/docs/troubleshoot/network/connectivity.mdx rename to src/content/docs/troubleshooting/network/connectivity.mdx index ea0182d1c0..e8ba926b6e 100644 --- a/src/content/docs/troubleshoot/network/connectivity.mdx +++ b/src/content/docs/troubleshooting/network/connectivity.mdx @@ -1,10 +1,10 @@ --- -description: A foundation for checking connectivity issues with your Minecraft server. -slug: fix/connectivity title: Connectivity -lastUpdated: 2023-12-16 +description: A foundation for checking connectivity issues with your Minecraft server. +lastUpdated: 2025-10-21 --- +import { Image } from 'astro:assets'; import { LinkCard, CardGrid } from '@astrojs/starlight/components'; If you're having trouble connecting to your Minecraft server there's a process you should follow in order to try and understand where the issue lies. If you're running on a third party hosting provider it's recommended to reach out to them directly or check their status page. @@ -167,4 +167,4 @@ When you create the record you should ensure it's configured as follows: An example of a functional SRV record has been provided below, this was created in Cloudflare's DNS manager so if Cloudflare is not your DNS solution then you may have a slightly different interface. - +Cloudflare SRV Record diff --git a/src/content/docs/troubleshoot/network/latency.mdx b/src/content/docs/troubleshooting/network/latency.mdx similarity index 92% rename from src/content/docs/troubleshoot/network/latency.mdx rename to src/content/docs/troubleshooting/network/latency.mdx index f8b2bc7101..91436d54bf 100644 --- a/src/content/docs/troubleshoot/network/latency.mdx +++ b/src/content/docs/troubleshooting/network/latency.mdx @@ -1,13 +1,15 @@ --- -description: Understand latency and how it can play a part in the user experience of your Minecraft server. -slug: fix/latency title: Latency -lastUpdated: 2023-12-16 +description: Understand latency and how it can play a part in the user experience of your Minecraft server. +lastUpdated: 2025-10-21 --- -If you've ever run a server, played on a server or you're Australian then the phrase "IT'S LAAAAAAAAAAAAAAAGING" probably sounds familiar. +import { Image } from 'astro:assets'; +import fixServerLagNoob from '../../../../assets/images/fix-server-lag-noob.png'; + +If you've ever run a server, played on a server or you're Australian then the phrase "IT'S LAAAAAAAAAAAAAAAGGING" probably sounds familiar. - +Yapping Crow Meme Unfortunately this isn't always something that's easily correctable, providing you've ensured the issue isn't related to your hardware the server runs on then you should consider the network and primarily latency. diff --git a/src/content/docs/troubleshoot/network/nat-cgnat.mdx b/src/content/docs/troubleshooting/network/nat.mdx similarity index 99% rename from src/content/docs/troubleshoot/network/nat-cgnat.mdx rename to src/content/docs/troubleshooting/network/nat.mdx index cef108888b..0b3990e077 100644 --- a/src/content/docs/troubleshoot/network/nat-cgnat.mdx +++ b/src/content/docs/troubleshooting/network/nat.mdx @@ -1,8 +1,7 @@ --- -description: One of the core fundamentals of networking, this page outlines the types of addresses you will come across and how you can work around them. -slug: fix/nat title: NAT / CG-NAT -lastUpdated: 2023-12-16 +description: One of the core fundamentals of networking, this page outlines the types of addresses you will come across and how you can work around them. +lastUpdated: 2025-10-21 --- Every connected device has an IP address, similar to how every mobile phone also has a mobile number and we use this number to reference "hey, this is me... you can find me here". Similarly to phone numbers, when it comes to IP addresses we have two different types for internal (private networks) and external (public networks) usage. diff --git a/src/content/docs/extras/tunnels.mdx b/src/content/docs/troubleshooting/network/tunnels.mdx similarity index 99% rename from src/content/docs/extras/tunnels.mdx rename to src/content/docs/troubleshooting/network/tunnels.mdx index 88613a7634..43805cb52c 100644 --- a/src/content/docs/extras/tunnels.mdx +++ b/src/content/docs/troubleshooting/network/tunnels.mdx @@ -1,7 +1,6 @@ --- -slug: extra/tunnels -description: Using tunnels to host without port forwarding title: Tunnels +description: Using tunnels to host without port forwarding lastUpdated: 2025-10-19 --- diff --git a/tailwind.config.mjs b/tailwind.config.mjs index 1edc224d68..c3d9d5c8f9 100644 --- a/tailwind.config.mjs +++ b/tailwind.config.mjs @@ -1,7 +1,7 @@ /** @type {import('tailwindcss').Config} */ export default { darkMode: "class", - content: ["./src/**/*.{astro,html,js,jsx,svelte,ts,tsx,vue,mdx}"], + content: ["./src/**/*.{astro,html,js,jsx,svelte,ts,tsx,mdx}"], theme: { extend: {}, },