Skip to content

Commit

Permalink
docs: fixup doc links
Browse files Browse the repository at this point in the history
  • Loading branch information
WiIIiam278 committed Feb 5, 2024
1 parent 7af9441 commit 9740a9e
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ Requires Java 17+ and a Minecraft 1.17.1+ Spigot-based server. A MySQL database
3. Navigate to the HuskTowns config file on each server (`~/plugins/HuskTowns/config.yml`)
4. Configure the plugin to your liking. If you are running HuskTowns across multiple servers, enable `cross_server` mode and fill in your MySQL credentials, remembering to change the database type to `MYSQL` as well.
5. You can also modify the level requirements in `~/levels.yml`, the default town rule settings in `~/rules.yml` and the town roles in `~/roles.yml`
6. Start every server again and HuskTowns should have completed installation!
6. Start every server again and HuskTowns should have completed installation!

## Development
To build HuskTowns, simply run the following in the root of the repository:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ public static class GeneralSettings {
"Server"
);

@Comment("Adds special advancements for town progression. Docs: https://william278.net/docs/husktowns/town-advancements/")
@Comment("Adds special advancements for town progression. Docs: https://william278.net/docs/husktowns/advancements/")
private boolean doAdvancements = true;

@Comment("Enable economy features. Requires Vault and a compatible economy plugin. " +
Expand Down Expand Up @@ -310,7 +310,7 @@ public static class TownSettings {
public static class RelationsSettings {

@Comment("Enable town relations (alliances and enemies). " +
"Docs: https://william278.net/docs/husktowns/town-relations/")
"Docs: https://william278.net/docs/husktowns/relations/")
private boolean enabled = true;

@Comment("Town War settings")
Expand All @@ -323,7 +323,7 @@ public static class WarSettings {

@Comment("Allow mutual enemy towns to agree to go to war. Requires town relations to be enabled. " +
"Wars consist of a battle between members, to take place at the spawn of the defending town" +
"Docs: https://william278.net/docs/husktowns/town-wars/")
"Docs: https://william278.net/docs/husktowns/wars/")
private boolean enabled = false;

@Comment("The number of hours before a town can be involved with another war after finishing one")
Expand Down
2 changes: 1 addition & 1 deletion docs/Claims.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ You can set "flags" that change the properties of how users interact within clai

To edit the town flag rules, use the `/town rules` clickable menu to edit the flag properties for the three different types of claims (claims, farms and plots).

Note that if you are using [[Town Wars]], special rules apply to participants in towns at war.
Note that if you are using [[Wars]], special rules apply to participants in towns at war.

## 3.1 Unclaimable worlds
If you are an administrator, you can define "unclaimable worlds" in the server config.yml file, which will prevent users from claiming land in those worlds. By default, the `world_nether` and `world_the_end` worlds are unclaimable worlds, meaning players can't make town claims in those dimensions.
Expand Down
4 changes: 2 additions & 2 deletions docs/Commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ The `/town` command (base permission: `husktowns.command.town`) is the entry poi
| `/town player` | View which town a player is a member of | `husktowns.command.town.player` |
| `/town deeds` | View a list of town claims on this server | `husktowns.command.town.deeds` |
| `/town census` | View a list of town members and their roles | `husktowns.command.town.census` |
| `/town relations` | Manage [[Town Relations]] if enabled | `husktowns.command.town.relations` |
| `/town war` | View and declare [[Town Wars]] if enabled | `husktowns.command.town.war` |
| `/town relations` | Manage [[Relations]] if enabled | `husktowns.command.town.relations` |
| `/town war` | View and declare [[Wars]] if enabled | `husktowns.command.town.war` |
| `/town log` | View the town audit log | `husktowns.command.town.log` |
| `/town transfer` | Transfer ownership of the town to someone | `husktowns.command.town.transfer` |
| `/town disband` | Delete the town | `husktowns.command.town.disband` |
Expand Down
10 changes: 5 additions & 5 deletions docs/Config-Files.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@ This page contains the configuration structure for HuskTowns.
- 📄 `config.yml`: General plugin configuration
- 📄 `flags.yml`: Flag definition configuration
- 📄 `levels.yml`: Town level requirements and limits
- 📄 [`roles.yml`](Roles): Town role hierarchy (see [[Town Roles]])
- 📄 [`roles.yml`](Roles): Town role hierarchy (see [[Roles]])
- 📄 `rules.yml`: Default town/wilderness claim/flag rules
- 📄 `server.yml`: (Cross-server setups only) Server ID configuration
- 📄 [`advancements.json`](Advancements): Town advancements JSON file (see [[Town Advancements]])
- 📄 [`advancements.json`](Advancements): Town advancements JSON file (see [[Advancements]])
- 📄 [`messages-xx-xx.yml`](translations): Plugin locales, formatted in MineDown (see [[Translations]])

## Example files
Expand Down Expand Up @@ -149,11 +149,11 @@ towns:
boost_particle: spell_witch
# Relations settings
relations:
# Enable town relations (alliances and enemies). Docs: https://william278.net/docs/husktowns/town-relations/
# Enable town relations (alliances and enemies). Docs: https://william278.net/docs/husktowns/relations/
enabled: true
# Town War settings
wars:
# Allow mutual enemy towns to agree to go to war. Requires town relations to be enabled. Wars consist of a battle between members, to take place at the spawn of the defending townDocs: https://william278.net/docs/husktowns/town-wars/
# Allow mutual enemy towns to agree to go to war. Requires town relations to be enabled. Wars consist of a battle between members, to take place at the spawn of the defending townDocs: https://william278.net/docs/husktowns/wars/
enabled: false
# The number of hours before a town can be involved with another war after finishing one
cooldown: 48
Expand Down Expand Up @@ -375,7 +375,7 @@ level_mob_spawner_rate_bonus:
# ┣╸ This file is for configuring town roles and associated privileges.
# ┣╸ Each role is mapped to a weight, identifying its hierarchical position. Each weight is also mapped to the role name.
# ┣╸ Config Help: https://william278.net/docs/husktowns/config-files
# ┗╸ Documentation: https://william278.net/docs/husktowns/town-roles
# ┗╸ Documentation: https://william278.net/docs/husktowns/roles

# Map of role weight IDs to display names
names:
Expand Down
2 changes: 1 addition & 1 deletion docs/Relations.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ If you have the `MANAGE_RELATIONS` privilege in the town you are in, you can use
Towns that you have marked as an Ally grant one additional property: If the option to restrict friendly fire is enabled, PvP between two allied towns will not be permitted.

### 2.2 Enemies & War
If you enable [[Town Wars]] on your server, towns which mark each other as enemies will be able to declare and go to war with each other.
If you enable [[Wars]] on your server, towns which mark each other as enemies will be able to declare and go to war with each other.

### 2.3 Neutral relations
Towns not marked as an ally or enemy are considered to have a "neutral" relation. In other words, this is your default relation with other towns on the server.
Expand Down
4 changes: 2 additions & 2 deletions docs/Roles.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ Role privileges are how you specify what rights each role has in your town. The
| `set_farm` | Make a claimed chunk into a farm |
| `set_plot` | Make a claimed chunk into a plot |
| `manage_plot_members` | Add members and managers to a plot |
| `manage_relations` | Manage [[Town Relations]], if enabled |
| `declare_war` | Declare and manage [[Town Wars]], if enabled |
| `manage_relations` | Manage [[Relations]], if enabled |
| `declare_war` | Declare and manage [[Wars]], if enabled |
| `trusted_access` | Build anywhere in the town, including outside of plots |
| `unclaim` | Remove a claim |
| `claim` | Create a claim |
Expand Down
4 changes: 2 additions & 2 deletions docs/Towns.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Each role in the history has associated privileges, including inherited privileg

</details>

See [[Town Roles]] for more information on role customisation.
See [[Roles]] for more information on role customisation.

### 2.3 Town census / member list
To view the list of members for any given town, grouped by role, use the `/town census [name]` command.
Expand Down Expand Up @@ -102,4 +102,4 @@ Your town has a spawn point that you can teleport to, which must be located in o
If you wish to allow members from outside your town to teleport to your town spawn, use `/town privacy public` to make the spawn public. Anyone can then use `/town spawn <name>` to pay a visit.

## 5. Town relations
If you have [[Town Relations]] enabled, you can set relations with other towns on the server using the `/town relations` command.
If you have [[Relations]] enabled, you can set relations with other towns on the server using the `/town relations` command.
2 changes: 1 addition & 1 deletion docs/Wars.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
> **Warning:** This feature is currently marked as experimental, and you may experience bugs while using it. If you have feedback, please send it to me!
Town wars, added in HuskTowns v2.6, allow [[Towns]] which are marked as [mutual enemies](Relations) to go to war! This feature requires the [[Town Relations]] feature to be enabled.
Town wars, added in HuskTowns v2.6, allow [[Towns]] which are marked as [mutual enemies](Relations) to go to war! This feature requires the [[Relations]] feature to be enabled.

## 1. Enabling Town Wars
To enable town wars, look for the `wars` subsection under the `relations` part of your config file. Ensure both `enabled` settings are set to `true`.
Expand Down

0 comments on commit 9740a9e

Please sign in to comment.