Add README.md and LICENSE

This commit is contained in:
Natalia Cholewa
2020-10-28 18:13:16 +01:00
parent fce5259634
commit 7766c553dc
2 changed files with 17 additions and 0 deletions

10
README.md Normal file
View File

@@ -0,0 +1,10 @@
# mcassetdownloader
Mcassetdownloader is a simple C# console application used to download Minecraft assets directly from Mojang servers and pack them into a resource pack zip archive.
## Usage
Run `Mcassetdownloader.exe [version] [target zip path]`, e.g. `Mcassetdownloader.exe 1.16.3 resources.zip` to begin the download and packaging. If the archive already exists, you'll be asked whether you want to overwrite it. The process might take a while, depending on your network and machine speed.
Note, that the program might use a lot of RAM. In my tests the usage never reached 500 MB, though. Also note, that there's basically no error handling, so if anything goes wrong, bad things may happen.
## License stuff
So, I guess I need a license for this, eh? Let's go with MIT License, see [LICENSE](LICENSE). Also, this program uses [Newtonsoft.Json](https://www.newtonsoft.com/json) for JSON parsing.