From ac62b4f74f79f229167d5c56a6737254970862ad Mon Sep 17 00:00:00 2001 From: Muhammad Tamir Date: Tue, 8 Jul 2025 16:33:39 +0700 Subject: [PATCH] License & Readme --- LICENSE | 21 +++++++++++++++++++++ README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 73 insertions(+) create mode 100644 LICENSE create mode 100644 README.md diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..7c85c63 --- /dev/null +++ b/LICENSE @@ -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. diff --git a/README.md b/README.md new file mode 100644 index 0000000..6ed16d4 --- /dev/null +++ b/README.md @@ -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 reโ€‘uploads 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, youโ€™ll find the optimized `.zip` under the **Actions โ†’ Artifacts โ†’ optimized-pack** section.