From 926ec75fdb73360f7ae3d3ff20a1ccf2a68a9cee Mon Sep 17 00:00:00 2001 From: Arlind-dev Date: Fri, 6 Jun 2025 14:14:08 +0200 Subject: [PATCH] Migrate documentation to https://git.sulejmani.xyz/osc/skins --- how-to-use.md | 225 ---------------------- src/docs/activate_account.png | 3 - src/docs/activation_mail.png | 3 - src/docs/applications_generate_token.png | 3 - src/docs/check_mail.png | 3 - src/docs/copy_token.png | 3 - src/docs/navigate_actions.png | 3 - src/docs/navigate_repository_settings.png | 3 - src/docs/navigate_settings.png | 3 - src/docs/progress.png | 3 - src/docs/register.png | 3 - src/docs/secret1.png | 3 - src/docs/secret2.png | 3 - src/docs/start_create_new_repo.png | 3 - src/docs/template_repo.png | 3 - 15 files changed, 267 deletions(-) delete mode 100644 how-to-use.md delete mode 100644 src/docs/activate_account.png delete mode 100644 src/docs/activation_mail.png delete mode 100644 src/docs/applications_generate_token.png delete mode 100644 src/docs/check_mail.png delete mode 100644 src/docs/copy_token.png delete mode 100644 src/docs/navigate_actions.png delete mode 100644 src/docs/navigate_repository_settings.png delete mode 100644 src/docs/navigate_settings.png delete mode 100644 src/docs/progress.png delete mode 100644 src/docs/register.png delete mode 100644 src/docs/secret1.png delete mode 100644 src/docs/secret2.png delete mode 100644 src/docs/start_create_new_repo.png delete mode 100644 src/docs/template_repo.png diff --git a/how-to-use.md b/how-to-use.md deleted file mode 100644 index 30d93aa..0000000 --- a/how-to-use.md +++ /dev/null @@ -1,225 +0,0 @@ ---- - -gitea: none -include_toc: true - ---- - -# How to Use This Repository - -If anything is unclear, just shoot me a message on Discord. - -## 1. Create Your Account on git.sulejmani.xyz - -(If you don't want to share your mail with me DM me on Discord) - -Sign up here: -[https://git.sulejmani.xyz/user/sign\_up](https://git.sulejmani.xyz/user/sign_up) - -![Register](/src/docs/register.png) - -Check your email and click the confirmation link to activate your account. - -![Check Mail](/src/docs/check_mail.png) -![Activation Email](/src/docs/activation_mail.png) - -Then confirm your password to complete the process. - -![Activate Account](/src/docs/activate_account.png) - ---- - -## 2. Generate an Access Token - -Go to [https://git.sulejmani.xyz/](https://git.sulejmani.xyz/) and open your **Settings**. - -![Navigate Settings](/src/docs/navigate_settings.png) - -Under the **Applications** section, create a new token. - -* Check all permissions (as shown in the image) -* Give it a clear and recognizable name - -![Generate Token](/src/docs/applications_generate_token.png) - -Once the token is generated, **copy and save it securely**, you won’t be able to see it again. - -![Copy Token](/src/docs/copy_token.png) - ---- - -## 3. Create a New Repository - -Still on [https://git.sulejmani.xyz/](https://git.sulejmani.xyz/), click the **+** icon in the top right corner to create a new repo. - -![Start Creating New Repo](/src/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](/src/docs/template_repo.png) - ---- - -## 4. Set Up Secrets for Deployment - -Go to your repository's **Settings**. - -![Navigate Repo Settings](/src/docs/navigate_repository_settings.png) - -Then under **Actions** open the **Secrets** tab and add these two: - -| Secret Name | Secret Value | -| -------------------- | -------------------------- | -| `TOKEN` | The token you just created | -| `CONTAINER_REGISTRY` | `git.sulejmani.xyz` | - -![Add Secret 1](/src/docs/secret1.png) -![Add Secret 2](/src/docs/secret2.png) - ---- - -## 5. 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: - -```bash -git config --global user.name "Your Name" -git config --global user.email "you@example.com" - -git lfs install - -git clone https://git.sulejmani.xyz/{yourusername}/{yourrepositoryname}.git -``` - ---- - -## 6. Prepare Your Skins - -In your cloned repo, open `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. - ---- - -## 7. 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: - -``` -*WhiteCat* -*Vaxei* -``` -So in this example if a Skin has WhiteCat or Vaxei in the name, it will be ignored. - ---- - -## 8. 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. - ---- - -## 9. Monitor Upload Progress - -Go to your repo's **Actions** tab. - -![navigate-actions](/src/docs/navigate_actions.png) - -You’ll see the workflow progress there. - -![progress](/src/docs/progress.png) - -If something goes wrong, check the logs—or just ping me on Discord. - ---- - -## 10. 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 -``` - ---- - -## 11. 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. diff --git a/src/docs/activate_account.png b/src/docs/activate_account.png deleted file mode 100644 index ed3c9e9..0000000 --- a/src/docs/activate_account.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:e532dd0df21476c0ec62044db40fa87a6cffe33ba99ce529398f8f39714b6120 -size 6055 diff --git a/src/docs/activation_mail.png b/src/docs/activation_mail.png deleted file mode 100644 index fa6de36..0000000 --- a/src/docs/activation_mail.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:0ebdedb876ba05cb5a11859b3355eee4d95c36276cb229c7f639c113af03ea80 -size 22430 diff --git a/src/docs/applications_generate_token.png b/src/docs/applications_generate_token.png deleted file mode 100644 index fbcad29..0000000 --- a/src/docs/applications_generate_token.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:42b7eaae1f8b744dfe92981d93c7922fe5e8d3d135deb5fd63e4aace98dd4a17 -size 45322 diff --git a/src/docs/check_mail.png b/src/docs/check_mail.png deleted file mode 100644 index 29e645c..0000000 --- a/src/docs/check_mail.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:89cbb3ecd96b09abc505d2963b346732a9dc1e1412aece53d985181be8ba0f9f -size 12213 diff --git a/src/docs/copy_token.png b/src/docs/copy_token.png deleted file mode 100644 index ca3c8cb..0000000 --- a/src/docs/copy_token.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:66d83736439b2447c14b7d03a9ba2e772ef4edbbc9f608ca86be148dda352e5e -size 4944 diff --git a/src/docs/navigate_actions.png b/src/docs/navigate_actions.png deleted file mode 100644 index 1fda017..0000000 --- a/src/docs/navigate_actions.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:8d289bea0186a2f3268039f7d6167d74335315c4f21d30f74775bcdecc031a7c -size 9434 diff --git a/src/docs/navigate_repository_settings.png b/src/docs/navigate_repository_settings.png deleted file mode 100644 index 202316c..0000000 --- a/src/docs/navigate_repository_settings.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:4a96a295fa040cae33475bc5545650ce2bf029366a7d93c144311783c0922f25 -size 44376 diff --git a/src/docs/navigate_settings.png b/src/docs/navigate_settings.png deleted file mode 100644 index 7dec665..0000000 --- a/src/docs/navigate_settings.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:a260d51b388e627956c0c54c14fd8d1850ccf8f764cba95eeeb2ea86a8152ead -size 9112 diff --git a/src/docs/progress.png b/src/docs/progress.png deleted file mode 100644 index e8a6eea..0000000 --- a/src/docs/progress.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:6986dc37eba9debcffa81e9f49591c983c36086e8e92ecd29f789902d6856398 -size 37308 diff --git a/src/docs/register.png b/src/docs/register.png deleted file mode 100644 index 7193104..0000000 --- a/src/docs/register.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:2d65c065bdaff8057bb8589b8df03507164b5f64b6df59276a2802b8ba191d8c -size 10172 diff --git a/src/docs/secret1.png b/src/docs/secret1.png deleted file mode 100644 index 8dafdf8..0000000 --- a/src/docs/secret1.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:0fb5b87fbd730fa16745214d521dc3dbf8047af34b29c9b1c1314fc2cde4f8b0 -size 10308 diff --git a/src/docs/secret2.png b/src/docs/secret2.png deleted file mode 100644 index 18b4d24..0000000 --- a/src/docs/secret2.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:58a28ca2f539fc58ce01d9ce60c51d68ba6e56c7810f5b141a8699f178a67c46 -size 11140 diff --git a/src/docs/start_create_new_repo.png b/src/docs/start_create_new_repo.png deleted file mode 100644 index 7a062d3..0000000 --- a/src/docs/start_create_new_repo.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:c8f0689f8fead37373232a8979e33b09d00fa6c567c4d398f969f8fb881d4bbb -size 7012 diff --git a/src/docs/template_repo.png b/src/docs/template_repo.png deleted file mode 100644 index cd93a10..0000000 --- a/src/docs/template_repo.png +++ /dev/null @@ -1,3 +0,0 @@ -version https://git-lfs.github.com/spec/v1 -oid sha256:c4aad005e3a03cf9fa4088c785ce06a54ef71007fc1eb83f4e0c85adfbc1ad5a -size 41423