Skip to content

Commit cae26d3

Browse files
Update README.md
1 parent feb578b commit cae26d3

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ A basic scraper you can use to get the name, description, and actual skin off of
44
Simply run the program `scraper.py` with all the dependencies from [requirements.txt](https://github.com/RandomGamingDev/mcskins-net-scraper/blob/main/requirements.txt) installed and it will create a `skins` directory that will contain each category with each category containing folders with each folder representing a skin and each folder containing a `meta.txt` which contains the title and description and a `skin.png` containing the actual skin. This can then be easily searched through or used in whatever you want, whether it be something like a website, to train a ML model, or anything else. Please note, that I do not legally own this data which is why it isn't posted alongside the scraper, if you want the data you can scrape it yourself (it's just 104 lines of code after all just look through it there isn't really any risk to running it).
55

66
The rest of the python files are:
7-
- `to-new-skins.py` for cleaning the data by converting all pre-1.8 skins to their newer version using `mc_skin_updater.py` from https://github.com/RandomGamingDev/mc_skin_updater_py
8-
- `to-imagefolder.py` for converting to a format that's easier for use in things like HuggingFace (although I still recommend you do stuff like zip the file)
7+
- `to-new-skins.py` for cleaning the data by converting all pre-1.8 skins to their newer version using `mc_skin_updater.py` from https://github.com/RandomGamingDev/mc_skin_updater_py. This script expects the default structure from scraping (which it keeps the same).
8+
- `to-imagefolder.py` for converting to a format that's easier for use in things like HuggingFace (although I still recommend you do stuff like zip the file) and for general processing. This script expects the default structure from scraping (which it converts to the imagefolder structure).
9+
- `to-1dir-dataset.py` for converting to a format that's easier to use for multiple projects. This script expects the imagefolder structure from converting the data via `to-imagefolder.py` (which it converts to a 1 directory based basic structure).
910

1011
Note: This doesn't make use of any async or multithreaded code, and is completely made with synchronous code. This makes it easier to understand for more people, but far slower, and tbh part of it's just the fact that I don't feel like optimizing it any further since tthis is sufficient for my needs. However, if you feel like optimizing it and creating a fork or pull request go right ahead :D

0 commit comments

Comments
 (0)