3
0
mirror of https://github.com/NekoMonci12/mine-compress.git synced 2025-12-19 15:09:20 +00:00

License & Readme

This commit is contained in:
Muhammad Tamir
2025-07-08 16:33:39 +07:00
parent 8b3ed2ca80
commit ac62b4f74f
2 changed files with 73 additions and 0 deletions

21
LICENSE Normal file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2025 Muhammad Tamir
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

52
README.md Normal file
View File

@@ -0,0 +1,52 @@
# 🛠️ Mine Compress
A Linux shell script to optimize Minecraft resource packs by reducing the size of `.png` and `.ogg` files without losing significant quality.
---
## ✨ Features
- 🔍 Recursively scans a target folder
- 🖼️ Optimizes `.png` files using `optipng -o7`
- 🔊 Re-encodes `.ogg` files with `ffmpeg` to mono, 64kbps
- 📦 Automatically installs required dependencies (Debian, Fedora, Arch)
- ✅ Interactive CLI input
---
## 🚀 How It Works
1. **User submits an issue** using the issue template.
2. The issue is labeled `optimize-request`.
3. GitHub Actions parses the issue form, downloads the `.zip`, optimizes assets, and reuploads the optimized `.zip` as an artifact.
---
## 🧾 Usage
### 1. Clone Repository
```bash
git clone https://github.com/NekoMonci12/mine-compress.git
cd mine-compress
chmod +x optimize_resources.sh
```
### 2. Run The Scripts
```bash
./optimize_resources.sh
```
## 📦 Requirements
- optipng
- ffmpeg
- zip
---
## 📥 Github Workflows
1. [**Click Here**](https://github.com/NekoMonci12/mine-compress/issues/new?template=optimize_request.yml) For Create New Issue.
2. Provide a **public `.zip` URL** of your resource pack.
3. The issue is automatically tagged with `optimize-request`.
4. GitHub Actions runs the optimization workflow.
Once the workflow completes, youll find the optimized `.zip` under the **Actions → Artifacts → optimized-pack** section.