Skip to content

Commit

Permalink
Terra docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@ukdaaan
ukdaaan committed Mar 8, 2024
1 parent 314e0d1 commit 1e72b85
Show file tree
Hide file tree
Showing 6 changed files with 189 additions and 42 deletions.
7 changes: 7 additions & 0 deletions .astro/types.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -423,6 +423,13 @@ declare module 'astro:content' {
collection: "docs";
data: InferEntrySchema<"docs">
} & { render(): Render[".mdx"] };
"guides/Minecraft/Plugins/terra.mdx": {
id: "guides/Minecraft/Plugins/terra.mdx";
slug: "guides/terra";
body: string;
collection: "docs";
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";
Expand Down
85 changes: 85 additions & 0 deletions src/content/docs/guides/Minecraft/Plugins/terra.mdx
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
---
description: Configure a Terra world gen world for use in both Single and Multiplayer environments.
slug: guides/terra
title: Terra World Generation
lastUpdated: 2024-03-04
---

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.

Before continuing with configuring Terra we are assuming the following:

<ul class="pl-5 list-disc">
<li>You are using one of our provided world files</li>
<li>You are running atleast version 1.20.4</li>
</ul>

Make sure you download one of our maps via our 'Additional Services' page.

<LinkCard
title="Additional Services - Pregen Maps"
description="Additional resources that are hosted by the setup.md team."
href="/services"
/>

You will then need to scroll down to one of the following topic headers to complete setup.

<ul class="pl-5 list-disc">
<li>Paper & Forks</li>
<li>Fabric & Forge</li>
</ul>

### Paper & Forks

Download the latest `.jar` file from the Modrinth page using the link below and add it directly to your `/plugins/` folder inside the server directory.

<LinkCard
title="Modrinth"
description="View Terra's official Modrinth page for downloading the plugin."
href="https://terra.polydev.org/install/versions.html#bukkit-versions"
/>

You will also need to append the following changes to the end of your `bukkit.yml` file **BEFORE** launching your server, this will ensure your server uses the Terra world gen plugin.

```
...
worlds:
world:
generator: Terra:OVERWORLD
...
```

Once this has been complete you can upload and unzip the World.XXXXXXX.zip folder into your server directory. This will automatically extract into a `world` folder and you should be ready to start your server.

<img src="https://onlinefile.host/dbi80nv" alt="console logs"/>

Once the server is powered on, check for the three lines highlighted above. If these are displayed that means Terra is responsible for your world and chunk management / generation going forward.

---

### Fabric & Forge

Download the latest `.jar` file from the Modrinth page using the link below and add it directly to your `/mods/` folder inside the server directory.

<LinkCard
title="Modrinth"
description="View Terra's official Modrinth page for downloading the mod."
href="https://terra.polydev.org/install/versions.html#fabric"
/>

Add the following key to your `server.properties` file **BEFORE** launching your server, this will ensure your server uses the Terra world gen plugin.

```
...
level-type=terra:overworld/overworld
...
```

Once this has been complete you can upload and unzip the World.XXXXXXX.zip folder into your server directory. This will automatically extract into a `world` folder and you should be ready to start your server.
11 changes: 7 additions & 4 deletions src/content/docs/hosting/os.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,21 +7,24 @@ title: Operating Systems
When running a Minecraft server on [bare metal](/h/types/#bare-metal--vds), or a [VPS](/h/types#virtual-private-servers) you'll need to install a base operating system before you can get started. Unless you're running an apple device your options are Windows / Windows Server or Linux and the abundance of distros that come along with it.

This page will explain the common choices available.

<ul class="pl-5 list-disc">
<li>Windows (Desktop and Server)</li>
<li>Ubuntu LTS</li>
</ul>

### Windows

If you're looking to host a server for your friends then the easiest option for self-hosting is Windows, you're already using it and if you're going to a CPS for a server they will include a monthly fee for Windows Server. At their core both OSes are 'the same' and for Minecraft running a personal server within Windows 10/11 from your home PC will be fine.
If you're looking to host a server for your friends then the easiest option for self-hosting is Windows, you're already using it and if you're going to use a cloud provider for a server they will include a monthly fee for Windows Server. At their core both OSes are 'the same' and for Minecraft running a personal server within Windows 10/11 from your home PC will be fine.

Moving to Windows Server will give you a couple of advantages, primarily longer OS support - these tend to follow a N+10 policy when discussing depreciation which is normally a good few years more than standard desktop releases.

Moving to Windows Server will give you a couple of advantages, primarily longer OS support - these tend to follow a N+10 policy when discussing depreciation which is normally a good few years more than standard desktop releases. A server OS will also be lighter, out of the box these images are bare with nothing but the core files needed to get Windows functional which compared to the desktop OS could see a perf gain with less resource wastage and reduces your attack surface slightly by ensuring there are no unnecessary products installed / configured.
Windows Server OS is lighter out of the box and includes nothing but the core files needed to get Windows functional which compared to the desktop OS could see a perf gain with less resource wastage and can slightly reduce your attack surface by ensuring there are no little to none un-patched applications installed / configured.

---

### Ubuntu LTS

Unofficially you can also throw the base 'Debian' into this argument too however with Ubuntu Pro now becoming a free feature it's a huge win for the home lab. Ubuntu Pro offers 10 years of LTS patches so now follows a Windows Server like support plan which will save a lot of hassle needing to move your Instance from one release to another.
Unofficially you can also throw the base 'Debian' into this argument too however with Ubuntu Pro now becoming a free feature (for up to 5 devices) it's a huge win for the home lab. Ubuntu Pro offers 10 years of LTS patches so now follows a Windows Server like support plan which will save a lot of hassle needing to move your Instance from one release to another.

If you want to get into the more professional side of hosting, Linux is the way to go - it's further optimised and will let you get the absolute most performance out of the hardware as possible. Day-to-day you will be interfacing with this OS through a command line but unlike Windows Server if you got to a CSP you won't be charged for these, web-based game management portals do exist for those on Linux who don't want to manage everything via the CLI.
If you want to get into the more professional side of hosting, Linux is the way to go - it's further optimised and will let you get the absolute most performance out of the hardware as possible. Day-to-day you will be interfacing with this OS through a command line but unlike Windows Server if you go to a CSP you won't be charged for these, web-based game management portals do exist for those on Linux who don't want to manage everything via the CLI.
15 changes: 11 additions & 4 deletions src/content/docs/hosting/panels.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,12 @@ title: Panels
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).
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).

