Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,24 @@ import vue from "@astrojs/vue";
import tailwind from "@astrojs/tailwind";
import starlightThemeObsidian from "starlight-theme-obsidian";
import sitemap from "@astrojs/sitemap";
import path from "node:path";

// https://astro.build/config
export default defineConfig({
site: "https://www.setup.md",
trailingSlash: "never",
vite: {
resolve: {
alias: {
"@components": path.resolve("./src/components"),
"@content": path.resolve("./src/content"),
"@assets": path.resolve("./src/assets"),
"@styles": path.resolve("./src/styles"),
"@fonts": path.resolve("./src/fonts"),
"@utils": path.resolve("./src/utils"),
}
}
},
build: {
format: "file",
},
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Anti-X Tools/anticheat.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Anti-Cheats
lastUpdated: 2024-02-25
---

import MainStatusPill from '../../../../components/MainStatusPill.vue';
import MainStatusPill from '@components/MainStatusPill.vue';
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

:::info
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Anti-X Tools/antiexploit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Anti-Exploit
lastUpdated: 2024-02-25
---

import MainStatusPill from '../../../../components/MainStatusPill.vue';
import MainStatusPill from '@components/MainStatusPill.vue';
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

Anti-Exploit plugins resolve issues such as crashes, dupes, abusive NBT etc.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Anti-X Tools/antilag.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Anti-Lag
lastUpdated: 2024-02-25
---

import MainStatusPill from '../../../../components/MainStatusPill.vue';
import MainStatusPill from '@components/MainStatusPill.vue';
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

Below is a list of tools and optimisations you can use to identify and mitigate TPS (server) lag.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Anti-X Tools/antixray.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: e/anti-x/ax
title: Anti-Xray
lastUpdated: 2024-02-25
---
import MainStatusPill from '../../../../components/MainStatusPill.vue';
import MainStatusPill from '@components/MainStatusPill.vue';
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

As the name suggests, Anti-Xray will prevent players from finding ores using Xray clients/resource packs. This is done by sending packets to the player where all of the ores are replaced by stone. The ores only appear if the player establishes direct visual contact with them/updates them. Two of the most common Anti-Xray plugins are shown below:
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Anti-X Tools/intro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Understand the types of 'preventative' tools that exist for Minecra
title: Introduction
---

import MainStatusPill from '../../../../components/MainStatusPill.vue';
import MainStatusPill from '@components/MainStatusPill.vue';
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

Minecraft is an open game by nature and as great as that is, it doesn't always work in every servers favour and sometimes they need to make changes in order to restrict certain aspects of gameplay for any number of multiple reasons.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Plugins/Free/MiniMOTD.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: MiniMOTD
lastUpdated: 2024-01-01
---

import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: e/pl/auctionhouse
title: AuctionHouse
lastUpdated: 2024-01-01
---
import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Plugins/Free/chestshop.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: ChestShop
lastUpdated: 2024-01-01
---

import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Plugins/Free/discordsrv.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: DiscordSRV
lastUpdated: 2024-01-01
---

import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Plugins/Free/dukesmart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: DukesMart
lastUpdated: 2024-01-01
---

import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Plugins/Free/essentialsx.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar:
variant: success
---

import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Plugins/Free/luckperms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar:
variant: success
---

import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: e/pl/playerauctions
title: PlayerAuctions
lastUpdated: 2024-01-01
---
import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Plugins/Free/playershops.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: e/pl/playershops
title: PlayerShops (BSP)
lastUpdated: 2024-01-01
---
import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Plugins/Free/powerranks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar:
variant: success
---

import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Plugins/Free/quickshop.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Quick Shop Remake
lastUpdated: 2024-01-01
---

import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Ultimate Timber
lastUpdated: 2024-01-01
---

import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Plugins/Free/vault.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar:
text: Essential
variant: success
---
import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Plugins/Free/worldedit.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar:
variant: success
---

import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Plugins/Free/worldguard.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar:
variant: success
---

import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Plugins/Free/znpc.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: ZPNCs
lastUpdated: 2024-01-01
---

import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Plugins/Premium/citizens.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: e/pl/citizens
title: Citizens
lastUpdated: 2024-01-01
---
import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/enhancements/Plugins/Premium/litebans.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar:
variant: tip
---

import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: e/pl/zauctionhouse
title: zAuctionHouse
lastUpdated: 2024-01-01
---
import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

#### This enhancement supports
Expand Down
20 changes: 19 additions & 1 deletion src/content/docs/guides/Minecraft/Optimisation/advanced.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar:
order: 3
---

import MainStatusPill from '../../../../../components/MainStatusPill.vue';
import MainStatusPill from '@components/MainStatusPill.vue';
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

This section covers plugins that you can modify/replace to improve performance. Only recommended at higher player counts.
Expand Down Expand Up @@ -39,6 +39,24 @@ Although TAB is already well-optimised, there are still some modifications you c

---

#### FancyHolograms (or other Hologram Plugins)
Ensure that your holograms are being refreshed at a reasonable interval. `updateTextInterval` in FancyHolograms is measured in ticks, so setting it to any value below `1000` will cause excessive load on the CPU.

For Leaderboards, we recommend setting it to at least `30000`. For static holograms, `-1` will result in no updates.

---

#### FancyGlow
If you happen to be using FancyGlow, make sure to disable it's TAB integration since it sends an obscene amount of packets.
Instead, use `%fancyglow_color%` within TAB's groups.yml in `tagprefix`. For example:
```yaml
_DEFAULT_:
tabprefix: "%luckperms-prefix%"
tagprefix: "%luckperms-prefix%%fancyglow_color%"
```

---

#### ProtocolLib & it's Dependants
ProtocolLib is not very well optimised. Lots of plugins also abuse ProtocolLib a lot, causing even worse performance. Examples are DeluxeCombat (If ProtocolLib hook is enabled) and InteractiveChat. Removal has resulted in significantly better performance in all large servers.

Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/guides/Minecraft/Optimisation/basic.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ sidebar:
order: 2
---

import MainStatusPill from '../../../../../components/MainStatusPill.vue';
import MainStatusPill from '@components/MainStatusPill.vue';
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

Most servers will only ever need a basic degree of optimisation. Please note that certain optimisations can alter vanilla gameplay mechanics.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/guides/Minecraft/Plugins/terra.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Terra World Generation
lastUpdated: 2024-03-04
---

import MainStatusPill from '../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

The setup.md wiki provides Terra worlds available for download monthly, the principle of this guide can be used in situations with / without our pre-provided files if you wish to generate things for yourself.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ sidebar:
variant: success
lastUpdated: 2024-10-12
---
import MainStatusPill from '../../../../../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

If you're looking to get more out of your Minecraft panel experience (and you're hosting the panel yourself) then you can look towards third party modifications in order to do this.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/guides/Minecraft/sftp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: guides/using-sftp
title: Using SFTP
lastUpdated: 2024-08-10
---
import MainStatusPill from '../../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
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,
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/hosting/panels.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ slug: h/ui
title: Panels
---

import MainStatusPill from '../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { 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](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).
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/hosting/tls.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ title: TLS
lastUpdated: 2024-01-01
---

import MainStatusPill from '../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

If you're hosting more than just your Minecraft server, maybe you're using a Map service / forum / server store an SSL / TLS certificate is an absolute must.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ template: splash
hero:
tagline: Your home of good information written by enthusiasts for the novice Minecraft server owner.
image:
file: ../../assets/houston.webp
file: '@assets/houston.webp'
actions:
- text: View the docs
link: /docs
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/information/services.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ sidebar:
order: 2
---

import MainStatusPill from '../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';

As time has progressed we've continued to identify ways we can help server owners get up and running, setup.md has launched some additional services to help make your life easier.
Expand Down
4 changes: 2 additions & 2 deletions src/content/docs/jarapi.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ slug: service/jar-api
hero:
tagline: An API to easily grab popular Minecraft server software.
image:
file: ../../assets/javaicon.png
file: '@assets/javaicon.png'
actions:
- text: Source Code
link: https://github.com/setupmd/server-jar-api
icon: github
variant: primary
---

import MainStatusPill from '../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { LinkCard, CardGrid } from '@astrojs/starlight/components';
2 changes: 1 addition & 1 deletion src/content/docs/tools/server-software.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Server Software
lastUpdated: 2024-03-27
---

import MainStatusPill from '../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { 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.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/tools/signed-chat.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Signed Chat
slug: t/signed-chat
---

import MainStatusPill from '../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
import { 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.
Expand Down
2 changes: 1 addition & 1 deletion src/content/docs/troubleshooting/connectivity.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Connectivity
lastUpdated: 2023-12-16
---

import MainStatusPill from '../../../components/MainStatusPill.vue'
import MainStatusPill from '@components/MainStatusPill.vue'
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.
Expand Down
1 change: 1 addition & 0 deletions src/env.d.ts
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
/// <reference path="../.astro/types.d.ts" />
/// <reference path="/@components.astro/types.d.ts" />
/// <reference types="astro/client" />
Loading