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

update README.md

Browse Source
This commit is contained in:
Lionarius
2024-09-24 10:35:27 +03:00
parent 9bd8a53657
commit f43fa13044
1 changed files with 12 additions and 81 deletions
Download Patch File Download Diff File Expand all files Collapse all files

93
README.md
View File

@@ -1,7 +1,7 @@
# SkinRestorer # 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> <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>
<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 server-side mod for managing and restoring player skins. A server-side mod for managing and restoring player skins.
@@ -10,94 +10,25 @@ A server-side mod for managing and restoring player skins.
- **Set skins from Mojang Account**: Fetch and apply skins using a valid Minecraft username. - **Set skins from Mojang Account**: Fetch and apply skins using a valid Minecraft username.
- **Set skins from Ely.by**: Fetch and apply skins using a valid [Ely.by](https://ely.by/) username. - **Set skins from Ely.by**: Fetch and apply skins using a valid [Ely.by](https://ely.by/) username.
- **Set skins from URL**: Fetch and apply skins from any image URL, supporting both classic (Steve) and slim (Alex) skin models. - **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 skin from Mojang/Ely.by when a player joins the server running in offline/insecure mode ([configurable](https://github.com/Suiranoil/SkinRestorer/wiki/Config)). - **Automatic skin fetching**: Automatically fetch skin from Mojang/Ely.by when a player joins the server running in offline/insecure mode ([configurable](https://github.com/Suiranoil/SkinRestorer/wiki/Configuration)).
- **Singleplayer support**: Apply skins individually for each world. - **Singleplayer support**: Apply skins individually for each world.
- **Permissions API support** - **Permissions API support**
## 📜 Command Usage Guide ## 📜 Command Usage Guide
### Set Mojang skin For a detailed list of available commands and their usage, please visit the [commands wiki page](https://github.com/Suiranoil/SkinRestorer/wiki/Commands).
Fetch and apply skins using a valid Minecraft username. ## ❌ Known Incompatibilities
``` - **[Arclight](https://github.com/IzzelAliz/Arclight) (<=1.20.1)**: Trials or older versions are not compatible due to mixin conflicts.
/skin set mojang <username> [<targets>] As an alternative, consider using the [SkinsRestorer](https://www.spigotmc.org/resources/skinsrestorer.2124/) plugin.
```
- **Parameters** ## 🪙 Donation
- `<username>`: Minecraft username to fetch the skin from.
- `[<targets>]`: (Optional, server operators only) Player(s) to apply the skin to.
### Set Ely.by skin If you enjoy using **SkinRestorer** and would like to support its development, you can contribute through cryptocurrency donations.
Fetch and apply skins using a valid [Ely.by](https://ely.by/) username. Bitcoin (BTC): `1Ndbwny8pxdnWXFgadp95fp97y5JqMJKTX`\
USDT (TRC20): `TGXn8wrqku5KLzwPWQAeH7wgnV4UzwHEae`\
USDT (TON): `UQAQF18Xlmx-V1oZ90C2YOju5qI7q1LgrCP5QaIUhqIELmDS`
``` Thank you for your generosity!
/skin set ely.by <username> [<targets>]
```
- **Parameters**
- `<username>`: Ely.by username 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.
Uses [mineskin api](https://mineskin.org/) under the hood.
```
/skin set web (classic|slim) "<url>" [<targets>]
```
- **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.
### 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**
- `[<targets>]`: (Optional, server operators only) Player(s) to clear the skin for.
### 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
```
/skin set mojang Notch
/skin set web classic "https://example.com/skin.png"
/skin clear @a
```