pomp/osu-pomp-skin
1
0
Fork 0
Code Activity

docs: improve readme

Browse source
This commit is contained in:
Kim, Jimin 2024-03-23 19:36:28 +09:00
parent 178aedbd53
commit b818f7a8f3
Signed by: pomp
GPG key ID: 77DAC7BB5CA8C7AA
2 changed files with 18 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

BIN
.github/img/screenshot.avif vendored Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 41 KiB

64
README.md
View file

@ -4,67 +4,39 @@
[![code style: black](https://img.shields.io/badge/black-black?style=for-the-badge&label=code%20style)](https://github.com/psf/black)
[![download skin](https://img.shields.io/badge/download_skin-gray?style=for-the-badge)](https://developomp.github.io/osu-pomp-skin)
My custom skin for the game [osu!](https://github.com/ppy/osu).
My custom skin for the game [osu! (lazer)](https://github.com/ppy/osu) based on [vaxei's skin (blue, instant-fade)](https://drive.google.com/file/d/16YhU5yI4rgHFoK8PzBeFGDQoywWua417/view).
![screenshot](./.github/img/screenshot.avif)
## Characteristics
- minimalistic
- does not even have a health bar
- uses the default element in most cases
- instant fade circles
- skins osu!standard only
- uses the default element in most places
- instant-fade circles
- osu!standard only
- acc meter positioned on top of the screen instead of the bottom
- made specifically for osu!lazer
- uses [HD images](https://github.com/ppy/osu-wiki/blob/master/wiki/Skinning/FAQ/en.md#hd-images) only
(although none of the images have a `@2x` suffix, they are all HD images. The suffix is added automatically during the build process)
## Commands
The files are not usable on their own.
They have to be parsed and compressed down to a `.osk` file.
Run the following commands to generate the skin archive.
To generate a `.osk` osu skin file, run the following commands.
> Note that the commands assume they are called from the project root
Install dependencies:
```bash
pip install -r requirements.txt
```
Build skin:
```bash
python src
```
## What's in it?
Though no images have a `@2x` postfix, they are all HD images. The postfix are added automatically during the build process.
- [sounds](https://github.com/ppy/osu-wiki/blob/master/wiki/Skinning/Sounds/en.md)
- [hitcircles](https://github.com/ppy/osu-wiki/blob/master/wiki/Skinning/osu!/en.md#hit-circles)
- [cursor](https://github.com/ppy/osu-wiki/blob/master/wiki/Skinning/Interface/en.md#cursor)
- [hit bursts](https://github.com/ppy/osu-wiki/blob/master/wiki/Skinning/Interface/en.md#hit-bursts)
- [default numbers](https://github.com/ppy/osu-wiki/blob/master/wiki/Skinning/osu!/en.md#default-numbers)
- [slider](https://github.com/ppy/osu-wiki/blob/master/wiki/Skinning/osu!/en.md#slider)
- [spinner](https://github.com/ppy/osu-wiki/blob/master/wiki/Skinning/osu!/en.md#spinner)
1. Install dependencies
```bash
pip install -r requirements.txt
```
2. Build skin
```bash
python src
```
## Resources
- [osu! wiki page about skinning](https://osu.ppy.sh/wiki/en/Skinning)
- some assets are from:
- [monko2k's skin](https://skins.osuck.net/skins/2011)
- [(base) vaxei's skin (blue, instant-fade)](https://drive.google.com/file/d/16YhU5yI4rgHFoK8PzBeFGDQoywWua417/view)
- [osu!pure skin](https://www.reddit.com/r/OsuSkins/comments/kzv7s4/osupure_169_hdsd_osustandard)
- [-#KW-! If there was an endpoint](https://osu.ppy.sh/community/forums/topics/1672096)
- https://osu.ppy.sh/wiki/en/Skinning
## License
<ins>The source code of this project</ins>\* is available under the MIT License.
\*Excluding assets such as images, fonts, and audios.
Fonts:
- [Source Code Pro](https://fonts.google.com/specimen/Source+Code+Pro): Open Font License (OFL)
- [Noto Sans](https://fonts.google.com/noto/specimen/Noto+Sans): Open Font License (OFL)
All non-asset files of this project are available under the GPL v3 License.