Skip to content

Commit

Permalink
docs: Correct typos, update config file
Browse files Browse the repository at this point in the history
  • Loading branch information
WiIIiam278 committed Apr 22, 2023
1 parent 8904190 commit 32119ac
Show file tree
Hide file tree
Showing 11 changed files with 76 additions and 75 deletions.
2 changes: 1 addition & 1 deletion docs/API-Events.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
HuskTowns provides several API events your plugin can listen to when players do certain town-related things. These events deal in HuskTowns class types, so you may want to familiarize yourself with the [API basics](API) first. Note that on cross-server setups, events only fire on the *server the event occured on* and will not fire as a result of API calls/updates.
HuskTowns provides several API events your plugin can listen to when players do certain town-related things. These events deal in HuskTowns class types, so you may want to familiarize yourself with the [API basics](API) first. Note that on cross-server setups, events only fire on the *server the event occurred on* and will not fire as a result of API calls/updates.

Consult the Javadocs for more information—and don't forget to register your listener when listening for these event calls.

Expand Down
2 changes: 1 addition & 1 deletion docs/API-v1.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
> ⚠️ **API v1 is deprecated**. Please refer to the new HuskTowns [[API]] v2 for the current API specification.
The HuskTowns API v1 provides methods to get data from HuskTowns directly. API v1 has been deprecated and superceeded by the HuskTownsAPI v2 (See the new [[API]] documentation for more information).
The HuskTowns API v1 provides methods to get data from HuskTowns directly. API v1 has been deprecated and superseded by the HuskTownsAPI v2 (See the new [[API]] documentation for more information).

The API accesses cached data and can be used to check for things such as players being able to build on certain chunks, etc. This page contains how to use the API and provides example usages for developers.

Expand Down
8 changes: 4 additions & 4 deletions docs/Commands.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
HuskTowns has a wide range of commands, each having corresponding permission nodes. Each command has a help menu that can be accessed to view these lists in-game.

## /town command
The `/town` command (base permission: `husktowns.command.town`) is the entry point for all operations. In addition to these permissions, the player may need to have a prerequisite *privilege* to use the command in the town they are in, based on their town role.
The `/town` command (base permission: `husktowns.command.town`) is the entry point for all operations. In addition to these permissions, the player may need to have a prerequisite *privilege* to use the command in the town they are in, based on their town role.

| Command | Description | Permission |
|--------------------|---------------------------------------------|-------------------------------------|
Expand All @@ -14,8 +14,8 @@ The `/town` command (base permission: `husktowns.command.town`) is the entry poi
| `/town unclaim` | Remove a claim | `husktowns.command.town.unclaim` |
| `/town autoclaim` | Toggle auto-claiming chunks as you walk | `husktowns.command.town.autoclaim` |
| `/town map` | View a map of nearby town claims | `husktowns.command.town.map` |
| `/town promote` | Promote a member up the role heirachy | `husktowns.command.town.promote` |
| `/town demote` | Demote a mmeber down the role heirachy | `husktowns.command.town.demote` |
| `/town promote` | Promote a member up the role hierarchy | `husktowns.command.town.promote` |
| `/town demote` | Demote a member down the role hierarchy | `husktowns.command.town.demote` |
| `/town evict` | Evict a member from the town | `husktowns.command.town.evict` |
| `/town leave` | Leave the town | `husktowns.command.town.leave` |
| `/town farm` | Make a claim into a town farm | `husktowns.command.town.farm` |
Expand Down Expand Up @@ -60,7 +60,7 @@ The `/admintown` command (base permission: `husktowns.command.admintown`) is for
The `husktowns.command.admintown.*` permission can be used to grant all administrator (`/admintown`) commands.

## /husktowns command
The `/husktowns` command (base permission: `husktowns.command.husktowns`) is for plugin system maintenence and information.
The `/husktowns` command (base permission: `husktowns.command.husktowns`) is for plugin system maintenance and information.

| Command | Description | Permission |
|----------------------|----------------------------------|---------------------------------------|
Expand Down
17 changes: 8 additions & 9 deletions docs/Config-Files.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ This page contains the configuration structure for HuskTowns.
📁 `plugins/HuskTowns/`
- 📄 `config.yml`: General plugin configuration
- 📄 `levels.yml`: Town level requirements and limits
- 📄 `roles.yml`: Town role hierarchy (see [[Town Roles]])
- 📄 [`roles.yml`](town-roles): Town role hierarchy (see [[Town Roles]])
- 📄 `rules.yml`: Default town/wilderness claim/flag rules
- 📄 `server.yml`: (Cross-server setups only) Server ID configuration
- 📄 `advancements.json`: Town advancements JSON file (see [[Town Advancements]])
- 📄 `messages-xx-xx.yml`: Plugin locales, formatted in MineDown (see [[Translations]])
- 📄 [`advancements.json`](town-advancements): Town advancements JSON file (see [[Town Advancements]])
- 📄 [`messages-xx-xx.yml`](translations): Plugin locales, formatted in MineDown (see [[Translations]])

## Example files
<details>
Expand Down Expand Up @@ -42,8 +42,8 @@ database:
keepalive: 30000
timeout: 20000
table_names:
claim_data: husktowns_claim_worlds
town_data: husktowns_town_data
claim_data: husktowns_claim_worlds
user_data: husktowns_users
cross_server:
# Synchronise towns across a proxy network. Requires MySQL. Don't forget to update server.yml
Expand All @@ -62,6 +62,8 @@ general:
list_items_per_page: 6
inspector_tool: minecraft:stick
max_inspection_distance: 80
# The slot to display claim entry/teleportation notifications in. (ACTION_BAR, CHAT, TITLE, SUBTITLE, NONE)
notification_slot: ACTION_BAR
claim_map_width: 9
claim_map_height: 9
first_claim_auto_setspawn: false
Expand Down Expand Up @@ -96,6 +98,8 @@ towns:
# Town settings. Check rules.yml, roles.yml and levels.yml for more settings
allow_unicode_names: false
allow_unicode_bios: true
# Require the level 1 cost as collateral when creating a town (this cost is otherwise ignored)
require_first_level_collateral: false
# The minimum distance apart towns must be, in chunks
minimum_chunk_separation: 0
# Require towns to have all their claims adjacent to each other
Expand All @@ -105,7 +109,6 @@ towns:
name: Admin
color: '#ff0000'
```
</details>
<details>
Expand Down Expand Up @@ -224,7 +227,6 @@ level_mob_spawner_rate_bonus:
'19': 0.9000000000000001
'20': 1.0
```
</details>
<details>
Expand Down Expand Up @@ -271,7 +273,6 @@ roles:
- chat
- spawn
```
</details>
<details>
Expand Down Expand Up @@ -346,7 +347,6 @@ default_rules:
explosion_damage: false
pvp: false
```
</details>
<details>
Expand All @@ -363,5 +363,4 @@ This file is only present if your server uses cross-server mode to run HuskTowns
# ┗╸ You only need to touch this if you're using cross-server mode.
name: beta
```
</details>
Loading

0 comments on commit 32119ac

Please sign in to comment.