mirror of
https://github.com/Suiranoil/SkinRestorer.git
synced 2026-01-16 04:42:12 +00:00
Update README.md
This commit is contained in:
78
README.md
78
README.md
@@ -1,55 +1,97 @@
|
||||
# SkinRestorer
|
||||
|
||||

|
||||

|
||||
[](https://www.curseforge.com/minecraft/mc-mods/skinrestorer)
|
||||
[](https://modrinth.com/mod/skinrestorer)
|
||||
<a href="https://www.curseforge.com/minecraft/mc-mods/skinrestorer"><img src="https://raw.githubusercontent.com/Suiranoil/badges/main/assets/minecraft/platform/curseforge/mini/badge.svg" alt="CurseForge" height="32"></a>
|
||||
<a href="https://modrinth.com/mod/skinrestorer"><img src="https://raw.githubusercontent.com/Suiranoil/badges/main/assets/minecraft/platform/modrinth/mini/badge.svg" alt="Modrinth" height="32"></a>
|
||||
|
||||
SkinRestorer is a **server-side** only mod for Fabric that allows players to use and change skins on servers running in
|
||||
offline/insecure mode.
|
||||
A server-side mod for managing and restoring player skins.
|
||||
|
||||
## Features
|
||||
## ✨ Features
|
||||
|
||||
- **Set Skins from Mojang Account**: Fetch and apply skins using a valid Minecraft account name.
|
||||
- **Set Skins from URL**: Apply skins from any image URL, supporting both classic (Steve) and slim (Alex) skin models.
|
||||
- **Set skins from Mojang Account**: Fetch and apply skins using a valid Minecraft account name.
|
||||
- **Set skins from Ely.by**: Fetch and apply skins using a valid [Ely.by](https://ely.by/) account name.
|
||||
- **Set skins from URL**: Fetch and apply skins from any image URL, supporting both classic (Steve) and slim (Alex) skin models.
|
||||
- **Automatic skin fetching**: Automatically fetch skins from Mojang when a player joins the server running in offline/insecure mode ([configurable](https://github.com/Suiranoil/SkinRestorer/wiki/Config)).
|
||||
- **Permissions API support**
|
||||
|
||||
## Command Usage Guide
|
||||
## 📜 Command Usage Guide
|
||||
|
||||
### Set Mojang Skin
|
||||
### Set Mojang skin
|
||||
|
||||
Fetch and apply skins using a valid Minecraft account name.
|
||||
|
||||
```
|
||||
/skin set mojang <username> [<targets>]
|
||||
```
|
||||
|
||||
- **Parameters:**
|
||||
- **Parameters**
|
||||
- `<username>`: Minecraft account name to fetch the skin from.
|
||||
- `[<targets>]`: (Optional, server operators only) Player(s) to apply the skin to.
|
||||
|
||||
### Set Web Skin
|
||||
### Set Ely.by skin
|
||||
|
||||
Fetch and apply skins using a valid [Ely.by](https://ely.by/) account name.
|
||||
|
||||
```
|
||||
/skin set ely.by <username> [<targets>]
|
||||
```
|
||||
|
||||
- **Parameters**
|
||||
- `<username>`: Ely.by account name to fetch the skin from.
|
||||
- `[<targets>]`: (Optional, server operators only) Player(s) to apply the skin to.
|
||||
|
||||
### Set Web skin
|
||||
|
||||
Fetch and apply skins from any image URL, supporting both classic (Steve) and slim (Alex) skin models.
|
||||
|
||||
```
|
||||
/skin set web (classic|slim) "<url>" [<targets>]
|
||||
```
|
||||
|
||||
- **Parameters:**
|
||||
- **Parameters**
|
||||
- `(classic|slim)`: Type of the skin model (`classic` for Steve model, `slim` for Alex model).
|
||||
- `"<url>"`: URL pointing to the skin image file (ensure it follows Minecraft's skin size and format requirements).
|
||||
- `[<targets>]`: (Optional, server operators only) Player(s) to apply the skin to.
|
||||
|
||||
### Clear Skin
|
||||
### Refresh skin
|
||||
|
||||
Refetch and reapply the currently applied skins.
|
||||
|
||||
```
|
||||
/skin refresh [<targets>]
|
||||
```
|
||||
|
||||
- **Parameters**
|
||||
- `[<targets>]`: (Optional, server operators only) Player(s) to refresh the skin for.
|
||||
|
||||
### Clear skin
|
||||
|
||||
Remove the currently applied skins.
|
||||
|
||||
```
|
||||
/skin clear [<targets>]
|
||||
```
|
||||
|
||||
- **Parameters:**
|
||||
- **Parameters**
|
||||
- `[<targets>]`: (Optional, server operators only) Player(s) to clear the skin for.
|
||||
|
||||
### Notes:
|
||||
### Reset skin
|
||||
|
||||
Reset to the default skin or remove any custom skin.
|
||||
|
||||
If [automatic skin fetching](https://github.com/Suiranoil/SkinRestorer/wiki/Config#fetchskinonfirstjoin) is enabled, a new skin will be fetched when the player rejoins the server.
|
||||
|
||||
```
|
||||
/skin reset [<targets>]
|
||||
```
|
||||
|
||||
- **Parameters**
|
||||
- `[<targets>]`: (Optional, server operators only) Player(s) to reset the skin for.
|
||||
|
||||
### Notes
|
||||
|
||||
- If `targets` is not specified, the command will apply to the player executing the command.
|
||||
|
||||
### Examples:
|
||||
### Examples
|
||||
|
||||
```
|
||||
/skin set mojang Notch
|
||||
|
||||
Reference in New Issue
Block a user