Converted all old docs to new one

This commit is contained in:
Stijn Bannink 2025-01-10 19:36:30 +01:00
parent 5f6132988e
commit 9f9d8f83fa
Signed by: SBDeveloper
GPG key ID: B730712F2C3A9D7A
25 changed files with 816 additions and 5 deletions

9
ridecountviewer/about.md Normal file
View file

@ -0,0 +1,9 @@
---
sidebar_label: About
sidebar_position: 1
---
# About
RidecountViewer is a plugin that allows you to create a ride count leaderboard for your server. It can use the data from
ThemePark.

24
ridecountviewer/faq.md Normal file
View file

@ -0,0 +1,24 @@
---
sidebar_label: FAQ
sidebar_position: 4
---
# FAQ
## All the names of bedrock players are shown as "Unknown". How to fix?
To look up the names of offline bedrock players, we use an API. This API requires a token to work. You can claim a token
like this:
1. Go to [XAPI registration](https://xapi.us/register) and fill in the form. The Free plan should work just fine, as we
store player names in cache. Then check your email to verify your account.
2. [Sign in to your account](https://xapi.us/login). Then login to your Xbox Live account on the Profile page. You can
use the OAuth or fill in your account details manually.
3. Copy the **API Token**, go to your server files, and then to `/plugins/ThemeParkRidecountAddon/config.yml`, and paste
it after `XAPIToken`.
4. Done! Restart your server, and now you should see the correct player names for Bedrock players.
:::info
**NOTE:** Because of privacy reasons, if the player has disabled viewing their name for non-friends, you can
only view their name if you are a friend of them.
:::

9
ridecountviewer/setup.md Normal file
View file

@ -0,0 +1,9 @@
---
sidebar_label: Setup
sidebar_position: 2
---
# Setup
1. Make sure you have installed [MapReflectionAPI](https://polymart.org/resource/mapreflectionapi-1-12-1-19.2576) and [ProtocolLib](https://www.spigotmc.org/resources/protocollib.1997/) in your server. These are required for ActionFoto.
2. Download the [plugin from Polymart](https://polymart.org/resource/ridecountviewer.2246). Then just install it into your plugins folder. The plugin will start up and function out of the box.

18
ridecountviewer/usage.md Normal file
View file

@ -0,0 +1,18 @@
---
sidebar_label: Usage
sidebar_position: 3
---
# Usage
## Commands
- `/rv help` - Get list of commands
- `/rv reload` - Reload the plugin
- `/rv create <RideID> <UpdateFrequency>` - Create a ridecount itemframe. The UpdateFrequency is `NEVER`, `DAILY` or `WEEKLY`.
- `/rv update <RideID>` - Force the update of a ridecount itemframe.
- `/rv remove <RideID>` - Remove a ridecount itemframe.
## Permissions
- `rv.admin` - The general admin permission (for all the commands)