diff --git a/docs/game/asa.md b/docs/game/asa.md index 0e475a00..426190e3 100644 --- a/docs/game/asa.md +++ b/docs/game/asa.md @@ -52,7 +52,7 @@ For Ark Survival Ascended, the following types of rewards are supported: The following string replacements are available for rewards: - `%user_id%`: The VyHub user id -- `%nick%`: The players in-game nickname +- `%nick%`: The player’s in-game nickname - `%player_id%`: The players EOSID - `%applied_packet_id%`: The id of the applied packet - `%packet_title%`: The title of the packet diff --git a/docs/getting_started/cloud.md b/docs/getting_started/cloud.md index a20648c0..85ea98fc 100644 --- a/docs/getting_started/cloud.md +++ b/docs/getting_started/cloud.md @@ -5,7 +5,7 @@ section of the docs. ## Get your VyHub Instance -Using VyHub for your gaming community is as easy as a few clicks are. +Using VyHub for your gaming community is as easy as a few clicks. 1. Create your account on [app.vyhub.net](https://app.vyhub.net). 2. Go to the [Dashboard](https://app.vyhub.net/dashboard) and click `Create Instance`. diff --git a/docs/getting_started/selfhosting.md b/docs/getting_started/selfhosting.md index c0fa22e4..3a32bf61 100644 --- a/docs/getting_started/selfhosting.md +++ b/docs/getting_started/selfhosting.md @@ -1,7 +1,7 @@ # Setup VyHub Selfhosting This is the setup guide for VyHub Selfhosting. -The Selfhosting version allows to host VyHub on your own server. +The Selfhosting version allows you to host VyHub on your own server. ## Prerequisites @@ -10,7 +10,7 @@ For hosting VyHub, some requirements must be met: - **Someone who knows how to use linux and docker** - A linux server (virtual or dedicated) - At least 2 CPU cores and 4GB RAM - - If a virtual server is used, make sure that the vCPU supports `x86-64-v2` or higer. A script that displays the supported architecture can be found at `tools/cpucheck` in the `vyhub-onprem` repository. + - If a virtual server is used, make sure that the vCPU supports `x86-64-v2` or higher. A script that displays the supported architecture can be found at `tools/cpucheck` in the `vyhub-onprem` repository. - Recommended: A recent Debian or Ubuntu LTS version - [Install Docker Server](https://docs.docker.com/engine/install/#server) - [Install Docker Compose Plugin](https://docs.docker.com/compose/install/linux/#install-using-the-repository) @@ -21,7 +21,7 @@ For hosting VyHub, some requirements must be met: - When not using Cloudflare: Setup certbot to get a LetsEncrypt certificate - When using Cloudflare: Generate a free origin certificate on the Cloudflare dashboard - Backup - - You should regularily create backups of your server, including the VyHub database + - You should regularly create backups of your server, including the VyHub database ## Creating and activating the selfhosting instance @@ -50,7 +50,7 @@ For hosting VyHub, some requirements must be met: If you are using certbot, consider creating a symbolic link to the actual cert/key with `ln -s`. -5. **SWITCH** Go the the dashboard of your instance at [app.vyhub.net](https://app.vyhub.net) and click on the `Setup` button. Follow the instructions there. +5. **SWITCH** Go to the dashboard of your instance at [app.vyhub.net](https://app.vyhub.net) and click on the `Setup` button. Follow the instructions there. 6. **SWITCH BACK** After finishing the setup dialog, go back to this page. diff --git a/docs/guide/adverts.md b/docs/guide/adverts.md index 65ecb46b..5d5f157c 100644 --- a/docs/guide/adverts.md +++ b/docs/guide/adverts.md @@ -5,12 +5,12 @@ The interval can be changed per server in the configuration file of the game int ## Attributes -| Attribute | Description | -|--------------|-------------------------------------------------------------------------| -| Title | Title of the advert, not shown to users. | -| Content | The content that should be printed to the chat. Multiple lines allowed. | -| Color | The color of the advert message. Not supported by Minecraft. | -| Serverbundle | The serverbundles where the advert should be shown. | +| Attribute | Description | +|--------------|------------------------------------------------------------------------------------| +| Title | Title of the advert, not shown to users. | +| Content | The content that should be printed to the chat. Multiple lines allowed. | +| Color | The color of the advert message. (Minecraft uses its own color codes, see below.) | +| Serverbundle | The serverbundles where the advert should be shown. | ## Text Colors It is possible to change the text color within the message by using color tags. @@ -27,7 +27,7 @@ Available colors are: - pink ### Minecraft -In Minecraft, additional colors can be used by using the `§` notiation. +In Minecraft, additional colors can be used by using the `§` notation. See `Chat Codes` [here](https://www.digminecraft.com/lists/color_list_pc.php). diff --git a/docs/guide/api.md b/docs/guide/api.md index 127333c9..8e4e53d6 100644 --- a/docs/guide/api.md +++ b/docs/guide/api.md @@ -1,13 +1,13 @@ # API -Your VyHub instance comes with a fully fetched REST API. You can use the API to create custom integrations or to +Your VyHub instance comes with a fully featured REST API. You can use the API to create custom integrations or to automate tasks (like invoice download for your bookkeeping). The API is accessible under `https://api.vyhub.app/{instance_name}/v1` ## Documentation and Swagger UI -You can view the documentation and interact with the api through the Swagger UI which is accessible under +You can view the documentation and interact with the API through the Swagger UI which is accessible under `https://api.vyhub.app/{instance_name}/v1/docs` ![Swagger UI](../assets/api_guide/swagger.jpg) @@ -16,7 +16,7 @@ You can view the documentation and interact with the api through the Swagger UI Some endpoints need authorization. You can set your authorization key at the top right of the documentation. -For testing purposes, you can use the authorization key you get, after you logged into your instance. Open the developer +For testing purposes, you can use the authorization key you get after you logged into your instance. Open the developer options in your browser and inspect the headers of a request in the network tab. ![Swagger UI](../assets/api_guide/authorization_header.jpg) diff --git a/docs/guide/forum.md b/docs/guide/forum.md index 11ebdc45..c746bd80 100644 --- a/docs/guide/forum.md +++ b/docs/guide/forum.md @@ -41,7 +41,7 @@ to newly register. | Attribute | Description | |-----------|------------------------------------| | Title | Title of thread | -| Status | Used to close and achieve a thread | +| Status | Used to close and archive a thread | ### Post @@ -54,7 +54,7 @@ to newly register. - Admins and users with the `forum_edit` property can edit everything and can create topic categories and topics. - Topic admins can be set in the topic settings. They can edit and delete every thread and every post of users. You can consider them as moderators. - The edit_post setting in the topic is used to allow users to edit their own posts. Otherwise, users cannot edit their posts. -- Team-only parts of the forum is possible with [requirement sets](requirement_set.md). +- Team-only parts of the forum are possible with [requirement sets](requirement_set.md). ## FAQ @@ -62,4 +62,4 @@ to newly register. |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| | __Question:__ I have bought the forum addon. Why can't I find it?
__Solution:__ You need to also activate the Forum in the general settings of your instance. | | __Question:__ Users can't edit their posts, how do I change that?
__Solution:__ You can find the `edit_post` setting in the settings of the respective topic. | -| __Question:__ I want to create a team only forum. is that possible?
__Solution:__ Yes, that is possible with requirement sets. Find examples in the [requirement](requirement_set.md) documentation. | +| __Question:__ I want to create a team only forum. Is that possible?
__Solution:__ Yes, that is possible with requirement sets. Find examples in the [requirement](requirement_set.md) documentation. | diff --git a/docs/guide/group/group.md b/docs/guide/group/group.md index 38216307..f2a8630b 100644 --- a/docs/guide/group/group.md +++ b/docs/guide/group/group.md @@ -17,7 +17,7 @@ your use case. ## Assigning Groups Groups can be assigned to users in the `User Dashboard` in the group section. -Furthermore, groups can be used as a reward in the shop can be assigned automatically through the +Furthermore, groups can be used as a reward in the shop and can be assigned automatically through the `VyHub Group` [shop reward](../shop/reward.md). ## Properties diff --git a/docs/guide/group/group_sync.md b/docs/guide/group/group_sync.md index 6182b836..d877e858 100644 --- a/docs/guide/group/group_sync.md +++ b/docs/guide/group/group_sync.md @@ -18,11 +18,11 @@ A command might look like this: ### Group Sync -VyHub's group sync is a more advanced way to assign groups to users. It is more complicated to set up but offers more +VyHub's group sync is a more advanced way to assign groups to users. It is more complicated to set up, but it offers some cool advantages over the simple command solution. 1. The current groups of a user are displayed in the VyHub user dashboard. This allows players to directly distinguish - between vips, admins, etc. + between VIPs, admins, etc. 2. The group sync is a two-way sync. This means that if a user is assigned a group in-game, this group is also assigned in VyHub. 3. The group sync is less error-prone, as the groups are kept in sync, and it is not dependent on commands that might diff --git a/docs/guide/legal.md b/docs/guide/legal.md index 0dcf2151..50a8aea8 100644 --- a/docs/guide/legal.md +++ b/docs/guide/legal.md @@ -39,7 +39,7 @@ until the purpose for the data processing ceases to apply. If you assert a legitimate request for deletion or revoke consent for data processing, your data will be deleted, unless we have other legally permissible reasons for storing your personal data (e.g. retention periods under tax law or commercial law); in the -the latter case, the deletion will take place after these reasons have ceased to exist. +latter case, the deletion will take place after these reasons have ceased to exist.

