diff --git a/docs/API-Events.md b/docs/API-Events.md index 55c656e5..c2f4d5a7 100644 --- a/docs/API-Events.md +++ b/docs/API-Events.md @@ -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. diff --git a/docs/API-v1.md b/docs/API-v1.md index 1039d1bf..b2ceeda7 100644 --- a/docs/API-v1.md +++ b/docs/API-v1.md @@ -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. diff --git a/docs/Commands.md b/docs/Commands.md index 847a4458..16c4dc2d 100644 --- a/docs/Commands.md +++ b/docs/Commands.md @@ -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 | |--------------------|---------------------------------------------|-------------------------------------| @@ -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` | @@ -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 | |----------------------|----------------------------------|---------------------------------------| diff --git a/docs/Config-Files.md b/docs/Config-Files.md index 2695ab7e..6e7fcdbe 100644 --- a/docs/Config-Files.md +++ b/docs/Config-Files.md @@ -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
@@ -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 @@ -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 @@ -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 @@ -105,7 +109,6 @@ towns: name: Admin color: '#ff0000' ``` -
@@ -224,7 +227,6 @@ level_mob_spawner_rate_bonus: '19': 0.9000000000000001 '20': 1.0 ``` -
@@ -271,7 +273,6 @@ roles: - chat - spawn ``` -
@@ -346,7 +347,6 @@ default_rules: explosion_damage: false pvp: false ``` -
@@ -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 ``` -
\ No newline at end of file diff --git a/docs/Getting-Started.md b/docs/Getting-Started.md index 28b2d774..c2781c6b 100644 --- a/docs/Getting-Started.md +++ b/docs/Getting-Started.md @@ -1,14 +1,16 @@ -Once you have [installed HuskTowns](Setup) on your server, in order to get started using the plugin, you'll need to either make a new town, or accept an invite from another player to join one. Players can only be in one town at a time and each town has a single mayor. +Once you have [installed HuskTowns](setup) on your server, in order to get started using the plugin, you'll need to either make a new town, or accept an invitation from another player to join one. Players can only be in one town at a time and each town has a single mayor. ## 1 Creating a town -To make a town, type `/town create `. This will make a new town at level 1 with the given name. The name must not contain any whitespace characters. +To make a town, type `/town create `. This will make a new town at level 1 with the given name. + +If your server has the `towns.require_first_level_collateral` setting enabled, then creating a town will cost the price of "level 1" as defined in [`levels.yml`](config-files). The name mustn't contain any whitespace characters. ### 1.1 Customising You can change the color, bio, greeting and farewell messages of your town. Each changes the way your town appears to other players. -* Town Color - the color of your town on claim maps. Change with `/town color <#rgb>` -* Town Bio - the bio of your town that appears on your `/town info ` page, and on hover in the `/town list`. Change with `/town bio ` -* Town Greeting Message - the message that will be shown to players as they walk into your claims. Change with `/town greeting ` -* Town Farewell Message - the message that will be shown to players as they walk out of your claims. Change with `/town farewell ` +* **Town Color**β€”the color of your town on claim maps. Change with `/town color <#rgb>` +* **Town Bio**β€”the bio of your town that appears on your `/town info ` page, and on hover in the `/town list`. Change with `/town bio ` +* **Town Greeting Message**β€”the message that will be shown to players as they walk into your claims. Change with `/town greeting ` +* **Town Farewell Message**β€”the message that will be shown to players as they walk out of your claims. Change with `/town farewell ` You can also rename the town using `/town rename ` if you've changed your mind. @@ -24,35 +26,35 @@ You can view a list of towns using the `/town list` command. You can use the pag You can send messages privately to fellow town members using `/town chat `. ## 2 Adding members -You can invite members to your town using `/town invite `. Note you can only invite players who are not currently the member of a town. +You can invite members to your town using `/town invite `. Note you can only invite players who aren't currently the member of a town. ### 2.1 Managing access -You can promote and demote members up and down the town role heirachy, as it has been setup on the server. To promote a member, use `/town promote `. Likewise, to demote a user, use `/town demote `. Note you cannot promtoe members to or who are an equal or higher role in the town heirachy than yourself. +You can promote and demote members up and down the town role hierarchy, as it has been set up on the server. To promote a member, use `/town promote `. Likewise, to demote a user, use `/town demote `. Note you can't promise members to or who are an equal or higher role in the town history than yourself. ### 2.2 Privileges -Each role in the heirachy has associated privileges, including inherited privileges from roles lower down in the heirachy. For example, by default, only the mayor can rename the town and only trustees can invite other members. +Each role in the history has associated privileges, including inherited privileges from roles lower down in the hierarchy. For example, by default, only the mayor can rename the town and only trustees can invite other members.
-Default role heirachy +Default role hierarchy -| Role Weight | Role Name | Privileges | -|:-----------:|:---------:|------------------------------------------------------------------------------------------------| -| 3 | Mayor | `set_bio`, `evict`, `promote`, `demote`, `withdraw`, `level_up`, `set_rules`, `rename`, `set_color` | -| 2 | Trustee | `set_farm`, `set_plot`, `manage_plot_members`, `trusted_access`, `unclaim`, `claim`, `set_greeting`, `set_farewell`, `invite`, `set_spawn`, `spawn_privacy`, `view_logs`| -| 1 | Resident | `deposit`, `chat`, `spawn`| +| Role Weight | Role Name | Privileges | +|:-----------:|:---------:|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| 3 | Mayor | `set_bio`, `evict`, `promote`, `demote`, `withdraw`, `level_up`, `set_rules`, `rename`, `set_color` | +| 2 | Trustee | `set_farm`, `set_plot`, `manage_plot_members`, `trusted_access`, `unclaim`, `claim`, `set_greeting`, `set_farewell`, `invite`, `set_spawn`, `spawn_privacy`, `view_logs` | +| 1 | Resident | `deposit`, `chat`, `spawn` |
See [[Town Roles]] for more information on role customisation. ### 2.3 Town census / member list -To view a list of members of any given town, grouped by role, use the `/town census [name]` command. +To view the list of members for any given town, grouped by role, use the `/town census [name]` command. ### 2.4 Evicting members -If you have the privilege to do so, you can evict a member with `/town evict `. Note you cannot evict members with an equal or higher role than yourself. +If you have the privilege to do so, you can evict a member with `/town evict `. Note you can't evict members with an equal or higher role than yourself. ### 2.5 Leaving a town -If you want to leave your town, you can do so with `/town leave`. The mayor cannot leave their own town; they must first transfer ownership or delete it instead. +If you want to leave your town, you can do so with `/town leave`. The mayor can't leave their own town; they must first transfer ownership or delete it instead. ### 2.6 Transferring and deleting The mayor of the town can transfer ownership of it to another member of the town using `/town transfer `. They can also choose to delete the town with `/town delete` if they wish, which will also remove all the towns' claims. @@ -60,7 +62,7 @@ The mayor of the town can transfer ownership of it to another member of the town ## 3 Levelling up your town Towns have a bank balance ("coffers") and level, which starts at 1. By levelling up your town, you can increase the maximum number of claims and members your town can have, as well as gain boosted crop growth rates and mob spawner spawn rates within your town's farm chunks. -To level up your town, you must deposit money into your town coffers using `/town deposit `. When your town meets the level up threshold, you can then use `/town levelup` to spend money out of your town coffers to raise your town level by 1. Members with privileges can also do `/town withdraw ` to withdraw from the town coffers at any time. +To level up your town, you must deposit money into your town coffers using `/town deposit `. When your town meets the level-up threshold, you can then use `/town levelup` to spend money out of your town coffers to raise your town level by 1. Members with privileges can also do `/town withdraw ` to withdraw from the town coffers at any time. ### 3.1 Level requirements If you're the administrator, you can edit these by modifying the `levels.yml` file. @@ -96,20 +98,20 @@ If you're the administrator, you can edit these by modifying the `levels.yml` fi ## 4 Making claims Claims are chunk-based. To claim a chunk of land for your town, type `/town claim`. -There are a few different types of claims you can make. By default, only members of your town with the `trusted_access` privilege (i.e. Trustees and the Mayor in the default role heirachy) can build in town claims, but you can create "farm" claims to designate public areas of your town any member can build in and "plot" claims to allocate parts of your town to members if you wish as well. +There are a few different types of claims you can make. By default, only members of your town with the `trusted_access` privilege (i.e. Trustees and the Mayor in the default role hierarchy) can build in town claims, but you can create "farm" claims to designate public areas of your town any member can build in and "plot" claims to allocate parts of your town to members if you wish as well. Outside of claims (the "Wilderness"), anyone is able to build by default. You can customise the "town rules" (see below for more information) of the Wilderness by editing the `rules.yml` file. -### 4.1 The claims map -You can use the `/town map` command to view a map of nearby claims on a grid view in chat. This will also highlight the chunk you are standing on with colored particles around the edges. +### 4.1 The claim map +You can use the `/town map` command to view a map of nearby claims on a grid view in chat. This will also highlight the chunk you're standing on with colored particles around the edges. -Clicking a dark gray ("Wilderness") square will claim that chunk for your town and re-open the map, to allow for efficient claiming. +Clicking a dark gray ("Wilderness") square will claim that chunk for your town and reopen the map, to allow for efficient claiming. ### 4.2 Auto-claiming You can toggle auto-claiming, which automatically claims chunks for your town as you walk into them, using the `/town autoclaim` command. ### 4.3 Inspecting claims -You can right click a chunk with the claim inspection tool to see if it has been claimed. This will highlight the chunk you are standing on with colored particles around the edges if it has been claimed and tell you which town it belongs to. +You can right-click a chunk with the claim inspection tool to see if it has been claimed. This will highlight the chunk you're standing on with colored particles around the edges if it has been claimed and tell you which town it belongs to. The claim inspection tool is a `stick` by default and can be changed in the config.yml file if you wish. @@ -134,13 +136,13 @@ You can designate someone as a "manager" of a town plot, which will let them add You can remove someone from a plot with `/town plot remove ` and view a simple list of plot members with `/town plot list`. ### 4.5 Town farms -To make a town claim into a town farm claim, stand in it and type `/town farm`. Mob spawners and crops in town farms spawn/grow at boosted rates based on your town's level. Any member of your town can break and place farm blocks, crops, interact with mobs as well as access containers in town farms. They cannot, however, build or break most structures. +To make a town claim into a town farm claim, stand in it and type `/town farm`. Mob spawners and crops in town farms spawn/grow at boosted rates based on your town's level. Any member of your town can break and place farm blocks, crops, interact with mobs as well as access containers in town farms. They can't, however, build or break most structures. ### 4.6 Town deeds / claims list -To view a list of claims made by any given town on the server you are on, use the `/town deeds [name]` command. +To view a list of claims made by any given town on the server you're on, use the `/town deeds [name]` command. ### 4.7 Town rules -You can set "flags" that change the properties of how users interact within claims, for example such as by enabling/disabling PvP, explosions, fire spread and monster spawning or changing build, container and interact access for non-town members. +You can set "flags" that change the properties of how users interact within claims, for example, such as by enabling/disabling PvP, explosions, fire spread and monster spawning or changing build, container and interact access for non-town members. 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). @@ -150,7 +152,7 @@ Administrators can make claims to protect pieces of land from harm. As an admini Admin claims have their own special set of town rules, which administrators can configure in the `rules.yml` file. ## 4.9 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 cannot make town claims in those dimensions. +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. Unclaimable worlds have their own special set of town rules, which administrators can configure in the `rules.yml` file. diff --git a/docs/Legacy-Migration.md b/docs/Legacy-Migration.md index 2186d355..70adfc5e 100644 --- a/docs/Legacy-Migration.md +++ b/docs/Legacy-Migration.md @@ -1,36 +1,36 @@ This page details the process of migrating from HuskTowns v1.8.2 to HuskTowns v2.x. -HuskTowns' migrator will migrate all existing claims to HuskTowns v2.x—*except for Admin claims*. Due to the differences in how the claim system saves data, you will need to re-create admin claims after you have completed setup and migration using `/admintown claim`. +HuskTowns' migrator will migrate all existing claims to HuskTowns v2.x—*except for Admin claims*. Due to the differences in how the claim system saves data, you will need to re-create admin claims after you've completed setup and migration using `/admintown claim`. ## Migration walkthrough -> βœ… Ensure all servers are offline and that users cannot connect to your network before beginning migration +> βœ… Ensure all servers are offline and that users can't connect to your network before beginning migration -Please follow the steps below to upgrade from HuskTowns v1.8.2. If you are running an earlier version, please update to HuskTowns v1.8.2 first before migrating from v2.x. +Please follow the steps below to upgrade from HuskTowns v1.8.2. If you're running an earlier version, please update to HuskTowns v1.8.2 first before migrating from v2.x. ### 1 Removing the old files 1. Navigate to `~/plugins/HuskTowns/` on your server 2. Move all the files out of this folder, placing them somewhere safe on your computer 3. Delete the HuskTowns v1.8.2 jar file from your `~/plugins/` folder and replace it with HuskTowns v2.x -4. Repeat steps 1-3 for each server running HuskTowns on your network (if you are using cross-server mode). -5. Start all your servers, then stop them shortly afterwards. +4. Repeat steps 1-3 for each server running HuskTowns on your network (if you're using cross-server mode). +5. Start all your servers, then stop them shortly afterward. ### 2 Configuring the plugin 1. Navigate to `~/plugins/HuskTowns/` on your server and check that the plugin has generated new config files -3. Open the newly generated `config.yml` and your old v1 `config.yml` you copied over earlier side-by-side. - 1. If you previously used MySQL: set the database type to `MYSQL` and enter your connection credentials—but make sure that the table names are new names and do not match the existing table names used. +2. Open the newly generated `config.yml` and your old v1 `config.yml` you copied over earlier side-by-side. + 1. If you previously used MySQL: set the database type to `MYSQL` and enter your connection credentials—but make sure that the table names are new names and don't match the existing table names used. 2. If you previously used cross-server ("bungee") mode: ensure the cross-server mode setting is set to true in this file 3. Fill in other settings to match your existing settings with their equivalents (e.g. the Admin town name, etc). 4. Make sure the disabled worlds lists in both config files match so that HuskTowns correctly generates the needed claim worlds. -4. *If you customised the town roles previously*: Open the newly generated `roles.yml` and your old v1 `config.yml` you copied over earlier side-by-side. +3. *If you customised the town roles previously*: Open the newly generated `roles.yml` and your old v1 `config.yml` you copied over earlier side-by-side. 1. Under "names" in the new file, enter the role name and associated weight as it is defined in the old config file - 2. Under "roles" in the new file, add the list of priveleges for each weight. If you don't wish to assign any privileges at a role level, instead of the list, enter `[]` after the colon -5. *If you customised the town flag defaults previously:* Open the newly generated `rules.yml` and your old v1 `config.yml` you copied over earlier side-by-side. - 1. Fill in the default flag rules for each claim type, the wilderness, admin claims and unclaimable worlds as it is setup in your old config -6. *If you are using cross-server mode*: Create a new file called `server.yml` and open your old v1 `config.yml` you copied earlier side-by-side + 2. Under "roles" in the new file, add the list of privileges for each weight. If you don't wish to assign any privileges at a role level, instead of the list, enter `[]` after the colon +4. *If you customised the town flag defaults previously:* Open the newly generated `rules.yml` and your old v1 `config.yml` you copied over earlier side-by-side. + 1. Fill in the default flag rules for each claim type, the wilderness, admin claims and unclaimable worlds as it is set up in your old config +5. *If you are using cross-server mode*: Create a new file called `server.yml` and open your old v1 `config.yml` you copied earlier side-by-side 1. At the top of the file, type `name: ''`, replacing `` with the ID *name of this server* as it is defined in your old config. -7. Update your locales file to your liking. Note you cannot use your old locales file as the interfaces and system messages have been completely rewritten. -8. Repeat steps 1-7 for each server running HuskTowns on your network -9. Start all your servers +6. Update your [`messages-xx-xx.yml`](config-files) file to your liking. Note you can't use your old file as the interfaces and system messages have been completely rewritten. +7. Repeat steps 1-7 for each server running HuskTowns on your network +8. Start all your servers ### 3 Carrying out the migration > ⚠️ If you have any HuskTowns v2 data in your table, it will be deleted when you start the migration process @@ -39,8 +39,8 @@ Please follow the steps below to upgrade from HuskTowns v1.8.2. If you are runni 2. Read the on-screen instructions carefully and ensure the parameters listed are correct. If you previously used MySQL, for instance, ensure the parameters match that of your MySQL database and that the database type is set to `MYSQL` 3. If you need to change a parameter, use `husktowns migrate legacy set ` to do so 4. When you're happy, run `husktowns migrate legacy start` to begin the process. This can take several minutes to complete. - 1. You may receive a warning that it was unable to migrate the Administrators town over. This is expected, as the migrator does not support migrating admin claims. + 1. You may receive a warning that it was unable to migrate the Administrators town over. This is expected, as the migrator doesn't support migrating admin claims. 2. Be sure to re-create your admin claims after you've finished setup. 5. When the migration has finished, restart every server. -Your data should then have migrated. You can check that it has using the `town list` command in console or in-game. \ No newline at end of file +Your data should then have migrated. You can check that it has used the `town list` command in console or in-game. \ No newline at end of file diff --git a/docs/Redis-Support.md b/docs/Redis-Support.md index 6e4b2b53..d3855102 100644 --- a/docs/Redis-Support.md +++ b/docs/Redis-Support.md @@ -6,5 +6,5 @@ To make use of Redis, your network must first be correctly configured in `cross_ 2. Ensure your Redis server is online. 3. Modify the `config.yml` files of each server, filling in the redis `credentials` in the `cross_server` section. - Most Redis installations don't have a password by default. You can probably leave `password` blank (`''`). -5. Set the `messenger_type` to `REDIS` -6. Save your config files and turn on each server. Check to make sure the plugin enabled the network messenger successfully on startup. If it didn't, check your credentials (try without setting the password and SSL mode off if neccessary). \ No newline at end of file +4. Set the `messenger_type` to `REDIS` +5. Save your config files and turn on each server. Check to make sure the plugin enabled the network messenger successfully on startup. If it didn't, check your credentials (try without setting the password and SSL mode off if necessary). \ No newline at end of file diff --git a/docs/Setup.md b/docs/Setup.md index 412ff649..1203ad44 100644 --- a/docs/Setup.md +++ b/docs/Setup.md @@ -22,7 +22,7 @@ These instructions are for installing HuskTowns on multiple Spigot servers and h ### 1. Install the jar - Place the plugin jar file in the `/plugins/` directory of each Spigot server. -- You do not need to install HuskTowns as a proxy plugin. +- You don't need to install HuskTowns as a proxy plugin. ### 2. Restart the server and configure - Start, then stop every server to let HuskTowns generate the config file. - Advanced users: If you'd prefer, you can just create one config.yml file and create symbolic links in each `/plugins/HuskTowns/` folder to it to make updating it easier. @@ -32,14 +32,14 @@ These instructions are for installing HuskTowns on multiple Spigot servers and h - Under `mysql`/`credentials`, enter the credentials of your MySQL database server. - Scroll down and look for the `cross_server` section. Set `enabled` to `true`. - You can additionally configure a Redis server to use for network messaging, if you prefer (set the `messenger_type` to `REDIS` if you do this). -- Update your levels.yml, rules.yml and roles.yml files to your liking. For the roles file especially, make sure to set that file up now as adding new roles later isn't possible -- Save the configs file. Make sure you have updated the files on every server. +- Update your `levels.yml`, `rules.yml` and `roles.yml` files to your liking. For the roles.yml file especially, make sure to set that file up now as adding new roles later isn't possible +- Save the configs file. Make sure you've updated the files on every server. ### 4. Restart servers and set server.yml values - Restart each server again. A `server.yml` file should generate inside (`~/plugins/HuskTowns/`) - Set the `name` of the server in this file to the ID of this server as defined in the config of your proxy (e.g. if this is the "hub" server you access with `/server hub`, put "hub" here) ### 5. Restart your servers one last time -- Provided your MySQL datbase credentials were correct, your network should now be setup to use HuskTowns! -- You can delete the `HuskTownsData.db` SQLite flatfile that was generated, if you would like. +- Provided your MySQL database credentials were correct, your network should now be setup to use HuskTowns! +- You can delete the `HuskTownsData.db` SQLite flat file that was generated, if you would like. ## Next steps * [[Getting Started]] diff --git a/docs/Town-Advancements.md b/docs/Town-Advancements.md index e7100f81..15c427e7 100644 --- a/docs/Town-Advancements.md +++ b/docs/Town-Advancements.md @@ -1,4 +1,4 @@ -The Town Advancements feature provides a fun way of both teaching your players how to use HuskTowns as well as provide engaging challenges to keep growing them. Town advancements can be customized through the `advancements.json` file, located in `/plugins/HuskTowns/`. +The Town Advancements feature provides a fun way of both teaching your players how to use HuskTowns and provide engaging challenges to keep growing them. Town advancements can be customized through the `advancements.json` file, located in `/plugins/HuskTowns/`. ## List of advancements | Icon | Name | Description | Unlocks | diff --git a/docs/Town-Roles.md b/docs/Town-Roles.md index 7224060a..03ff68a5 100644 --- a/docs/Town-Roles.md +++ b/docs/Town-Roles.md @@ -1,9 +1,9 @@ You can customize the roles members of a town may hold as well as the privileges within the town each role has. Towns require at least two roles with different weights; a "mayor" role and a default citizen role, otherwise you will encounter errors. ### Important -* If you change the number of roles, you will need to reset your data - as the role weightings stored in the database will become incompatible. +* If you change the number of roles, you will need to reset your data, as the role weightings stored in the database will become incompatible. * You can change the privileges at any time in the config, though -* You can also change the role name as you see fit. It's the weightings which cannot change as those are stored in the database. +* You can also change the role name as you see fit. It's just the weightings which can't change as those are stored in the database. ## Defining roles Roles are defined in the town `roles.yml` file below, which is a copy of the default setup. @@ -55,7 +55,7 @@ roles: ### Privileges -Role privileges are how you specify what rights each role has in your town. The below table is a list of all these privileges and what rights they give each role. If you don't assign a privilege to a role, nobody will be able to perform that action, so make sure they are all assigned. +Role privileges are how you specify what rights each role has in your town. The below table is a list of all these privileges and what rights they give each role. If you don't assign a privilege to a role, nobody will be able to perform that action, so make sure they're all assigned. > βœ… Remember that higher roles inherit privileges from lower-weighted roles. diff --git a/docs/Translations.md b/docs/Translations.md index 701d2301..bbceea56 100644 --- a/docs/Translations.md +++ b/docs/Translations.md @@ -1,14 +1,14 @@ -HuskTowns supports a number of community-sourced translations of the plugin locales into different languages. The default language is [`en-gb`](https://github.com/WiIIiam278/HuskTowns/blob/master/bukkit/src/main/resources/locales/en-gb.yml) (English). The messages file is formatted using [MineDown](https://github.com/Phoenix616/MineDown). +HuskTowns supports a number of community-sourced translations of the plugin locales into different languages. The default language is [`en-gb`](https://github.com/WiIIiam278/HuskTowns/blob/master/bukkit/src/main/resources/locales/en-gb.yml) (English). The [`messages-xx-xx.yml`](config-files) file is formatted using [MineDown](https://github.com/Phoenix616/MineDown). You can change which preset language option to use by changing the top-level `language` setting in the plugin config.yml file. You must change this to one of the supported language codes. You can [view a list of the supported languages](https://github.com/WiIIiam278/HuskTowns/tree/master/bukkit/src/main/resources/locales) by looking at the locales source folder. ## Contributing Locales -You can contribute locales by submitting a pull request with a yaml file containing translations of the [default locales](https://github.com/WiIIiam278/HuskTowns/blob/master/bukkit/src/main/resources/locales/en-gb.yml) into your language. Here's a few pointers for doing this: +You can contribute locales by submitting a pull request with a yaml file containing translations of the [default locales](https://github.com/WiIIiam278/HuskTowns/blob/master/bukkit/src/main/resources/locales/en-gb.yml) into your language. Here are a few pointers for doing this: * Do not translate the locale keys themselves (e.g. `teleporting_offline_player`) * Your pull request should be for a file in the [locales folder](https://github.com/WiIIiam278/HuskTowns/tree/master/bukkit/src/main/resources/locales) -* Do not translate the [MineDown](https://github.com/Phoenix616/MineDown) markdown syntax itself or commands and their parameters; only the english interface text +* Do not translate the [MineDown](https://github.com/Phoenix616/MineDown) syntax itself or commands and their parameters; only the english interface text * Each locale should be on one line, and the header should be removed. * Use the correct ISO 639-1 [locale code](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) for your language and dialect -* If you are able to, you can add your name to the `AboutMenu` translators credit list yourself, otherwise this can be done for you +* If you are able to, you can add your name to the `AboutMenu` translators credits yourself, otherwise this can be done for you Thank you for your interest in making HuskTowns more accessible around the world! \ No newline at end of file