lionarius/SkinRestorer
1
0
Fork 0
mirror of https://github.com/Suiranoil/SkinRestorer.git synced 2026-01-16 04:42:12 +00:00
Code Wiki Activity

docs: improve wiki descriptions and fix command syntax 

- Improve provider descriptions (mojang, ely_by, mineskin) with more details
- Fix skin refresh command (remove unsupported targets parameter)
- Clarify skin clear vs skin reset behavior
- Fix apiKey field placement in mineskin provider defaults
Lionarius
2026-01-13 23:44:41 +03:00
parent 2633f1e9de
commit c6519ffe64
2 changed files with 8 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Commands.md

@@ -43,18 +43,15 @@ Uses [mineskin api](https://mineskin.org/) under the hood.
# `skin refresh`
Refetch and reapply the currently applied skin.
Refetch and reapply your currently applied skin.
```
/skin refresh [<targets>]
/skin refresh
```
- **Parameters**
- `[<targets>]`: (Optional, for server operators) Specify one or more players to apply the skin to. If not provided, the skin is refreshed for the player executing the command.
# `skin clear`
Remove the currently applied skin.
Set the skin to an empty state (no skin). This is different from `skin reset` — it sets a special empty skin rather than reverting to the player's original skin.
```
/skin clear [<targets>]
@@ -65,7 +62,7 @@ Remove the currently applied skin.
# `skin reset`
Reset to the default skin or remove any custom skin.
Revert to the player's original skin (from their game profile) and remove the saved custom skin from storage. If the player had no original skin, this will have no effect.
If [automatic skin fetching](https://github.com/Suiranoil/SkinRestorer/wiki/Configuration#fetchskinonfirstjoin) is enabled, a new skin will be fetched when the player rejoins the server.

8
Configuration.md

@@ -71,7 +71,7 @@ The configuration file is located at `./config/skinrestorer/config.json` and is
## `providers.mojang`
- **Description**: Configuration for the Mojang skin provider.
- **Description**: Configuration for the Mojang skin provider. Fetches skins from Mojang's official API by resolving a username to UUID and retrieving the player's profile.
- **Default**:
- `enabled`: `true`
- `name`: `"mojang"`
@@ -80,7 +80,7 @@ The configuration file is located at `./config/skinrestorer/config.json` and is
## `providers.ely_by`
- **Description**: Configuration for the Ely.by skin provider.
- **Description**: Configuration for the Ely.by skin provider. Fetches skins from the Ely.by skin system API by username.
- **Default**:
- `enabled`: `true`
- `name`: `"ely.by"`
@@ -89,14 +89,14 @@ The configuration file is located at `./config/skinrestorer/config.json` and is
## `providers.mineskin`
- **Description**: Configuration for the Mineskin skin provider.
- **Description**: Configuration for the Mineskin skin provider. Converts skin image URLs into game skin data using the Mineskin API. Supports both URLs and variant selection (classic/slim).
- **Additional fields**
- `apiKey`
- **Description**: Specifies the API key for requests to the Mineskin API.
- **Default**: `""`
- **Possible Values**: Any string.
- **Default**:
- `enabled`: `true`
- `name`: `"web"`
- `cache.enabled`: `true`
- `cache.duration`: `300`
- `apiKey`: `""`