While Multicraft and Pterodactyl became the widely adopted platforms for Minecraft hosting this doesn't mean they're the only players in the game and with a VPS / Bare Metal you can install any one of a number of different solutions. We could write this article for the next six months documenting every single different panel and why it should be used but we're going to focus on a couple.

The top 4 shortlisted panels this article will be covering are.

<ul class="pl-5 list-disc">
<li>AMP</li>
<li>Moonlight</li>
Expand All @@ -26,6 +27,7 @@ AMP is a licensed panel produced by CubeCoders which supports both Windows and L
At this time there is **NO** Apple builds so for legacy McMyAdmin2 users this product may not be suitable for you unless you're running boot camp or run your servers on a different machine.

#### Pros

<ul class="pl-5 list-disc">
<li>Community backed game contributions</li>
<li>Migration path for McMyAdmin2 users</li>
Expand All @@ -35,6 +37,7 @@ At this time there is **NO** Apple builds so for legacy McMyAdmin2 users this pr
</ul>

#### Cons

<ul class="pl-5 list-disc">
<li>Licensed</li>
<li>Multiple security requirements before installable (principle isn't a con but it's a pain)</li>
Expand All @@ -53,6 +56,7 @@ At this time there is **NO** Apple builds so for legacy McMyAdmin2 users this pr
Moonlight is an up and coming panel solution that is aimed towards those looking to replace Pterodactyl. The project is still in it's early phase and we've been pleased with the outcome so far in small scale testing and has therefore made our list as a one to watch.

#### Pros

<ul class="pl-5 list-disc">
<li>Automatic plugin installer</li>
<li>Automatic SRV record creator</li>
Expand All @@ -76,11 +80,12 @@ Moonlight is an up and coming panel solution that is aimed towards those looking

### Pterodactyl <MainStatusPill info>Linux only</MainStatusPill>

