skins/how-to-use.md

---

gitea: none
include_toc: true

---

# How to Use This Repository

If anything is unclear, just shoot me a message on Discord.

It may take anywhere from 10 to 30 minutes, depending on how many skins you’re uploading and how good you are with using computers!

## 1. Create Your Account on git.sulej.net

**(If you don't want to share your mail with me DM me on Discord, only I can see it if you create your account with your mail)** 

Sign up here:
[https://git.sulej.net/user/sign\_up](https://git.sulej.net/user/sign_up)

![Register](/docs/register.png)

Check your email and click the confirmation link to activate your account.

![Check Mail](/docs/check_mail.png)
![Activation Email](/docs/activation_mail.png)

Then confirm your password to complete the process.

![Activate Account](/docs/activate_account.png)

I would greatly appreciate if you set a profile picture for your account!

---

## 2. Create a New Repository

Still on [https://git.sulej.net/](https://git.sulej.net/), click the **+** icon in the top right corner to create a new repo.

![Start Creating New Repo](/docs/start_create_new_repo.png)

* Name it however you like
* Use `skins-template` as the template
* Enable all template items

You now have your own copy of the template repo.

![Template Repo](/docs/template_repo.png)

---

## 3. Set Up Variables for Deployment

Go to your repository's **Settings**.

![Navigate Repo Settings](/docs/navigate_repository_settings.png)

Then under **Actions** open the **Variables** tab and add these two:

| Variable Name        | Variable Value      |
| -------------------- | ------------------- |
| `OSUID`              | Your osu player id  |

So in my case my osu profile is `https://osu.ppy.sh/users/13792719` and I use `13792719`

![Example Variables](/docs/example_variables.png)

---

## 4. Clone the Repository

If you don’t have Git installed, download it here:
👉 [https://git-scm.com/downloads/win](https://git-scm.com/downloads/win)

Choose where to clone the repo (e.g. `D:/git/`) and run these commands in Git Bash, PowerShell or CMD:


```bash
git config --global user.name "Your Name"
git config --global user.email "{yourusername}@sulej.net" # or your real mail if you dont mind anyone looking 

git lfs install

git clone https://git.sulej.net/{yourusername}/{yourrepositoryname}.git
```

If you use git for other stuff like work, do not use --global and instead run the same command in the repository.

---

## 5. Prepare Your Skins

In your cloned repo, edit `hardlink-songs-folder.bat`.

Edit the source and target paths. For example, if:

* Your osu! skins are in `E:\osu!\skins`
* Your repo is in `D:\git\skins`

Then update the line on the script like this:

```bat
robocopy "E:\osu!\skins" "D:\git\skins\Skins" /MIR /COPYALL /SEC /B /XJ /DCOPY:T /J
```

**For the git Path the Skins folder needs to have a capital S**

Run the batch file by double-clicking it.

---

## 6. Change Skin Order, add descriptions, and ignore Skins.

### Skin Order
This is optional, but recommended. In the `workflows` folder, open `skins.json`.

Edit the order and descriptions as you like.

here's an example:

```json
{
  "order": [
    "- Barely still Jace",
    "- Jace"
  ],
  "descriptions": {
    "- Barely still Jace": "My main skin.",
    "- Jace": "My secondary skin, only really used for EZ."
  }
}
```

Make sure the order matches the skins folder name in the `Skins` folder.

### Ignore Skins

There is a .gitignore file in the root of the repo. You can add any skins you don't want to be uploaded.

Here's an example:

```
/Skins/*WhiteCat*
/Skins/*Vaxei*
```
So in this example if a Skin has WhiteCat or Vaxei in the name, it will not be uploaded.

---

## 7. Upload Your Skins

Open a terminal (cmd or PowerShell) in your repo directory:

```cmd
cd D:\git\skins  # update this to your actual path
```

Then run:

```bash
git add .
git commit -m "Adding skins"
git config --global credential.helper cache
git push
```

Your skins will now be uploaded.

---

## 8. Monitor Upload Progress

Go to your repo's **Actions** tab.

![navigate-actions](/docs/navigate_actions.png)

You’ll see the workflow progress there.

![progress](/docs/progress.png)

(Might not look the exact same as in this picture)

If something goes wrong, check the logs or just ping me on Discord.

---

## 9. Update Skins in the Future

To update your skins later:

1. Re-run `hardlink-songs-folder.bat`
2. Run the same upload commands:

```bash
git pull
git add .
git commit -m "Updating skins"
git push
```

---

## 10. Handle duplicate skin.ini names

You might see Skins that show up with the exact same name in your README.md, this isn't a problem but if you would want to fix that you would need to go in to your skin and rename the name part of your skin.ini.

---

## 11. Adding your skin to https://git.sulej.net/osc/skins

After you did every step it should be in https://git.sulej.net/osc/skins after a couple minutes, if it doesn't show up please message me on Discord.

---

## 12. Troubleshooting

### Add Skin order, add skin descriptions

Edit `.gitea/workflows/skins.json` like described in step 6.

### Committed all the files but nothing is happening

Make sure the skins folder is called `Skins` and not `skins`.

### Skin names wrong

The Scirpt takes skin names based off of the `skin.ini` file in the skin, to fix that change it in the `skin.ini` file.