Skip to content

Commit

Permalink
Restore README.md
Browse files Browse the repository at this point in the history
Makes it easy to auto-merge I guess.
  • Loading branch information
Ashy8682 authored Apr 10, 2024
1 parent cf4c1f4 commit 21cf49d
Showing 1 changed file with 69 additions and 5 deletions.
74 changes: 69 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,71 @@
The textbox for importing a skin from a file is not very good. This fork addresses 2 issues:
[![](https://github.com/mineblock11/mineblock11/blob/master/fabric-api_64h.png?raw=true)](https://modrinth.com/mod/fabric-api) [![](https://cdn.mineblock11.dev/enjarai%20badge_64h.png)](https://discord.gg/WcYsDDQtyR) [![](https://cdn.mineblock11.dev/mineblock%20badge_64h.png)](https://discord.gg/UzHtJKqHny)

### [#65 Ignore Quotation Marks](https://github.com/IMB11/SkinShuffle/issues/66)
When you right click on a file on windows, and click "Copy as path", it copies the file's path but with quotation marks around it. So when you're uploading a skin to use as a preset, you have to go to another textbox (because the SkinShuffle one doesn't allow for arrow keys to move the cursor), remove the quotations, then paste it into mc. I think it'd be great if SkinShuffle would ignore the quotation marks when they're pasted in with the file path.
# SkinShuffle

### [#66 Typing Colon Crashes Game](https://github.com/IMB11/SkinShuffle/issues/65)
In the textbox used for typing in a file path, trying to type "C:" crashes the game, but if there's already a path in front of the colon it doesn't.
SkinShuffle is a mod that allows you to **change, store and customise** your skin in-game. It also allows you to change your skin **without leaving the server** as long as the mod is installed on the server.

Skins are stored in Skin Presets, these presets can be created from the following sources:

- Texture URLs
- Usernames
- UUIDs
- Files
- In-game textures (Resource Locations)

<hr />

**Table Of Contents**

- [Client-Side Support](#client-side-support)
- [Carousel Screen](#carousel-screen)
- [Edit Screen](#edit-screen)
- [Configuration](#configuration)
- [Server-Side Support](#server-side-support)

<h2 id="client-side-support">Client-Side Support</h2>

SkinShuffle works right out the bat for clients! Browse, create and edit skin presets in the Carousel and Edit Preset screens that can be accessed via Mod Menu or through the widget on the pause screen and the title screen.

When you start the game for the first time with SkinShuffle, it will automatically create a preset from your current skin and set it as the main preset! Your currently chosen preset will be shown on the widget.

<center><img width="50%" src="https://cdn.modrinth.com/data/3s19I5jr/images/0b5e81688937e2685b2fa00ec709c5c1db302648.png"><img width="50%" src="https://cdn.modrinth.com/data/3s19I5jr/images/e13b4fcd7b37d02aa043e422d2e9560d6f099527.png"></center>

<h3 id="carousel-screen">Carousel Screen</h2>

The carousel is where all your skins will be stored for future use! You can create, edit and delete your presets.

You can customize every preset to your own desire in the edit screen.
<br><br>
<center><img width="50%" src="https://cdn.modrinth.com/data/3s19I5jr/images/ced596ec493eff53b3be5139fc991cf1e4d18d16.png"><img width="50%" src="https://cdn.modrinth.com/data/3s19I5jr/images/fea4801fa0923716a06982652c23c9a5c3fc72cf.png"></center>

<h3 id="edit-screen">Edit Screen</h2>

The edit screen allows you to change the actual texture of the skin, the model type and the name of the preset.

For the future, there are plans to add cape and ear customization to this screen.

<br>
<center>
<img width="50%" src="https://cdn.modrinth.com/data/3s19I5jr/images/e36d3d61b107d22fba09831bd06bb80de0474921.png" />
</center>

<h3 id="configuration">Configuration</h2>

Every part of SkinShuffle is customizable thanks to [YACL]()'s powerful configuration screen.

You can customize the speed that skins rotate in the carousel, to where they should follow your cursor, and where the preview widget should show.

<br>
<center>
<img width="50%" src="https://cdn.modrinth.com/data/3s19I5jr/images/eed48c8290e725b61e4c9864295e798681390779.png" />
</center>

<h2 id="server-side-support">Server-Side Support</h2>

When SkinShuffle is installed on the server, you can change your skin in-game without having to leave the game. SkinShuffle will refresh your skin for you, and for other players instantly - even for players that do not have the mod on their client.

We have massive plans to expand server-side support in the future:

- Skin Changing Commands that allow vanilla clients to change their skins.
- Skin Preset Sharing
- Skin rendering for offline mode servers.

0 comments on commit 21cf49d

Please sign in to comment.