From 5b59eb02e0bc881f229f43e92966020ed3e5ee7e Mon Sep 17 00:00:00 2001 From: pairnon <123353727+pairnon@users.noreply.github.com> Date: Fri, 15 Mar 2024 19:56:41 +0000 Subject: [PATCH] Fix typos (#153) --- pages/Advanced-Setup.md | 4 ++-- pages/Configuration.md | 8 ++++---- pages/Developer-API.md | 2 +- pages/Prefixes,-Suffixes-&-Meta.md | 2 +- pages/Standalone-and-REST-API.md | 2 +- pages/Syncing-data-between-servers.md | 2 +- pages/Web-Editor-Technical-Details.md | 6 +++--- pages/Web-Editor.md | 2 +- 8 files changed, 14 insertions(+), 14 deletions(-) diff --git a/pages/Advanced-Setup.md b/pages/Advanced-Setup.md index 7424a56..634e0a5 100644 --- a/pages/Advanced-Setup.md +++ b/pages/Advanced-Setup.md @@ -15,7 +15,7 @@ This is the name of the server. If you want to set server specific permissions, # If users on this server should have their global permissions/groups applied. include-global: true ``` -The include global option is also imporant. +The include global option is also important. Permissions in LuckPerms are either server specific (they only apply on certain servers) or global (they apply on all servers). @@ -78,7 +78,7 @@ Example: if a user has a true permission set for "luckperms.\*", and a false per * **Temporary permissions will override other temporary permissions with a longer expiry time** -Example: if a user has a temporary true permission set for "fly.use" that expires in 1 day, and a temporary false permission set for "fly.use" that expires in 1 hour, the temporary permission expiring in 1 hour will override the one expiring in 1 day, and the negative node will take precendence for the duration of 1 hour. +Example: if a user has a temporary true permission set for "fly.use" that expires in 1 day, and a temporary false permission set for "fly.use" that expires in 1 hour, the temporary permission expiring in 1 hour will override the one expiring in 1 day, and the negative node will take precedence for the duration of 1 hour. * **More specific wildcards override less specific ones** diff --git a/pages/Configuration.md b/pages/Configuration.md index b0c087f..172131e 100644 --- a/pages/Configuration.md +++ b/pages/Configuration.md @@ -102,7 +102,7 @@ LuckPerms will attempt to resolve configuration settings from various sources (i ### System Properties -[System properties](https://docs.oracle.com/javase/tutorial/essential/environment/sysprop.html) are a generic way to configure Java applications. They can either be set using a command line flag, or programatically using the [`java.lang.System`](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html) API. +[System properties](https://docs.oracle.com/javase/tutorial/essential/environment/sysprop.html) are a generic way to configure Java applications. They can either be set using a command line flag, or programmatically using the [`java.lang.System`](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/lang/System.html) API. e.g. To replicate the following YAML from a LuckPerms config.yml with system properties: @@ -126,7 +126,7 @@ java ### Environment Variables -[Enviroment variables](https://en.wikipedia.org/wiki/Environment_variable) are a generic way to configure any application. The way they are defined depends on your setup. An example is given below for unix-like shells, but you can also [easily set them](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) if you're running your server in a Docker container, for example. +[Environment variables](https://en.wikipedia.org/wiki/Environment_variable) are a generic way to configure any application. The way they are defined depends on your setup. An example is given below for unix-like shells, but you can also [easily set them](https://docs.docker.com/engine/reference/commandline/run/#set-environment-variables--e---env---env-file) if you're running your server in a Docker container, for example. e.g. To replicate the following YAML from a LuckPerms config.yml with environment variables: @@ -415,7 +415,7 @@ argument-based-command-permissions: true ___ ### `log-notify` -If the plugin should send log notifications to users whenever permissions are modified. Notifications are only sent to those with the appropriate permission to recieve the notification. +If the plugin should send log notifications to users whenever permissions are modified. Notifications are only sent to those with the appropriate permission to receive the notification. Notifications can also be disabled temporarily in-game using `/lp log notify off` @@ -642,7 +642,7 @@ apply-sponge-default-subjects=true ___ ### `world-rewrite` -Allows you to set "aliases" for the worlds sent forward for context calculation. These aliases are provided in addittion to the real world name. Applied recursively. +Allows you to set "aliases" for the worlds sent forward for context calculation. These aliases are provided in addition to the real world name. Applied recursively. ##### Example ```yaml diff --git a/pages/Developer-API.md b/pages/Developer-API.md index cea3e31..e7f9fd9 100644 --- a/pages/Developer-API.md +++ b/pages/Developer-API.md @@ -221,7 +221,7 @@ If you don't care about errors, this can be simplified further. logFuture.thenAcceptAsync(log -> { /* Use the log for something */ }, executor); ``` -The CompletableFuture class can initially be very confusing to use (it's still a relatively new API in Java!), however it is a great way to encapsulate async computations, and in the case of Minecraft, ensures that users don't accidently block the server thread waiting on lengthy I/O calls. +The CompletableFuture class can initially be very confusing to use (it's still a relatively new API in Java!), however it is a great way to encapsulate async computations, and in the case of Minecraft, ensures that users don't accidentally block the server thread waiting on lengthy I/O calls. #### Asynchronous events & callbacks diff --git a/pages/Prefixes,-Suffixes-&-Meta.md b/pages/Prefixes,-Suffixes-&-Meta.md index 0eb5e0f..5d3d02b 100644 --- a/pages/Prefixes,-Suffixes-&-Meta.md +++ b/pages/Prefixes,-Suffixes-&-Meta.md @@ -24,7 +24,7 @@ username-color: blue ## Who provides what? Generally, plugins which provide and manage permissions on your server will also have functionality to allow you to set, manage and store prefixes/suffixes/meta. This is true of LuckPerms. -Occasionally, permissions plugins will also provide the means to apply this data to the chat. This is not the case for LuckPerms, and you'll need an addittional plugin to apply chat formatting for you. More on this later. +Occasionally, permissions plugins will also provide the means to apply this data to the chat. This is not the case for LuckPerms, and you'll need an additional plugin to apply chat formatting for you. More on this later. ## How do prefixes/suffixes/meta get stored Prefixes and suffixes in LuckPerms are converted and stored as permission nodes. You'll notice that when you add a prefix or suffix to a user/group, that a new entry will appear in their permissions data which relates to the value you set. Why do it this way? Well, it makes things much easier from a programming point of view to have everything stored in the same place, and in similar formats. It also means you can easily manipulate prefix and suffix data in the same way you do for permissions. diff --git a/pages/Standalone-and-REST-API.md b/pages/Standalone-and-REST-API.md index da44fbb..8889c25 100644 --- a/pages/Standalone-and-REST-API.md +++ b/pages/Standalone-and-REST-API.md @@ -64,7 +64,7 @@ It's quite easy: 1. Create a file called `extension.json` at the root of your jar with the following contents: ```json - {"class": "com.example.extention.MainClass"} + {"class": "com.example.extension.MainClass"} ``` (replace with your main class!) 2. Create a main class that extends `import net.luckperms.api.extension.Extension`. diff --git a/pages/Syncing-data-between-servers.md b/pages/Syncing-data-between-servers.md index 24abf89..f85c58f 100644 --- a/pages/Syncing-data-between-servers.md +++ b/pages/Syncing-data-between-servers.md @@ -49,6 +49,6 @@ A messaging service can be configured in the config, under the `messaging-servic | redis | Connects to a Redis instance and uses PubSub to communicate. | | rabbitmq | Connects to a RabbitMQ instance and uses PubSub over AMQP to communicate. | | nats | Connects to a Nats instance and uses PubSub to communicate. | -| custom | Forces the messaging-service to use your own custom implemention that you provide through the LuckPerms API. | +| custom | Forces the messaging-service to use your own custom implementation that you provide through the LuckPerms API. | It is also possible to provide your own implementation of this service via the LuckPerms API. Make sure you set the messaging-service option in the config to `custom` otherwise it will throw an error on startup. diff --git a/pages/Web-Editor-Technical-Details.md b/pages/Web-Editor-Technical-Details.md index 3e3cd9c..fd2ca6c 100644 --- a/pages/Web-Editor-Technical-Details.md +++ b/pages/Web-Editor-Technical-Details.md @@ -41,14 +41,14 @@ The web editor will only accept messages sent in the channel that have been sign The connection flow starts when the web editor sends a `hello` message to the channel (the server should be connected & "listening" in the channel already). The `hello` message includes: -* nonce - a short, random string to indentify the session +* nonce - a short, random string to identify the session * sessionId - the bytebin id the web editor was opened with * browser - a short description of the os/browser being used -* publicKey - the editor's public key. This is used by the server to ensure that subsequent messages recieved from the editor have not been tampered with. +* publicKey - the editor's public key. This is used by the server to ensure that subsequent messages received from the editor have not been tampered with. During the connection flow, the Minecraft server (LuckPerms plugin) will ensure that either: * the editor public key is known from a previous session -* the user runs a command to explictly trust the editor. This process uses the nonce to ensure they trust the right one in the case of >1 connections! +* the user runs a command to explicitly trust the editor. This process uses the nonce to ensure they trust the right one in the case of >1 connections! The server will return a `hello-reply` message to inform the editor of what the outcome is. diff --git a/pages/Web-Editor.md b/pages/Web-Editor.md index 886f1fe..32d0067 100644 --- a/pages/Web-Editor.md +++ b/pages/Web-Editor.md @@ -44,7 +44,7 @@ Once you've created and opened the session, you can use the interface to make ch ### Editor Context -You can add contexts in the editor in addition to in-game. To do so, either click the "Add Contexts" button before adding a permission or simply fill in the `key` and `value` fields after a permission with appropriate keys and vaules, such as `world` and `nether`, or `server` and `hub`. +You can add contexts in the editor in addition to in-game. To do so, either click the "Add Contexts" button before adding a permission or simply fill in the `key` and `value` fields after a permission with appropriate keys and values, such as `world` and `nether`, or `server` and `hub`. Note that a permission can only have one world and one server context at a time. You have to set the same permission again with the other context to make it apply on multiple worlds/servers.