Multicraft had to die for Pterodactyl to breathe, an open source panel in active development and great support behind it. For those who like the sound of pterodactyl but not the self-hosting setup process you can look at the SaaS version [WISP](https://wisp.gg) which will cost you around $15 a month for the entry plan.
Multicraft had to die for Pterodactyl to breathe, an open source panel in active development and great support behind it. For those who like the sound of pterodactyl but not the self-hosting setup process you can look at the SaaS version [WISP](https://wisp.gg) which will cost you around $5 a month for the community plan.

Pterodactyl boasts a two part setup, a web-server and a docker agent (wings) that only has official support for Linux. WSL has no official support same with Mac OS, you may find better luck utilising their 'panel-in-docker' and 'wings-in-docker' if you wish to attempt an install on either of these platforms.

#### Pros

<ul class="pl-5 list-disc">
<li>ARM instruction set support</li>
<li>Billing integration for WHMCS / Blesta</li>
Expand All @@ -103,17 +108,19 @@ Pterodactyl boasts a two part setup, a web-server and a docker agent (wings) tha

### PufferPanel <MainStatusPill info>Linux only</MainStatusPill>

PufferPanel could have been the Pterodactyl industry standard tool today, a panel formerly developed by a Pterodactyl team member prior to a clashing of heads and a splitting of the product, however PufferPanel remains open source and in active development by the original founder and an long-time dev.
PufferPanel could have been the Pterodactyl industry standard tool today, a panel formerly developed by a Pterodactyl team member prior to a clashing of heads and a splitting of the product, however PufferPanel remains open source and in active development by the original founder and an long-time dev.

The situation is the same for PufferPanel as it is for Pterodactyl, only has official support for Linux, however Windows builds are available (if unsupported).

#### Pros

<ul class="pl-5 list-disc">
<li>One click/line installers via APT/YUM</li>
<li>ARM instruction set support</li>
</ul>

#### Cons

<ul class="pl-5 list-disc">
<li>Lack of industry adoption / third party support</li>
<li>No billing modules</li>
Expand All @@ -127,4 +134,4 @@ PufferPanel (OSS Project) should not be confused with the proprietary puffer pan
<LinkCard title="Website" href="https://www.pufferpanel.com/" />
<LinkCard title="Discord" href="https://discord.gg/v8dz49e" />
<LinkCard title="Github" href="https://github.com/pufferpanel/pufferpanel" />
</CardGrid>
</CardGrid>
67 changes: 54 additions & 13 deletions src/content/docs/hosting/providers.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,20 @@ With the game becoming as big as it has done over the last decade there have bee

It should be made clear that <strong>none</strong> of the references below are sponsored.


:::tip
:::tip
If you don't know what kind of hosting you need, it's recommended to checkout the following article <a href="https://setup.md/h/types">here</a> to understand the different available platforms.
:::

### Bloom.host

Unparalleled price to performance with dedicated resources on high-end AMD Ryzen hardware and a bespoke customised version of the Pterodactyl panel. Bloom is also now a provider in the VPS and managed server solutions space across multiple regions.

<ul class="pl-5 list-disc">
<li>Locations: Ashburn, Dallas, Los Angeles, Miami, Falkenstein, Singapore (Performance+ plans only)</li>
</ul>

#### Pricing

<ul class="pl-5 list-disc">
<li>Essentials MC 4GB: $10/month</li>
<li>Performance MC 8GB: $18/month</li>
Expand All @@ -46,11 +47,13 @@ Unparalleled price to performance with dedicated resources on high-end AMD Ryzen
### EnviroMC

EnviroMC is a quality Minecraft service provider that focuses on both the budget and high-end requirements of their customers, as of Sept. 19th 2022 URHOST clients will be absorbed into EnviroMC as part of a takeover agreement. EnviroMC also provides a VPS solution across the US, Europe and Asia.

<ul class="pl-5 list-disc">
<li>Locations: Falkenstein, New York, Singapore, Warsaw (VPS Only)</li>
</ul>

#### Pricing

<ul class="pl-5 list-disc">
<li>Budget: $1/GB/month</li>
<li>Premium: $2.50/GB/month</li>
Expand All @@ -62,17 +65,18 @@ EnviroMC is a quality Minecraft service provider that focuses on both the budget
href="https://enviromc.host"
/>


---

### Hetzner GMBH
### Hetzner GMBH

It would be impossible to create a provider list and not include Hetzner, they currently stand as the German kings when it comes to high-end hardware at an ultra affordable price point. If you're running a large enough solution and just looking for the bare metal to run it on they should be food for thought.

<ul class="pl-5 list-disc">
<li>Locations: Ashburn (VPS Only), Falkenstein, Helsinki, Nuremberg (VPS Only), Vint Hill (VPS Only)</li>
</ul>

#### Pricing
#### Pricing

<ul class="pl-5 list-disc">
<li>Cloud Starting: €3.79/month</li>
<li>Dedicated Starting: €37/month</li>
Expand All @@ -87,26 +91,35 @@ It would be impossible to create a provider list and not include Hetzner, they c

### Lilypad

Formerly called Senior Hosting it's the rebranded hosting division of Senior Studios who are a Minecraft Marketplace partner and have worked with multiple high-profile YouTube Minecraft content creators.
Formerly called Senior Hosting it's the rebranded hosting division of Senior Studios who are a Minecraft Marketplace partner and have worked with multiple high-profile YouTube Minecraft content creators.

<ul class="pl-5 list-disc">
<li>Locations: London, New York</li>
</ul>

#### Pricing

<ul class="pl-5 list-disc">
<li>Priced at $2.50/GB</li>
</ul>

<LinkCard
title="Website"
href="https://lilypad.gg"
/>
---

### OVHCloud
---

### OVHCloud

OVH, much like Hetzner, is a compute only provider meaning they specialise in Cloud services and Metal (the platform we use for Labs)

<ul class="pl-5 list-disc">
<li>Locations: Beauharnois, Frankfurt, Gravelines, London, Roubaix, Singapore, Strasbourg, Sydney, Vint Hill, Warsaw</li>
</ul>

#### Pricing
#### Pricing

<ul class="pl-5 list-disc">
<li>Cloud Starting: $3.50/month</li>
<li>Dedicated Starting: $56/month</li>
Expand All @@ -119,11 +132,38 @@ OVH, much like Hetzner, is a compute only provider meaning they specialise in Cl

---

### setup.md (Yes, us!)

While not a maintstream hosting provider we decided to open up our unused compute for Tier 2 Github sponsors who are entitled to x1 6GB RAM Minecraft server. For obvious reasons we do have a cap on the amount of servers we're available to host so will be offered on a first come first serve basis.

<ul class="pl-5 list-disc">
<li>Location: Nuremberg</li>
</ul>

#### Pricing

<ul class="pl-5 list-disc">
<li>Tier 2: $15/month</li>
</ul>

<LinkCard
title="Github"
href="https://github.com/sponsors/setupmd"
/>

---

### WitherHosting

A budget hosting provider with a global reach and an entry price point of 1$/GB utilising a range of both Ryzen and Xeon grade processors.
A budget hosting provider with a global reach and an entry price point of 1$/GB utilising a range of both Ryzen and Xeon grade processors.

<ul class="pl-5 list-disc">
<li>Locations: Chicago, Dallas, Frankfurt, London, Los Angeles, Miami, New York, Singapore, Sydney</li>
</ul>

#### Pricing

<ul class="pl-5 list-disc">
<li>Budget: $1/GB/month</li>
<li>Premium: $2/GB/month</li>
</ul>
Expand All @@ -135,11 +175,12 @@ A budget hosting provider with a global reach and an entry price point of 1$/GB

---

### Other Providers
### Other Providers

Yes, there are other great providers that haven't made our list for one reason or another - if you do decide to venture out and search for other providers some things we'd recommend you looking out for are
Yes, there are other great providers that haven't made our list for one reason or another - if you do decide to venture out and search for other providers some things we'd recommend you looking out for are

#### Avoid These Things

<ul class="pl-5 list-disc">
<li>Don't use a host that makes you pay with a 'per-player slot' model - This is awfully dated and you should focus on resource based pricing instead</li>
<li>Don't use Mojang (Microsoft) Realms - This is an Azure backed platform designed for bedrock but also has Java presence, in the long run you will not have an enjoyable experience</li>
Expand All @@ -152,4 +193,4 @@ Yes, there are other great providers that haven't made our list for one reason o
<li>Check the providers status page for a better understanding of reliability</li>
</ul>
<br/>
<strong> If in doubt ASK! Measure twice and cut once.</strong>
<strong> If in doubt ASK! Measure twice and cut once.</strong>
Loading

0 comments on commit 1e72b85

Please sign in to comment.