{"id":17694107,"url":"https://github.com/jordanviknar/stompmyfiles","last_synced_at":"2025-03-30T23:22:23.198Z","repository":{"id":204144442,"uuid":"709308561","full_name":"JordanViknar/StompMyFiles","owner":"JordanViknar","description":"Universal file compression utility, aiming for brute strength and extreme ease of use.","archived":false,"fork":false,"pushed_at":"2024-09-23T12:08:05.000Z","size":59,"stargazers_count":1,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-06T04:51:19.639Z","etag":null,"topics":["7z","compression","dolphin","dolphin-emu","dolphin-tool","gamecube","lua","lzma2","ratio","rvz","smf","wii","xz"],"latest_commit_sha":null,"homepage":"","language":"Lua","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mpl-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/JordanViknar.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-10-24T13:09:07.000Z","updated_at":"2024-09-23T12:11:43.000Z","dependencies_parsed_at":null,"dependency_job_id":"332b4203-32ab-4408-a333-51c53bc834ac","html_url":"https://github.com/JordanViknar/StompMyFiles","commit_stats":null,"previous_names":["jordanviknar/stompmyfiles"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JordanViknar%2FStompMyFiles","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JordanViknar%2FStompMyFiles/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JordanViknar%2FStompMyFiles/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/JordanViknar%2FStompMyFiles/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/JordanViknar","download_url":"https://codeload.github.com/JordanViknar/StompMyFiles/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246392163,"owners_count":20769694,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["7z","compression","dolphin","dolphin-emu","dolphin-tool","gamecube","lua","lzma2","ratio","rvz","smf","wii","xz"],"created_at":"2024-10-24T13:47:50.193Z","updated_at":"2025-03-30T23:22:23.179Z","avatar_url":"https://github.com/JordanViknar.png","language":"Lua","readme":"*One day, [Jordan](https://github.com/JordanViknar) decided he had enough of wasting storage space on files he barely used.*\n\n*What if a tool existed that could **easily** crush anything in its path ? And thus came onto the world...*\n\n---\n\n# StompMyFiles\n\nUniversal file compression utility, aiming for brute strength (at the cost of time) and ease of use. Made in Lua.\n\n![License](https://img.shields.io/github/license/JordanViknar/StompMyFiles?color=orange)\n![Top language](https://img.shields.io/github/languages/top/JordanViknar/StompMyFiles?color=blue)\n![Commit activity](https://img.shields.io/github/commit-activity/m/JordanViknar/StompMyFiles?color=orange)\n![Repo size](https://img.shields.io/github/repo-size/JordanViknar/StompMyFiles)\n\n(Currently) available for :\n\n![Linux](https://img.shields.io/badge/Linux-FCC624?style=for-the-badge\u0026logo=linux\u0026logoColor=black)\n![Arch Linux](https://img.shields.io/badge/Arch_Linux-1793D1?style=for-the-badge\u0026logo=arch-linux\u0026logoColor=white)\n![Manjaro](https://img.shields.io/badge/manjaro-35BF5C?style=for-the-badge\u0026logo=manjaro\u0026logoColor=white)\n\n## Goals\n\nStompMyFiles aims to be :\n- **Powerful**, no matter the cost : StompMyFiles' first aim is to compress files given to it as hard as it can, under the best known method available depending on the file's type.\n- **Extremely simple to use** : You give it a file, it replaces it with its compressed version if possible. There's **nothing** more to it.\n- **Lossless** : Every single piece of data originally present must be able to be restored from StompMyFiles, with just the compressed file itself.\n\n*Note : StompMyFiles focuses so heavily on compression strength that it's pretty CPU and RAM intensive, and may even be slow in a few cases. As such, it may not always be the best fit for your use case.*\n\n## Installation\n\n### Arch Linux-based distributions\n\nStompMyFiles can be installed from Arch Linux through the provided [PKGBUILD](https://github.com/JordanViknar/StompMyFiles/blob/main/install/archlinux/PKGBUILD).\n\n**Always** download the latest version of the PKGBUILD, then use **makepkg** in its directory.\n\nIt will eventually be made available on the AUR once the program is complete enough.\n\n### I want to add support for my own distribution !\n\nHere are informations which might be useful to you :\n\nStompMyFiles is meant to be installed in `/usr/share/stomp-my-files` (except `smf` which goes into `/usr/bin`).\n\nIt depends on :\n- Lua 5.4 *(5.3 and 5.2 MIGHT work)*\n- [LuaFileSystem](https://github.com/lunarmodules/luafilesystem)\n- [LuaSocket](https://github.com/lunarmodules/luasocket) + [LuaSec](https://github.com/lunarmodules/luasec)\n- Common tools such as : *which*, *tar*, *grep*, *xz*\n\nAnd optionally :\n- 7-zip / p7zip : If the system doesn't provide them, StompMyFiles will download them if possible.\n- Dolphin Emulator : StompMyFiles uses *dolphin-tool* to compress Nintendo Wii/GameCube games.\n\n### Manual local installation (not recommended except for development)\n\nInstall the aforementioned dependencies on your system, clone the repository, and run `./smf`, assuming you're in the program's directory.\n\n## Usage\n\n```\nsmf [OPTIONS] FILES ...\n```\n\nAvailable options :\n- `--help` : Displays StompMyFiles' help page\n- `--verbose` : Used for debugging. Makes StompMyFiles more explicit about what it's doing.\n- `--version` : Reports StompMyFiles' version and shows a small description.\n\nISO file specific options (if none of these are specified, StompMyFiles will skip them) :\n- `--iso` : Tells StompMyFiles to treat ISO files normally.\n- `--wii-gc` : Tells StompMyFiles to treat ISO files as Wii/GameCube games.\n\n## Support\n\n| Tool | Local Download | Compression / Decompression | Used for |\n| ---- | -------------- | --------------------------- | -------- |\n| 7z | ✅ | ✅ | Folders |\n| xz | ❌ | ✅ | Default choice for single files |\n| dolphin-tool | ❌ | ✅ | Nintendo Wii / GameCube games (requires Dolphin Emulator to be installed) |\n| nsz | *Planned* | *Planned* | Nintendo Switch games |\n| upx | *Planned ?* | *Planned ?* | Executables |\n\n## Compression Test Results\n\n### Personal Files\n\n| Up-to-date | File(s) | Tool | Original Size | SMF Output | Percentage |\n| ---------- | ------- | ---- | ------------- | ---------- | ---------- |\n| ✅ | First Year of Pre-Engineering | 7z | 579.8 Mo | 431.1 Mo | 74 % |\n| ✅ | Second Year of Pre-Engineering | 7z | 1.1 Go | 731.9 Mo | 67 % |\n\n### Applications / Games\n\n| Up-to-date | Application | Type | Tool | Original Size | SMF Output | Percentage |\n| ---------- | ----------- | ---- | ---- | ------------- | ---------- | ---------- |\n| ✅ | Celeste | Steam Game (Linux) | 7z | 1.2 Go | 770.6 Mo | 64 % |\n| ✅ | Um Jammer Lammy | PlayStation 1 Game | xz | 743.5 Mo | 499.5 Mo | 67 % |\n| ✅ | Super Smash Bros. Brawl | Wii Game |  dolphin-tool | 8.5 Go | 5.8 Go | 68 % |\n| ✅ | Rayman Redemption | Windows Game | 7z | 1.3 Go | 879.8 Mo | 68 % |\n| ✅ | Pizza Tower | Steam Game (Windows) | 7z | 256.8 Mo | 185.4 Mo | 72 % |\n\n## Bug Reports / Contributions / Suggestions\nYou can report bugs or suggest features by making an issue, or you can contribute to this program directly by forking it and then sending a pull request.\n\nAny help will be very much appreciated. Thank you.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjordanviknar%2Fstompmyfiles","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjordanviknar%2Fstompmyfiles","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjordanviknar%2Fstompmyfiles/lists"}