diff --git a/.astro/types.d.ts b/.astro/types.d.ts index d444aaa473..39fbd736c9 100644 --- a/.astro/types.d.ts +++ b/.astro/types.d.ts @@ -19,8 +19,6 @@ declare module 'astro:content' { } declare module 'astro:content' { - export { z } from 'astro/zod'; - type Flatten = T extends { [K: string]: infer U } ? U : never; export type CollectionKey = keyof AnyEntryMap; @@ -29,53 +27,6 @@ declare module 'astro:content' { export type ContentCollectionKey = keyof ContentEntryMap; export type DataCollectionKey = keyof DataEntryMap; - // This needs to be in sync with ImageMetadata - export type ImageFunction = () => import('astro/zod').ZodObject<{ - src: import('astro/zod').ZodString; - width: import('astro/zod').ZodNumber; - height: import('astro/zod').ZodNumber; - format: import('astro/zod').ZodUnion< - [ - import('astro/zod').ZodLiteral<'png'>, - import('astro/zod').ZodLiteral<'jpg'>, - import('astro/zod').ZodLiteral<'jpeg'>, - import('astro/zod').ZodLiteral<'tiff'>, - import('astro/zod').ZodLiteral<'webp'>, - import('astro/zod').ZodLiteral<'gif'>, - import('astro/zod').ZodLiteral<'svg'>, - import('astro/zod').ZodLiteral<'avif'>, - ] - >; - }>; - - type BaseSchemaWithoutEffects = - | import('astro/zod').AnyZodObject - | import('astro/zod').ZodUnion<[BaseSchemaWithoutEffects, ...BaseSchemaWithoutEffects[]]> - | import('astro/zod').ZodDiscriminatedUnion - | import('astro/zod').ZodIntersection; - - type BaseSchema = - | BaseSchemaWithoutEffects - | import('astro/zod').ZodEffects; - - export type SchemaContext = { image: ImageFunction }; - - type DataCollectionConfig = { - type: 'data'; - schema?: S | ((context: SchemaContext) => S); - }; - - type ContentCollectionConfig = { - type?: 'content'; - schema?: S | ((context: SchemaContext) => S); - }; - - type CollectionConfig = ContentCollectionConfig | DataCollectionConfig; - - export function defineCollection( - input: CollectionConfig - ): CollectionConfig; - type AllValuesOf = T extends any ? T[keyof T] : never; type ValidContentEntrySlug = AllValuesOf< ContentEntryMap[C] @@ -165,11 +116,11 @@ declare module 'astro:content' { ? { collection: C; slug: ValidContentEntrySlug; - } + } : { collection: C; id: keyof DataEntryMap[C]; - } + } >; // Allow generic `string` to avoid excessive type errors in the config // if `dev` is not running to update as you edit. @@ -190,661 +141,663 @@ declare module 'astro:content' { slug: "about"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Anti-X Tools/anticheat.mdx": { id: "enhancements/Anti-X Tools/anticheat.mdx"; slug: "e/anti-x/ac"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Anti-X Tools/antiexploit.mdx": { id: "enhancements/Anti-X Tools/antiexploit.mdx"; slug: "e/anti-x/ae"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Anti-X Tools/antilag.mdx": { id: "enhancements/Anti-X Tools/antilag.mdx"; slug: "e/anti-x/al"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Anti-X Tools/antixray.mdx": { id: "enhancements/Anti-X Tools/antixray.mdx"; slug: "e/anti-x/ax"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Anti-X Tools/intro.mdx": { id: "enhancements/Anti-X Tools/intro.mdx"; slug: "e/anti-x"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Economy/chest.mdx": { id: "enhancements/Economy/chest.mdx"; slug: "e/eco/chest"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Economy/gui.mdx": { id: "enhancements/Economy/gui.mdx"; slug: "e/eco/gui"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Economy/intro.mdx": { id: "enhancements/Economy/intro.mdx"; slug: "e/eco"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Economy/shop.mdx": { id: "enhancements/Economy/shop.mdx"; slug: "e/eco/shop"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Permissions/breakdown.mdx": { id: "enhancements/Permissions/breakdown.mdx"; slug: "e/perms"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Permissions/plugins.mdx": { id: "enhancements/Permissions/plugins.mdx"; slug: "e/perms/plugins"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Plugins/Free/auctionhouse.mdx": { id: "enhancements/Plugins/Free/auctionhouse.mdx"; slug: "e/pl/auctionhouse"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Plugins/Free/chestshop.mdx": { id: "enhancements/Plugins/Free/chestshop.mdx"; slug: "e/pl/chestshop"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Plugins/Free/discordsrv.mdx": { id: "enhancements/Plugins/Free/discordsrv.mdx"; slug: "e/pl/discordsrv"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Plugins/Free/dukesmart.mdx": { id: "enhancements/Plugins/Free/dukesmart.mdx"; slug: "e/pl/dukesmart"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Plugins/Free/essentialsx.mdx": { id: "enhancements/Plugins/Free/essentialsx.mdx"; slug: "e/pl/essentialsx"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Plugins/Free/luckperms.mdx": { id: "enhancements/Plugins/Free/luckperms.mdx"; slug: "e/pl/luckperms"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Plugins/Free/minimotd.mdx": { id: "enhancements/Plugins/Free/minimotd.mdx"; slug: "e/pl/minimotd"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Plugins/Free/playerauctions.mdx": { id: "enhancements/Plugins/Free/playerauctions.mdx"; slug: "e/pl/playerauctions"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Plugins/Free/playershops.mdx": { id: "enhancements/Plugins/Free/playershops.mdx"; slug: "e/pl/playershops"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Plugins/Free/quickshop.mdx": { id: "enhancements/Plugins/Free/quickshop.mdx"; slug: "e/pl/quickshop"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Plugins/Free/ultimatetimber.mdx": { id: "enhancements/Plugins/Free/ultimatetimber.mdx"; slug: "e/pl/ultimatetimber"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Plugins/Free/vault.mdx": { id: "enhancements/Plugins/Free/vault.mdx"; slug: "e/pl/vault"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Plugins/Free/worldedit.mdx": { id: "enhancements/Plugins/Free/worldedit.mdx"; slug: "e/pl/worldedit"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Plugins/Free/worldguard.mdx": { id: "enhancements/Plugins/Free/worldguard.mdx"; slug: "e/pl/worldguard"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Plugins/Free/znpc.mdx": { id: "enhancements/Plugins/Free/znpc.mdx"; slug: "e/pl/znpc"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Plugins/Premium/citizens.mdx": { id: "enhancements/Plugins/Premium/citizens.mdx"; slug: "e/pl/citizens"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Plugins/Premium/litebans.mdx": { id: "enhancements/Plugins/Premium/litebans.mdx"; slug: "e/pl/litebans"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Plugins/Premium/zauctionhouse.mdx": { id: "enhancements/Plugins/Premium/zauctionhouse.mdx"; slug: "e/pl/zauctionhouse"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "enhancements/Plugins/intro.mdx": { id: "enhancements/Plugins/intro.mdx"; slug: "e/pl"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Minecraft/Optimisation/advanced.mdx": { id: "guides/Minecraft/Optimisation/advanced.mdx"; slug: "guides/optimisation/advanced"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Minecraft/Optimisation/basic.mdx": { id: "guides/Minecraft/Optimisation/basic.mdx"; slug: "guides/optimisation/basic"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Minecraft/Optimisation/intro.mdx": { id: "guides/Minecraft/Optimisation/intro.mdx"; slug: "guides/optimisation"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Minecraft/Plugins/Cinema Mod/commands.mdx": { id: "guides/Minecraft/Plugins/Cinema Mod/commands.mdx"; slug: "guides/cinemamod/commands"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Minecraft/Plugins/Cinema Mod/intro.mdx": { id: "guides/Minecraft/Plugins/Cinema Mod/intro.mdx"; slug: "guides/cinemamod"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Minecraft/Plugins/Cinema Mod/setup.mdx": { id: "guides/Minecraft/Plugins/Cinema Mod/setup.mdx"; slug: "guides/cinemanod/setup"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Minecraft/Plugins/Dynmap/intro.mdx": { id: "guides/Minecraft/Plugins/Dynmap/intro.mdx"; slug: "guides/dynmap"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Minecraft/Plugins/Dynmap/proxy.mdx": { id: "guides/Minecraft/Plugins/Dynmap/proxy.mdx"; slug: "guides/dynmap/proxy"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Minecraft/Plugins/Dynmap/setup.mdx": { id: "guides/Minecraft/Plugins/Dynmap/setup.mdx"; slug: "guides/dynmap/setup"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Minecraft/Plugins/luckperms.mdx": { id: "guides/Minecraft/Plugins/luckperms.mdx"; slug: "guides/luckperms"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Minecraft/Self-Host/Panels/Pterodactyl/intro.mdx": { id: "guides/Minecraft/Self-Host/Panels/Pterodactyl/intro.mdx"; slug: "guides/pterodactyl"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Minecraft/Self-Host/Panels/Pterodactyl/node.mdx": { id: "guides/Minecraft/Self-Host/Panels/Pterodactyl/node.mdx"; slug: "guides/pterodactyl/node"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Minecraft/Self-Host/Panels/Pterodactyl/panel.mdx": { id: "guides/Minecraft/Self-Host/Panels/Pterodactyl/panel.mdx"; slug: "guides/pterodactyl/panel"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Minecraft/Self-Host/Panels/Pterodactyl/wings.mdx": { id: "guides/Minecraft/Self-Host/Panels/Pterodactyl/wings.mdx"; slug: "guides/pterodactyl/wings"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Minecraft/Self-Host/Panels/Pufferpanel/installation.mdx": { id: "guides/Minecraft/Self-Host/Panels/Pufferpanel/installation.mdx"; slug: "guides/pufferpanel"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Minecraft/Self-Host/Panels/Pufferpanel/ssl.mdx": { id: "guides/Minecraft/Self-Host/Panels/Pufferpanel/ssl.mdx"; slug: "guides/pufferpanel/ssl"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Minecraft/Self-Host/Standalone (Java)/docker.mdx": { id: "guides/Minecraft/Self-Host/Standalone (Java)/docker.mdx"; slug: "guides/self-host/docker"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Minecraft/Self-Host/Standalone (Java)/linux.mdx": { id: "guides/Minecraft/Self-Host/Standalone (Java)/linux.mdx"; slug: "guides/self-host/linux"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Minecraft/Self-Host/Standalone (Java)/win.mdx": { id: "guides/Minecraft/Self-Host/Standalone (Java)/win.mdx"; slug: "guides/self-host/win"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/OVH/Core/ovh.mdx": { id: "guides/OVH/Core/ovh.mdx"; slug: "guides/lab/ovh"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/OVH/Core/ports.mdx": { id: "guides/OVH/Core/ports.mdx"; slug: "guides/lab/pforward"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/OVH/Core/proxmox.mdx": { id: "guides/OVH/Core/proxmox.mdx"; slug: "guides/lab/proxmox"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/OVH/Core/remote.mdx": { id: "guides/OVH/Core/remote.mdx"; slug: "guides/lab/remote"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/OVH/Core/vms.mdx": { id: "guides/OVH/Core/vms.mdx"; slug: "guides/lab/vms"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/OVH/Optional/Configuration/aad.mdx": { id: "guides/OVH/Optional/Configuration/aad.mdx"; slug: "guides/lab/aad"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/OVH/Optional/Configuration/azure.mdx": { id: "guides/OVH/Optional/Configuration/azure.mdx"; slug: "guides/lab/arc"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/OVH/Optional/Configuration/hardening.mdx": { id: "guides/OVH/Optional/Configuration/hardening.mdx"; slug: "guides/lab/hardening"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/OVH/Optional/Services/Zero Trust/cloudflare.mdx": { id: "guides/OVH/Optional/Services/Zero Trust/cloudflare.mdx"; slug: "guides/lab/cloudflare"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/OVH/Optional/Services/docker.mdx": { id: "guides/OVH/Optional/Services/docker.mdx"; slug: "guides/lab/docker"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/OVH/Optional/Services/maas.mdx": { id: "guides/OVH/Optional/Services/maas.mdx"; slug: "guides/lab/maas"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/OVH/Optional/Services/macos.mdx": { id: "guides/OVH/Optional/Services/macos.mdx"; slug: "guides/lab/mac"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/OVH/Optional/Services/uptimekuma.mdx": { id: "guides/OVH/Optional/Services/uptimekuma.mdx"; slug: "guides/lab/monitoring"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/OVH/intro.mdx": { id: "guides/OVH/intro.mdx"; slug: "guides/lab"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Services/TLS/intro.mdx": { id: "guides/Services/TLS/intro.mdx"; slug: "guides/ssl"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Services/TLS/tools.mdx": { id: "guides/Services/TLS/tools.mdx"; slug: "guides/ssl/tools"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Services/domainpark.mdx": { id: "guides/Services/domainpark.mdx"; slug: "guides/domain-parking"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Services/folia.mdx": { id: "guides/Services/folia.mdx"; slug: "guides/build-folia"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "guides/Services/oracle.mdx": { id: "guides/Services/oracle.mdx"; slug: "guides/oracle-cloud"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "hosting/hardware.mdx": { id: "hosting/hardware.mdx"; slug: "h/hardware"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "hosting/intro.mdx": { id: "hosting/intro.mdx"; slug: "h"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "hosting/os.mdx": { id: "hosting/os.mdx"; slug: "h/os"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "hosting/panels.mdx": { id: "hosting/panels.mdx"; slug: "h/ui"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "hosting/providers.mdx": { id: "hosting/providers.mdx"; slug: "h/providers"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "hosting/self.mdx": { id: "hosting/self.mdx"; slug: "h/self"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "hosting/types.mdx": { id: "hosting/types.mdx"; slug: "h/types"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "index.mdx": { id: "index.mdx"; slug: "index"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "information/discord.mdx": { id: "information/discord.mdx"; slug: "discord"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "information/docs.mdx": { id: "information/docs.mdx"; slug: "docs"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "information/eula.mdx": { id: "information/eula.mdx"; slug: "eula"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "information/releases.mdx": { id: "information/releases.mdx"; slug: "release"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "information/services.mdx": { id: "information/services.mdx"; slug: "services"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "tools/database.mdx": { id: "tools/database.mdx"; slug: "t/database"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "tools/offline-mode.mdx": { id: "tools/offline-mode.mdx"; slug: "t/offline"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "tools/server-software.mdx": { id: "tools/server-software.mdx"; slug: "t/server-software"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "tools/signed-chat.mdx": { id: "tools/signed-chat.mdx"; slug: "t/signed-chat"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "tools/startup.mdx": { id: "tools/startup.mdx"; slug: "t/flags"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "tools/textures.mdx": { id: "tools/textures.mdx"; slug: "t/textures"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "tools/tunnels.mdx": { id: "tools/tunnels.mdx"; slug: "t/tunnels"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "troubleshooting/connectivity.mdx": { id: "troubleshooting/connectivity.mdx"; slug: "ts/connection"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "troubleshooting/ip.mdx": { id: "troubleshooting/ip.mdx"; slug: "ts/ip"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "troubleshooting/java.mdx": { id: "troubleshooting/java.mdx"; slug: "ts/java"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; "troubleshooting/latency.mdx": { id: "troubleshooting/latency.mdx"; slug: "ts/latency"; body: string; collection: "docs"; - data: any + data: InferEntrySchema<"docs"> } & { render(): Render[".mdx"] }; }; }; type DataEntryMap = { - + "i18n": { +}; + }; type AnyEntryMap = ContentEntryMap & DataEntryMap; - type ContentConfig = never; + export type ContentConfig = typeof import("../src/content/config.js"); } diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 78fb1e5902..9f4e4eea9e 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -18,7 +18,7 @@ on: # The branches below must be a subset of the branches above branches: [ "v3" ] schedule: - - cron: '30 18 * * 5' + - cron: "30 18 * * 5" jobs: analyze: @@ -32,41 +32,40 @@ jobs: strategy: fail-fast: false matrix: - language: [ ] + language: [] # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby' ] # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support steps: - - name: Checkout repository - uses: actions/checkout@v3 + - name: Checkout repository + uses: actions/checkout@v3 - # Initializes the CodeQL tools for scanning. - - name: Initialize CodeQL - uses: github/codeql-action/init@v2 - with: - languages: ${{ matrix.language }} - # If you wish to specify custom queries, you can do so here or in a config file. - # By default, queries listed here will override any specified in a config file. - # Prefix the list here with "+" to use these queries and those in the config file. - - # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs - # queries: security-extended,security-and-quality + # Initializes the CodeQL tools for scanning. + - name: Initialize CodeQL + uses: github/codeql-action/init@v2 + with: + languages: ${{ matrix.language }} + # If you wish to specify custom queries, you can do so here or in a config file. + # By default, queries listed here will override any specified in a config file. + # Prefix the list here with "+" to use these queries and those in the config file. - - # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). - # If this step fails, then you should remove it and run the build manually (see below) - - name: Autobuild - uses: github/codeql-action/autobuild@v2 + # Details on CodeQL's query packs refer to : https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs + # queries: security-extended,security-and-quality - # ℹ️ Command-line programs to run using the OS shell. - # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun + # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). + # If this step fails, then you should remove it and run the build manually (see below) + - name: Autobuild + uses: github/codeql-action/autobuild@v2 - # If the Autobuild fails above, remove it and uncomment the following three lines. - # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. + # ℹ️ Command-line programs to run using the OS shell. + # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun - # - run: | - # echo "Run, Build Application using script" - # ./location_of_script_within_repo/buildscript.sh + # If the Autobuild fails above, remove it and uncomment the following three lines. + # modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance. - - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@v2 + # - run: | + # echo "Run, Build Application using script" + # ./location_of_script_within_repo/buildscript.sh + + - name: Perform CodeQL Analysis + uses: github/codeql-action/analyze@v2 diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml index d42e2fd5e3..42ed3c3148 100644 --- a/.github/workflows/lint.yml +++ b/.github/workflows/lint.yml @@ -3,30 +3,30 @@ name: Check for lint/build errors on: pull_request: branches: - - '**' + - "**" jobs: lint: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - uses: actions/setup-node@v2 - with: - node-version: 16 - registry-url: https://registry.npmjs.org/ + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: 18 + registry-url: https://registry.npmjs.org/ - - name: npm install, lint - run: | - npm install - npm run lint + - name: npm install, lint + run: | + npm install + npm run lint build: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - uses: actions/setup-node@v2 - with: - node-version: 16 - registry-url: https://registry.npmjs.org/ + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: 18 + registry-url: https://registry.npmjs.org/ - name: npm install, build run: | diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 6fdd016209..3546c75da9 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -15,7 +15,7 @@ jobs: - uses: actions/setup-node@v2 with: - node-version: 16 + node-version: 18 registry-url: https://registry.npmjs.org/ - name: Install dependencies diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index a57f1512df..b68833ef0b 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -10,13 +10,13 @@ jobs: tests: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 - - uses: actions/setup-node@v2 - with: - node-version: 16 - registry-url: https://registry.npmjs.org/ + - uses: actions/checkout@v2 + - uses: actions/setup-node@v2 + with: + node-version: 18 + registry-url: https://registry.npmjs.org/ - - name: npm install, test - run: | - npm install - npm test + - name: npm install, test + run: | + npm install + npm run astro check diff --git a/LICENSE b/LICENSE index f06f03332a..cbe5ad1670 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,437 @@ -MIT License - -Copyright (c) 2023 setup.md - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +Attribution-NonCommercial-ShareAlike 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International +Public License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution-NonCommercial-ShareAlike 4.0 International Public License +("Public License"). To the extent this Public License may be +interpreted as a contract, You are granted the Licensed Rights in +consideration of Your acceptance of these terms and conditions, and the +Licensor grants You such rights in consideration of benefits the +Licensor receives from making the Licensed Material available under +these terms and conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. BY-NC-SA Compatible License means a license listed at + creativecommons.org/compatiblelicenses, approved by Creative + Commons as essentially the equivalent of this Public License. + + d. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + e. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + f. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + g. License Elements means the license attributes listed in the name + of a Creative Commons Public License. The License Elements of this + Public License are Attribution, NonCommercial, and ShareAlike. + + h. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + i. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + j. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + k. NonCommercial means not primarily intended for or directed towards + commercial advantage or monetary compensation. For purposes of + this Public License, the exchange of the Licensed Material for + other material subject to Copyright and Similar Rights by digital + file-sharing or similar means is NonCommercial provided there is + no payment of monetary compensation in connection with the + exchange. + + l. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + m. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + n. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part, for NonCommercial purposes only; and + + b. produce, reproduce, and Share Adapted Material for + NonCommercial purposes only. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. Additional offer from the Licensor -- Adapted Material. + Every recipient of Adapted Material from You + automatically receives an offer from the Licensor to + exercise the Licensed Rights in the Adapted Material + under the conditions of the Adapter's License You apply. + + c. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties, including when + the Licensed Material is used other than for NonCommercial + purposes. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + b. ShareAlike. + + In addition to the conditions in Section 3(a), if You Share + Adapted Material You produce, the following conditions also apply. + + 1. The Adapter's License You apply must be a Creative Commons + license with the same License Elements, this version or + later, or a BY-NC-SA Compatible License. + + 2. You must include the text of, or the URI or hyperlink to, the + Adapter's License You apply. You may satisfy this condition + in any reasonable manner based on the medium, means, and + context in which You Share Adapted Material. + + 3. You may not offer or impose any additional or different terms + or conditions on, or apply any Effective Technological + Measures to, Adapted Material that restrict exercise of the + rights granted under the Adapter's License You apply. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database for NonCommercial purposes + only; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material, + including for purposes of Section 3(b); and + + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. diff --git a/README.md b/README.md index bbd4209045..f5bea7bcbc 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,10 @@ Welcome to the Minecraft server administration knowledgebase designed to provide 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): +3. 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 ``` @@ -43,7 +43,7 @@ Thanks a lot for spending your time in helping setup.md grow. Thanks a lot! ❤ ## 📑 License -Licensed under [MIT](https://github.com/setupmd/docs/blob/master/LICENSE). +Licensed under [CC BY-NC-SA 4.0 DEED](https://creativecommons.org/licenses/by-nc-sa/4.0/deed.en). ## ⭐️ One more thing diff --git a/astro.config.mjs b/astro.config.mjs index 23ad931ef8..b5a196a284 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -1,62 +1,62 @@ -import { defineConfig } from 'astro/config'; -import starlight from '@astrojs/starlight'; +import { defineConfig } from "astro/config"; +import starlight from "@astrojs/starlight"; import vue from "@astrojs/vue"; - import tailwind from "@astrojs/tailwind"; +import sitemap from "@astrojs/sitemap"; + // https://astro.build/config export default defineConfig({ - site: 'https://www.setup.md', - trailingSlash: 'never', + site: "https://www.setup.md", + trailingSlash: "never", build: { - format: 'file', + format: "file" }, integrations: [starlight({ - title: 'setup.md', + title: "setup.md", editLink: { - baseUrl: 'https://github.com/setupmd/docs/edit/v3' + baseUrl: "https://github.com/setupmd/docs/edit/v3" }, social: { - discord: 'https://link.setup.md/discord', - github: 'https://link.setup.md/repo', - patreon: 'https://link.setup.md/patreon' + discord: "https://link.setup.md/discord", + github: "https://link.setup.md/repo" }, sidebar: [{ - label: 'Project Information', + label: "Project Information", autogenerate: { - directory: '/information/' + directory: "/information/" }, collapsed: false }, { - label: 'Enhancements', + label: "Enhancements", autogenerate: { - directory: '/enhancements/' + directory: "/enhancements/" }, collapsed: true }, { - label: 'Hosting Tips', + label: "Hosting Tips", autogenerate: { - directory: '/hosting/' + directory: "/hosting/" }, collapsed: true }, { - label: 'Server Tools', + label: "Server Tools", autogenerate: { - directory: '/tools/' + directory: "/tools/" }, collapsed: true }, { - label: 'Server Troubleshooting', + label: "Server Troubleshooting", autogenerate: { - directory: '/troubleshooting/' + directory: "/troubleshooting/" }, collapsed: true }, { - label: 'Guides', + label: "Guides", autogenerate: { - directory: '/guides/' + directory: "/guides/" }, collapsed: true }] - }), vue(), tailwind()] -}); + }), vue(), tailwind(), sitemap()] +}); \ No newline at end of file diff --git a/package.json b/package.json index fd719f926d..89539e1184 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@setupmd/docs", "type": "module", - "version": "3.1.1", + "version": "4.1.0", "private": true, "scripts": { "dev": "astro dev", @@ -11,13 +11,16 @@ "astro": "astro" }, "dependencies": { - "@astrojs/starlight": "^0.11.2", - "@astrojs/tailwind": "^5.0.2", - "@astrojs/vue": "^3.0.4", + "@astrojs/check": "^0.5.5", + "@astrojs/sitemap": "^3.1.1", + "@astrojs/starlight": "^0.19.1", + "@astrojs/tailwind": "^5.1.0", + "@astrojs/vue": "^4.0.8", "@vitejs/plugin-vue": "^4.5.1", - "astro": "^3.2.3", + "astro": "^4.4.1", "sharp": "^0.32.5", "tailwindcss": "^3.3.5", + "typescript": "^5.3.3", "vue": "^3.3.9" } } diff --git a/public/_redirects b/public/_redirects new file mode 100644 index 0000000000..9db9ae74f7 --- /dev/null +++ b/public/_redirects @@ -0,0 +1 @@ +/discord-invite http://link.setup.md/discord 301 \ No newline at end of file diff --git a/public/favicon.ico b/public/favicon.ico new file mode 100644 index 0000000000..a11b1861d9 Binary files /dev/null and b/public/favicon.ico differ diff --git a/src/content/docs/enhancements/Anti-X Tools/anticheat.mdx b/src/content/docs/enhancements/Anti-X Tools/anticheat.mdx index 357570c7f8..acb7b997eb 100644 --- a/src/content/docs/enhancements/Anti-X Tools/anticheat.mdx +++ b/src/content/docs/enhancements/Anti-X Tools/anticheat.mdx @@ -2,15 +2,17 @@ description: A brief introduction to Anti-Cheats and the community recommended solutions. slug: e/anti-x/ac 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 Throughout this guide 'Anti-Cheat(s)' may be referred to as 'AC' or 'ACs' ::: -ACs are an integral part of any public server and help with catching hackers, since Minecraft's built-in anti-cheat is practically useless, it's better to turn it off than to endure the constant false positives it spews out. +ACs are an integral part of any public server and help with catching hackers, since Minecraft's built-in anti-cheat is practically useless, it's better to turn it off than to endure the constant false positives it spews out. You should change the following settings within the `server.properties` file. @@ -29,7 +31,7 @@ Within the `spigot.yml` file you should also set the following values. moved-wrongly-threshold: 100000.0 moved-too-quickly-multiplier: 100000.0 - + ... ``` @@ -44,105 +46,149 @@ 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. -#### NoCheatPlus Java Only +#### NoCheatPlus Spigot / Paper & forks only ##### Pros - - Free and open-source - - Good movement checks + +
    +
  • Free and open-source
    • +
  • Good movement checks
    • +
##### Cons - - Default configuration will spam false movement positives all over the place, you should buy a good config (eg. [MarkElf's](https://www.mc-market.org/resources/475/)) OR make your own - - Mediocre combat checks -
-Github -
+
    +
  • Default configuration will spam false movement positives all over the place, you should buy a good config (eg. [MarkElf's](https://www.mc-market.org/resources/475/)) OR make your own
    • +
  • Mediocre combat checks
    • +
+ + --- -#### Grim +#### Grim Spigot / Paper & forks only ##### Pros - - Open-source - - Great movement checks - - Predictive technology + +
    +
  • Open-source
    • +
  • Great movement checks
    • +
  • Predictive technology
    • +
##### Cons - - Currently WIP, not ready for production servers - - Mediocre combat checks - - Quite unoptimized -
-Github -
+
    +
  • Currently WIP, not ready for production servers
    • +
  • Mediocre combat checks
    • +
  • Quite unoptimized
    • +
+ + --- -#### Vulcan +#### Vulcan Spigot / Paper & forks only ##### Pros - - Great movement and combat checks - - Good default config + +
    +
  • Great movement and combat checks
    • +
  • Good default config
    • +
##### Cons - - USD 20.00 - - Suboptimal performance when scaled to high player counts (>3% of ticks at 420 players). -
-Spigot -
+
    +
  • USD 20.00
    • +
  • Suboptimal performance when scaled to high player counts (>3% of ticks at 420 players)
    • +
+ + --- -#### Spartan +#### Spartan Spigot / Paper & forks only ##### Pros - - 14-day money-back guarantee - - Good Bedrock Checks. I wouldn't go as far as saying that you should auto-ban for violations, though - - Decent movement checks. + +
    +
  • 14-day money-back guarantee
    • +
  • Good Bedrock Checks
    • +
  • Decent movement checks
    • +
##### Cons - - EUR 22.49 - - Relatively poor combat checks - - Crashes on start up at times - - Performance so bad you might as well set the max TPS of the server to zero, because that's exactly what Spartan has done in the past. -
-Spigot -
+
    +
  • EUR 22.49
    • +
  • Relatively poor combat checks
    • +
  • Crashes on start up at times
    • +
  • Sub-par performance
    • +
+ + --- -#### Matrix +#### Matrix Spigot / Paper & forks only ##### Pros - - Decent movement and combat checks. +
    +
  • Decent movement and combat checks
    • +
##### Cons - - Bad default config, but there are some [good ones](https://github.com/QuantumSuite/MatrixChecks) out there - - USD 20.00 (With 95% Checks) and USD 129.00 (All Checks) - - Dedicated Server Limit. - - Terrible performance; Ate up >5% of the ticks at 135 players. - - +
    +
  • Bad default config, but there are some [good ones](https://github.com/QuantumSuite/MatrixChecks) out there
    • +
  • USD 20.00 (With 95% Checks) and USD 129.00 (All Checks)
    • +
  • Dedicated Server Limit
    • +
  • Terrible performance; Ate up >5% of the ticks at 135 players
    • +
+ + --- -#### Themis +#### Themis Spigot / Paper & forks only ##### Pros - - Free. - - Proper Geyser-Floodgate (Bedrock Players) checks. (Only reason to use this anti-cheat) +
    +
  • Free
    • +
  • Proper Geyser-Floodgate (Bedrock Players) checks (Only reason to use this anti-cheat)
    • +
##### Cons - - Bad Combat & Mediocre Movement checks (Bad Elytra, Timer, KillAura Checks) - - Lack of checks in general - -
-Spigot -
+
    +
  • Bad Combat & Mediocre Movement checks (Bad Elytra, Timer, KillAura Checks)
    • +
  • Lack of checks in general
    • +
+ +
:::note @@ -151,73 +197,98 @@ This anti-cheat is optimised for bedrock players. --- -#### SoaromaSAC (Config 6) +#### SoaromaSAC (Config 6) Spigot / Paper & forks only ##### Pros - - Free -##### Cons - - Bad Checks - - Infinite False Positives - - Fake Open Source Link. Leads to a Rick Roll +
    +
  • Free
    • +
-
-Spigot -
+##### Cons +
    +
  • Bad Checks
    • +
  • Infinite False Positives
    • +
  • Fake Open Source Link. Leads to a Rick Roll
    • +
+ + --- -#### Negativity v1 & v2 - +#### Negativity v1 & v2 All major Java platforms + ##### Pros - - Free & Open Source. - - Paid Version (v2) is Open Source - - v2 supports a lot of platforms (Minestom, Sponge, Fabric & more) +
    +
  • Free & Open Source
    • +
  • Paid Version (v2) is Open Source
    • +
  • v2 supports a lot of platforms (Minestom, Sponge, Fabric & more)
    • +
##### Cons - - Lacks some important checks. (No Elytra Checks, NoSlow Checks etc) - - Poor movement and combat checks +
    +
  • Lacks some important checks (No Elytra Checks, NoSlow Checks etc)
    • +
  • Poor movement and combat checks
    • +
-
-Spigot -
+ --- - + #### Astro ##### Pros - - Great movement and combat checks - - Good default config - - Great performance - very light on the main thread. Ate only .01% of ticks at 430 players. - - Decent Bedrock Checks. Obviously do not auto-ban in case of violations. +
    +
  • Great movement and combat checks
    • +
  • Good default config
    • +
  • Great performance - very light on the main thread. Ate only .01% of ticks at 430 players
    • +
  • Decent Bedrock Checks, obviously do not auto-ban in case of violations
    • +
##### Cons - - USD 30.00 - - Timer checks false incredibly often - - Poor reliability; has broken at least once per quarter so far. - - Atrocious ToS which states that you are not allowed to mention that your server is using Astro. Also, to purchase the anti-cheat, the server must have an active player count of 50 or above. - -
-Page -
+
    +
  • USD 30.00
    • +
  • Timer checks false incredibly often
    • +
  • Poor reliability; has broken at least once per quarter so far
    • +
  • Atrocious ToS which states that you are not allowed to mention that your server is using Astro. Also, to purchase the anti-cheat, the server must have an active player count of 50 or above
    • +
+ + --- #### Polar ##### Pros - - Great movement and combat checks - - Works out-of-the-box on most servers - - Cloud-based detections, which helps reducing stress on server resources +
    +
  • Great movement and combat checks
    • +
  • Works out-of-the-box on most servers
    • +
  • Cloud-based detections, which helps reducing stress on server resources
    • +
##### Cons - - Subscription plans starting at EUR 15/month - - Limitations on player count, server instances and dedicated servers based on subscription plan - -
-Page -
+
    +
  • Subscription plans starting at EUR 15/month
    • +
  • Limitations on player count, server instances and dedicated servers based on subscription plan
    • +
+ + ### Recommendations diff --git a/src/content/docs/enhancements/Anti-X Tools/antiexploit.mdx b/src/content/docs/enhancements/Anti-X Tools/antiexploit.mdx index 20a107afc2..1ee39234bd 100644 --- a/src/content/docs/enhancements/Anti-X Tools/antiexploit.mdx +++ b/src/content/docs/enhancements/Anti-X Tools/antiexploit.mdx @@ -2,8 +2,12 @@ description: A brief introduction to Anti-Exploits and the community recommended solutions. slug: e/anti-x/ae title: Anti-Exploit +lastUpdated: 2024-02-25 --- +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. :::info @@ -14,9 +18,10 @@ Some of these plugins might only be useful if you are not using the latest versi Panilla prevents abusive NBT and packets. Average or lenient modes recommended. Recently was found to be messing with items contained within shulkers, so test the plugin before you install it on production. - + + + + --- @@ -24,9 +29,11 @@ Panilla prevents abusive NBT and packets. Average or lenient modes recommended. Avoids NettyCrashers, slightly prevents Anti-Anti-Xrays, logs packets and limits them. - + --- @@ -34,6 +41,7 @@ Avoids NettyCrashers, slightly prevents Anti-Anti-Xrays, logs packets and limits Improve the security of your Minecraft server by filtering illegal content from player created books. Although personally I would completely disable books because I don't trust them at all, you may use this plugin instead. - + + + + diff --git a/src/content/docs/enhancements/Anti-X Tools/antilag.mdx b/src/content/docs/enhancements/Anti-X Tools/antilag.mdx index b9f257aab8..0d6fa53294 100644 --- a/src/content/docs/enhancements/Anti-X Tools/antilag.mdx +++ b/src/content/docs/enhancements/Anti-X Tools/antilag.mdx @@ -2,31 +2,43 @@ description: A brief introduction to Anti-Lag and alternative performance management tools. slug: e/anti-x/al title: Anti-Lag +lastUpdated: 2024-02-25 --- +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. -:::warning -Anti-lag plugins such as ClearLagg "don't work". These plugins periodically clear dropped items at a set interval - this makes a negligible difference to lag and most anti-lag plugins have poor detection that can result in more lag. Aside from the fact any "gains" seen by such tools are just hiding performance issues under a thin veil rather than actually fixing them. +:::caution +**Anti-lag plugins such as ClearLagg "don't work".** + +These plugins periodically clear dropped items at a set interval - this makes a negligible difference to lag and most anti-lag plugins have poor detection that can result in more lag. Aside from the fact any "gains" seen by such tools are just hiding performance issues under a thin veil rather than actually fixing them. ::: #### Guides to Optimisation We have published a couple of proven guides on optimisations below that should be reviewed first. -
-Guide -
+ --- #### Spark -A modern performance profiler for 1.8+ servers on any platform - Forge, Spigot, Fabric, almost anything that isn't the vanilla server! This isn't an anti-lag plugin per se but it can help you find what's *causing* lag on your server. It now comes built-in with the Purpur performance JAR and its forks. +A modern performance profiler for 1.8+ servers on any platform - Forge, Spigot, Fabric, almost anything that isn't the vanilla server! This isn't an anti-lag plugin per se but it can help you find what's *causing* lag on your server. + +It now comes built-in with the Purpur performance JAR and its forks. - + + + + + --- @@ -34,9 +46,10 @@ A modern performance profiler for 1.8+ servers on any platform - Forge, Spigot, This plugin allows you to manage certain properties of farms on your server. Among other things, the plugin acts as a farm limiter, can remove the ability of mobs in farms to collide and perform random movements, or can completely disable the AI of mobs in farms. These actions can be performed either passively or in response to the server's performance degrading. - + + + + --- @@ -44,9 +57,10 @@ This plugin allows you to manage certain properties of farms on your server. Amo This plugin lets you quickly find chunks with large quantities of mobs/animals & tile entities. Not an anti-lag plugin, but can be incredibly useful - + + + + --- @@ -54,9 +68,10 @@ This plugin lets you quickly find chunks with large quantities of mobs/animals & Prevents players from lagging the server with minecarts and boats. If you have FarmLimiter, consider configuring that plugin to do what CAProtect does instead, as CAProtect is a bit more intensive. Otherwise, consider using AjMac's fork. - + + + + --- @@ -64,6 +79,7 @@ Prevents players from lagging the server with minecarts and boats. If you have F RedstoneLimiter is a plugin that limits how many times individual redstone contraptions can be activated in a customizable amount of time to fix lag machines. - + + + + diff --git a/src/content/docs/enhancements/Anti-X Tools/antixray.mdx b/src/content/docs/enhancements/Anti-X Tools/antixray.mdx index 2201a71f6d..16b8d48ec1 100644 --- a/src/content/docs/enhancements/Anti-X Tools/antixray.mdx +++ b/src/content/docs/enhancements/Anti-X Tools/antixray.mdx @@ -2,7 +2,10 @@ description: A brief introduction to Anti-Xray and the community recommended solutions. slug: e/anti-x/ax title: Anti-Xray +lastUpdated: 2024-02-25 --- +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: @@ -10,30 +13,36 @@ As the name suggests, Anti-Xray will prevent players from finding ores using Xra #### PaperMC PaperMC (A fork of Spigot) comes with a built-in Anti-Xray. This Anti-Xray usually does the trick just fine. It is simple to setup and causes no lag for both the server and the client (unless you hide caves (air), which will be much laggier for the client). A great guide is shown [here](https://docs.papermc.io/paper/anti-xray). Again, make sure that you do NOT add `air` to `hidden-blocks`. - + --- #### Orebfuscator -If you're stuck using Spigot for whatever reason, you should probably use Orebfuscator. It may also work well in junction with Paper's Anti-Xray, as it can also +If you're stuck using Spigot for whatever reason, you should probably use Orebfuscator. It may also work well in junction with Paper's Anti-Xray, as it can also hide containers better. + +
:::note Orebfuscator does have a tendency to turn chests into dirt when server is laggy, this is a visual thing and doesn't delete the contents of said chests ::: -
-Spigot -
- --- ### RayTraceAntiXray Paper plugin for server-side async multithreaded ray tracing to hide ores that are exposed to air using Paper Anti-Xray engine-mode 1. Might be worth using instead of engine-mode 2 as that can cause lag on slow devices. Only recommended if you have extra threads and don't mind using ProtocolLib. -
-Github -
+ diff --git a/src/content/docs/enhancements/Anti-X Tools/intro.mdx b/src/content/docs/enhancements/Anti-X Tools/intro.mdx index d04c427dbb..f69ae411eb 100644 --- a/src/content/docs/enhancements/Anti-X Tools/intro.mdx +++ b/src/content/docs/enhancements/Anti-X Tools/intro.mdx @@ -5,16 +5,18 @@ description: Understand the types of 'preventative' tools that exist for Minecra title: Introduction --- +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. The most common types of plugins you'll see in this category are: - - Anti-Cheat - - Anti-Lag - - Anti-Exploit - - Anti-Swear - - Anti-Xray - - Anti-Mechanic (where mechanic is a vanilla function server owners don't want) + + + + + + We will attempt to cover multiple examples of each where possible. - diff --git a/src/content/docs/index.mdx b/src/content/docs/index.mdx index 19a42a96c7..717a1965f0 100644 --- a/src/content/docs/index.mdx +++ b/src/content/docs/index.mdx @@ -1,9 +1,11 @@ --- title: Minecraft Admin Wiki -description: Welcome to the new and improved Minecraft administration wiki. +description: We're setup.md, the Minecraft administration wiki, written by enthusiasts and targeted to the novice. template: splash +banner: + content: The wiki license is changing to © BY-NC-SA 4.0. Read the new license. hero: - tagline: We've made some major changes around here, we hope you enjoy the improvements! + tagline: Your home of good information written by enthusiasts for the novice Minecraft server owner. image: file: ../../assets/houston.webp actions: @@ -18,15 +20,15 @@ hero: import { Card, CardGrid } from '@astrojs/starlight/components'; - + - We're now faster than ever before with an updated stack behind the scenes! + Behind the scenes our wiki has lost some weight as is built on the fastest framework to date! - With our V3 overhaul we've improved our documentation syntax to help aspiring contributors. + Version 3 of the wiki launches with a focus on improving contribution requirements. - With V3 we now have the functionality to implement translations following the i18n standard. + With V3 we now have the functionality to implement translations following the i18n standard. **SOON!** We're still backed by the amazing members of the [Admincraft](https://link.setup.md/acdiscord) community. diff --git a/src/layouts/layout.astro b/src/layouts/layout.astro new file mode 100644 index 0000000000..e3ca2287a2 --- /dev/null +++ b/src/layouts/layout.astro @@ -0,0 +1,3 @@ + + +