From 20466e2370cee162a23a6a17ed7d96919bc46bc4 Mon Sep 17 00:00:00 2001
From: William Locke <105554094+dopecello@users.noreply.github.com>
Date: Tue, 7 May 2024 03:16:53 -0400
Subject: [PATCH] Some small changes from dopecello (#58)
* added link to shops section
* added more n commands, proposed section about nation merging, cleaned up some wording
* merging is disabled on emc. remove merge todo
* added option to join older servers
* added dynmap color commands to nation commands list and replaced raw url on town claim command with slug
* Apply suggestions from code review (Shops)
Co-authored-by: Fruitloopins <49851457+Fruitloopins@users.noreply.github.com>
* Update src/docs/economy.mdx
Co-authored-by: Fruitloopins <49851457+Fruitloopins@users.noreply.github.com>
* Update src/docs/nation.mdx
Co-authored-by: Fruitloopins <49851457+Fruitloopins@users.noreply.github.com>
* Update src/docs/nation.mdx
Co-authored-by: Fruitloopins <49851457+Fruitloopins@users.noreply.github.com>
* Update src/docs/nation.mdx (nation naming)
Co-authored-by: Fruitloopins <49851457+Fruitloopins@users.noreply.github.com>
* Update src/docs/town.mdx (town gold)
Co-authored-by: Fruitloopins <49851457+Fruitloopins@users.noreply.github.com>
* Update economy.mdx
* Change spacing on nation.mdx
* Update town.mdx spacing
* Update economy.mdx
* Update nation.mdx
---------
Co-authored-by: Fruitloopins <49851457+Fruitloopins@users.noreply.github.com>
---
src/docs/economy.mdx | 4 +-
src/docs/how-to-join-earthmc.mdx | 2 +-
src/docs/nation.mdx | 55 ++++++++++--------
src/docs/town.mdx | 96 +++++++++++++++++---------------
4 files changed, 88 insertions(+), 69 deletions(-)
diff --git a/src/docs/economy.mdx b/src/docs/economy.mdx
index a8b4ee6..91e574b 100644
--- a/src/docs/economy.mdx
+++ b/src/docs/economy.mdx
@@ -21,10 +21,10 @@ The item-based currency allow players to dig it up straight from the ground. Gol
All town protections are removed when a town falls. Find abandoned towns and loot the riches. Stealing is allowed.
### Voting
-Run the command `/vote` and click the provided links. You can vote right now by visiting the voting sites [here](https://minecraftservers.org/server/383495) and [here](https://servers-minecraft.net/server-earthmc.1042/vote). You will receive a gold crate with a random award of up to 64 gold ingots after successfully voting for the server. Keep in mind that you are able to vote without being online. Your award will be given to you next time you sign in and can be claimed with `/cr claim`. The most likely award is 4 gold per vote link. It's also possible to win tridents and mending enchantment books from voting although they are very rare.
+Run the command `/vote` and click the two links provided to you. You will receive a gold crate for each site you successfully submit a vote to. Currently, you can receive up to two gold crates per 24-hour day cycle. You can receive up to 64 gold or a special item reward on each gold crate you earn. Remember that you can vote even if you're not online, but you won't receive any rewards.
### Shops
-Open a shop and sell items to other players. The only thing you need is stock, competitive pricing, and a good location. Hit a chest with the item you want to sell and follow the instructions. The most successful shops are built in capitals. Capitals have the benefit of attracting a lot of customers through the nation spawn. The shopping districts of capitals are usually one of the main sources of income for nations and players alike.
+Open a shop and sell items to other players. The only thing you need is sufficient stock of the item you are trying to sell, competitive pricing, and a good location. Left-click a chest with the item you want to sell and follow the instructions. The most successful shops are built in nation capitals, nation capitals have the benefit of attracting a lot of customers through the nation spawn. The shopping districts of capitals are usually one of the main sources of income for nations and players alike.
To learn more about shops, check out the [shops](/shops) page.
### Stock exchanges
While stock exchanges are not officially supported, players have been able to replicate real-life exchanges and make gold from them. Limited pieces of signed paper represent the stocks and can be traded and bought. Stock exchanges are not recommended for newcomers.
diff --git a/src/docs/how-to-join-earthmc.mdx b/src/docs/how-to-join-earthmc.mdx
index 68c7c38..76c5269 100644
--- a/src/docs/how-to-join-earthmc.mdx
+++ b/src/docs/how-to-join-earthmc.mdx
@@ -24,7 +24,7 @@ You're in! Good luck with your adventure!
:::info Queue
-You will be placed in a queue **if the server is full**. You can check your position with `/queue`. You will be moved to the main world once you have passed the queue.
+You will be placed in a queue **if the server is full**. You can check your position with `/queue`. You will be moved to the main world once you have passed the queue. You can also join the queue for previous versions of the server with `/joinqueue ` where you can visit our Terra Nova and Classic EMC servers. Note that our Classic is accesible through spectator mode only.
:::
diff --git a/src/docs/nation.mdx b/src/docs/nation.mdx
index 01a2c38..8a87143 100644
--- a/src/docs/nation.mdx
+++ b/src/docs/nation.mdx
@@ -6,20 +6,23 @@ sidebar_position: 8
sidebar_label: Nation Guide
custom_edit_url: https://github.com/EarthMC/earthmc-docs/blob/main/src/docs/nation.mdx
---
+
# Nation guide
![town](/img/nation.webp)
## Create a nation
-Creating a new nation costs 1024 gold on Terra Nova and 2048 gold on Terra Aurora. Make sure you deposited the required amount in town's bank via `/t deposit `. Only a mayor of a town can create a nation. The mayor's town will become the nation capital. Create the nation with `/n new `.
+
+Creating a new nation costs 2048 gold on Aurora and 1024 gold on Terra Nova. Make sure you have deposited the required amount to the town's bank via `/t deposit `. Only the mayor of a town can create a nation. The mayor's town will become the nation capital. Create the nation with `/n new `.
:::caution
-Make sure your nation's name complies with the nation naming [rules](https://earthmc.net/docs/rules).
+Make sure your nation's name complies with the nation naming rules in rule 2.1 [rules](https://earthmc.net/docs/rules).
:::
## Nation basics
+
As a nation leader, you can add allies with `/n ally add ` and invite towns to your nation with `/n add `. Do note that a town needs to be within a radius of 3500 blocks from your capital's home plot to be eligible for invitation.
Give and remove ranks from residents of your nation with `/n rank add ` or `/n rank remove `. You can also kick towns from the nation with `/n kick `, delete the nation with `/n delete`, toggle public joining to your nation with `/n toggle open`, and set the nation's spawn location anywhere within your capital with `/n set spawn`.
@@ -29,32 +32,40 @@ Due to nations starting with no allies, you will likely want to get a lot as qui
As your nation gains more citizens, your ranking on `/n list` will increase. Nations fight each other to be on the top of this list as it shows who has put the most time into recruiting towns and players, which is a good indicator of activity. Nations (as well as towns) can also compete in a few categories. These leaderboards can be seen via `/nation (or /town) list by category` (categories should be automatically shown to the command sender).
## Nation ranks
+
Nation kings can give nation residents ranks with `/n rank add `.
-* **Chancellor** allows the player to do everything a king can do, except of: deleting the nation, setting the capital and setting the king. This is a dangerous rank to give as a player! The unwanted individual could remove allies or kick every town from your nation.
-* **Colonists** may invite towns to the nation.
-* **Royal-treasurers** can not only deposit, but also withdraw gold from the national bank.
-* **Diplomats** are able to send, accept and deny nation ally requests.
+- **Chancellor** allows the player to do everything a king can do, except of: deleting the nation, setting the capital and setting the king. This is a dangerous rank to give as a player! The unwanted individual could remove allies or kick every town from your nation.
+- **Colonists** may invite towns to the nation.
+- **Diplomats** are able to send, accept and deny nation ally requests.
## Nation commands
+
:::note
-Only king and nation residents with appropriate ranks can run nation commands.
+Only the king of the nation can run all of these commands. Chancellors are not allowed to run `/n set king` and `/n delete`.
:::
-| Command | Description |
-| ---------------------------------- |:--------------------------------------------- |
-| /n [name] | Get information of specified nation |
-| /n new [name] | Create a new nation |
-| /n leave | Makes your town leave nation |
-| /n withdraw [amount] | Withdraw gold from nation bank |
-| /n deposit [amount] | Deposit gold from nation bank |
-| /n add [town] | Invite town to nation |
-| /n kick [town] | Kick a town from nation |
-| /n ally add/remove [nation] | Add/remove nation ally |
-| /n rank add/remove [player] [rank] | Grant/revoke rank from nation resident |
-| /n set king [player] | King command to change the king of the nation |
-| /n set title [player] [title name] | set player's title (e.g.change King by Queen) |
-| /n set capital [town] | Set nation capital |
-| /n set spawn | Set nation spawn at your location |
+| Command | Description |
+| ------------------------------------------------------------ | :------------------------------------------------------- |
+| /n [name] | Get information of specified nation |
+| /n new [name] | Create a new nation |
+| /n leave | Makes your town leave nation |
+| /n withdraw [amount] | Withdraw gold from nation bank |
+| /n deposit [amount] | Deposit gold from nation bank |
+| /n add [town] | Invite town to nation |
+| /n kick [town] | Kick a town from nation |
+| /n ally add/remove [nation] | Add/remove nation ally |
+| /n enemy add/remove [nation] | Add/remove nation enemy. Removes or prevents an alliance |
+| /n rank add/remove [player] [rank] | Grant/revoke rank from nation resident |
+| /n toggle open | Toggle public joining to your nation |
+| /n delete | Delete nation |
+| /n set king [player] | King command to change the king of the nation |
+| /n set capital [town] | Set nation capital |
+| /n set spawn | Set nation spawn at your location |
+| /n set board [message] | Set nation message of the day |
+| /n set taxes [amount] | Set nation taxes per 24-hour cycle |
+| /n set title [title] | Set titles for members of your nation |
+| /emcmap nationcolor [HEX colour] | Set nation colour on EMC map (**Premium Only**) |
+| /emcmap nationoutline [HEX colour] | Set nation outline colour on EMC map (**Premium Only**) |
diff --git a/src/docs/town.mdx b/src/docs/town.mdx
index c65d1ae..342f1a2 100644
--- a/src/docs/town.mdx
+++ b/src/docs/town.mdx
@@ -7,6 +7,7 @@ sidebar_label: Town Guide
custom_edit_url: https://github.com/EarthMC/earthmc-docs/blob/main/src/docs/town.mdx
pagination_next: claimland
---
+
# Town guide
![town](/img/town.png)
@@ -14,11 +15,11 @@ pagination_next: claimland
## The essentials
1. Find a town to join. You may either request invitation or join an open town. Once invited, type `/accept` or click the prompt in chat. You can join open towns via `/t join `.
-2. Creating a town costs 64 gold ingots. Once you earned the required amount of gold, go to the location where you want the town to be. Then, type `/t new ` and accept the prompt. It will create a town with a single chunk.
+2. Creating a town costs 64 gold ingots. Once you have earned the required amount of gold, go to the location where you want the town to be. Then, type `/t new ` and accept the prompt. It will create a town with a single chunk.
3. Basic commands for towns:
-* `/t spawn` teleports you to town's spawn.
-* `/t invite ` invites players to your town.
-* `/t leave` allows you to leave town. It must not be owned by you.
+- `/t spawn` teleports you to town's spawn.
+- `/t invite ` invites players to your town.
+- `/t leave` allows you to leave town. It must not be owned by you.
4. Claiming more land costs gold. One chunk costs 16 gold ingots. Stand in unclaimed chunk and type `/t claim`. Be sure you deposited the required amount in town bank via `/t deposit `.
5. Your town can join a nation via `/n join ` (or be invited as well). You can only join nations whose capital's homeblock is within 3000 blocks of your town's homeblock. The nation must either be open as seen on `/n `, or your town has to be invited. Accept the invite using `/t invite accept `.
@@ -31,48 +32,54 @@ Avoid giving your residents a pre-made house and too much free gear. Let your re
:::
## Town permissions
+
Town permissions manage what residents have access to interact with inside a town. There are 4 permission types:
-* **Build** - Place blocks inside the town.
-* **Destroy** - Destroy blocks inside the town.
-* **Switch** - Interact with chests, furnaces, levers, hoppers, droppers, and blocks with similar nature.
-* **Item** - Interact with water, lava, buckets, lighters, bone meal, ender pearls, bottles, and items of similar nature.
+
+- **Build** - Place blocks inside the town.
+- **Destroy** - Destroy blocks inside the town.
+- **Switch** - Interact with chests, furnaces, levers, hoppers, droppers, and blocks with similar nature.
+- **Item** - Interact with water, lava, buckets, lighters, bone meal, ender pearls, bottles, and items of similar nature.
All town permissions are disabled by default, as a mayor you can grant permissions by giving ranks with `/t rank add ` or by selling individual plots to residents with `/plot fs `. It's also possible to change permissions specifically for allies and outsiders. For example, `/t set perm ally build on` would allow residents of allied nations to build inside the town. You can interact this way with individual chunks (called plots), too. More on that later.
## Plots
-![town](/img/plots.webp)
-Plots are used to manage land *inside* the town. Plots can be sold to residents, have different properties and different permissions. Individual plots have the exact same size as town claims and Minecraft chunks which can be conveniently displayed with the chunk debug screen toggled with `F3+G`.
+
+![town](/img/plots.webp) Plots are used to manage land _inside_ the town. Plots can be sold to residents, have different properties and different permissions. Individual plots have the exact same size as town claims and Minecraft chunks
+which can be conveniently displayed with the chunk debug screen toggled with `F3+G`.
A mayor can add land to a town by claiming nearby wilderness for a cost of 16 gold `/t claim`. Read more about claiming [here](https://earthmc.net/docs/how-to-claim-land). A mayor or other high-ranking town members can change permissions of individual plots and sell plots to residents. Residents can buy plots in their own town, but can't add new land to a town. This can cause confusion, especially since “plots” and “claims” are sometimes used interchangeably within the community.
Plots are useful since they allow towns to be divided for different purposes and town residents. A newly claimed chunk has the default plot settings/permissions and is only accessible by the mayor and residents with appropriate town ranks. A mayor or plot owner can put the plot up for sale by standing in the plot and running command `/plot fs `. This allows town residents to buy it. To buy a plot, stand inside it and run command `/plot claim`. Buying a plot gives you full permissions to that 16x16 plot of land. Run `/plot unclaim` to remove yourself from the plot.
-:::tip
+:::tip
-Remember that a resident is an asset to your town and it can often make sense to give plots away for free. Residents are likely to leave if they don't find anywhere to build. Make it easy for new residents to find plots for sale.
+Remember that a resident is an asset to your town and it can often make sense to give plots away for free. Residents are likely to leave if they don't find anywhere to build. Make it easy for new residents to find plots for sale.
:::
### Plot types
+
Once you have access to a plot you may alter it in several ways. The first thing is to select what type of plot it is. Different types of plots have different types of properties. A plot can not have multiple types set at the same time. Set plot type with command `/plot set `.
-| Plot type | Description |
-| --------- |:------------|
-| Default | The default plot type. Useful for personal builds, such as homes or other forms of town bases. |
-| Shop | Required in order to create shops. |
-| Arena | Enables PvP inside the plot. |
-| Farm | Allows nation residents to harvest farms inside the plot, but not break any other types of blocks. It's also possible to damage mobs in farm plots. |
+| Plot type | Description |
+| --------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| Default | The default plot type. Useful for personal builds, such as homes or other forms of town bases. |
+| Shop | Required in order to create shops. |
+| Arena | Enables PvP inside the plot. |
+| Farm | Allows nation residents to harvest farms inside the plot, but not break any other types of blocks. It's also possible to damage mobs in farm plots. |
| Embassy | This allows any player to buy the plot, regardless of what town they may belong to. Owning an embassy and changing plot type will still make you the owner. This is useful when creating shops in different towns, expanding your markets abroad. |
-| Inn | Allows other than plot owner to use beds inside the plot. |
+| Inn | Allows other than plot owner to use beds inside the plot. |
### Plot permissions
+
It's possible to alter individual plot permissions. Plot permissions override global town permissions and work very similar to town permissions. Run `/plot set `. Please see town permission section for explanation of what each permission type covers.
It's also possible to toggle certain behaviors inside the plot. Run `/plot toggle `.
### Plot commands summary
+
| Command | Description |
-| --------------------------------------------- |:--------------------------------|
+| --------------------------------------------- | :------------------------------ |
| /plot fs price | Set plot for sale |
| /plot claim | Buy available plot |
| /plot unclaim | Remove yourself from plot |
@@ -81,35 +88,36 @@ It's also possible to toggle certain behaviors inside the plot. Run `/plot toggl
| /plot toggle [explosion/fire/mobs/pvp] | Toggle specific values for plot |
## Town ranks
+
Mayors can give ranks to residents with `/t rank add `.
-* **Councillor** gives the player full access to town plots regardless of ownership, access to most town commands excluding `/t unclaim`, `/t set mayor `, `/t delete`, etc. This rank should only be given to the most trusted citizens as it could be detrimental to your town. They can kick everyone except the mayor and other councillors, withdraw gold from the town bank and edit town/plot's permissions.
-* **Trusted** is very similar to the Councillor rank in that they can access any plot regardless of ownership, but they cannot use the most advanced commands as a councillor could.
-* **Builders** may access every plot not owned by an individual. They can build, open chests, use items and break blocks anywhere in the town as long as the plot is not owned by a player.
-* **Settlers** can claim chunks for the town with `/t claim`.
-* **Recruiters** are able to invite other players with `/t add `.
-* **Police** might add users to the town outlaw list with `/t outlaw add `.
-* **Treasurers** are allowed to use `/t withdraw ` to withdraw gold from the town bank.
+- **Councillor** gives the player full access to town plots regardless of ownership, access to most town commands excluding `/t unclaim`, `/t set mayor `, `/t delete`, etc. This rank should only be given to the most trusted citizens as it could be detrimental to your town. They can kick everyone except the mayor and other councillors, withdraw gold from the town bank and edit town/plot's permissions.
+- **Trusted** is very similar to the Councillor rank in that they can access any plot regardless of ownership, but they cannot use the most advanced commands as a councillor could.
+- **Builders** may access every plot not owned by an individual. They can build, open chests, use items and break blocks anywhere in the town as long as the plot is not owned by a player.
+- **Settlers** can claim chunks for the town with `/t claim`.
+- **Recruiters** are able to invite other players with `/t add `.
+- **Police** might add users to the town outlaw list with `/t outlaw add `.
+- **Treasurers** are allowed to use `/t withdraw ` to withdraw gold from the town bank.
## Town commands
-| Command | Description |
-| ------------------------------------------------------ |:----------------------------------------------|
-| /t [town] | View information on specific town |
-| /t invite [player] | Invite player to town |
-| /t here | Shows information on town at current location |
-| /t list | List of all towns |
-| /t leave | Leave town |
-| /t new [name] | Create a new town |
-| /t add [player] | Add resident to town |
-| /t kick [player] | Kick resident from town |
-| /t spawn | Teleport to town spawn |
-| [/t claim](https://earthmc.net/docs/how-to-claim-land) | Claim chunk |
-| /t withdraw [amount] | Withdraw gold from town bank |
-| /t deposit [amount] | Deposit gold to town bank |
-| /t rank [add/remove] [player] [rank] | Add/remove a town rank |
-| /t set [board/mayor/homeblock/perm] | Settings for town |
-| /t toggle [explosion/fire/mobs/pvp] | Toggle specific values for town |
+| Command | Description |
+| ------------------------------------ | :--------------------------------------------- |
+| /t [town] | View information on specific town |
+| /t invite [player] | Invite player to town |
+| /t here | Shows information on town at current location |
+| /t list | List of all towns |
+| /t leave | Leave town |
+| /t new [name] | Create a new town |
+| /t add [player] | Add resident to town |
+| /t kick [player] | Kick resident from town |
+| /t spawn | Teleport to town spawn |
+| /t claim | Claim chunk ([Learn more](/how-to-claim-land)) |
+| /t withdraw [amount] | Withdraw gold from town bank |
+| /t deposit [amount] | Deposit gold to town bank |
+| /t rank [add/remove] [player] [rank] | Add/remove a town rank |
+| /t set [board/mayor/homeblock/perm] | Settings for town |
+| /t toggle [explosion/fire/mobs/pvp] | Toggle specific values for town |
:::caution