Registration

You need to register with us to use our products. We save your personal login details (e.g. email, password) within the registration process. @@ -47,7 +47,7 @@ You need to register with us to use our products. We save your personal login de This site uses SSL or TLS encryption to protect the transmission of confidential content, such as login data, order or payment information.
If the SSL or TLS encryption is activated, the data that you transmit to us cannot -read by third parties +be read by third parties

Contact and your Rights

As a data subject, you have the following rights:
In accordance with Art. 15 GDPR, you have the right to request information about your diff --git a/docs/guide/shop/general.md b/docs/guide/shop/general.md index cb45781e..2601e29f 100644 --- a/docs/guide/shop/general.md +++ b/docs/guide/shop/general.md @@ -16,6 +16,6 @@ Before a user can buy your packets, some configuration is needed. | Invoice Logo URL | URL to a logo image that is shown on the invoice | | Purchases from countries without tax rule | If enabled, purchases from countries where you did not define a tax rule are possible | | Tax included in packet price | Instead of adding taxes to the specified packet price on top, they are included in the price. | -| Checkout Checkboxes | Checkboxes which have to be agreed to during checkout. E.g. "I aggree to the Terms of Service" | +| Checkout Checkboxes | Checkboxes which have to be agreed to during checkout. E.g. "I agree to the Terms of Service" | diff --git a/docs/guide/shop/packet.md b/docs/guide/shop/packet.md index b8dd1169..4349dfc9 100644 --- a/docs/guide/shop/packet.md +++ b/docs/guide/shop/packet.md @@ -11,7 +11,7 @@ Item Drops. The rewards need to be set up in the [`Reward`](./reward.md) setting | Buyable | If disabled, packet can not be bought anymore | | Buyable active state | If disabled, packet can not be purchased if the user already has this packet active | | Buyable inactive state | If disabled, packet can not be purchased if the user already has this packet, but inactive | -| Recommendable | Whether the packet will be recommended during the purchase as a upsell | +| Recommendable | Whether the packet will be recommended during the purchase as an upsell | ## Payment @@ -21,7 +21,7 @@ Item Drops. The rewards need to be set up in the [`Reward`](./reward.md) setting | Currency | The currency of the price | | Credits | [Optional] Credit price of packet (leave empty if the packet should not be purchasable by credits) | | Custom Price / Pay what you want | [Optional] The user can decide how much he wants to pay. The selected price/credits is used as minimum price. | -| Recurring | Recurring payments every time the **active for** duration is expired - this limits the choice of payment gateways to these that support it. Currently **Stripe** and **PayPal**. | +| Recurring | Recurring payments every time the **active for** duration is expired - this limits the choice of payment gateways to those that support it. Currently **Stripe** and **PayPal**. | ## Packet Relations