{"id":17762078,"url":"https://github.com/b0ney/xmodits-cli","last_synced_at":"2025-03-15T11:33:00.452Z","repository":{"id":183715349,"uuid":"580809482","full_name":"B0ney/xmodits-cli","owner":"B0ney","description":"Command line version of xmodits - A tool to rip samples from tracker modules.","archived":false,"fork":false,"pushed_at":"2024-09-04T12:55:38.000Z","size":164,"stargazers_count":11,"open_issues_count":1,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-27T01:06:04.660Z","etag":null,"topics":["audio","cli","fasttracker2","impulsetracker","protracker","ripper","rust","screamtracker","tracker-music","xmodits"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/B0ney.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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":"2022-12-21T14:02:19.000Z","updated_at":"2025-02-23T14:23:27.000Z","dependencies_parsed_at":null,"dependency_job_id":"b99876e7-0893-4742-9026-53ac89a8de32","html_url":"https://github.com/B0ney/xmodits-cli","commit_stats":null,"previous_names":["b0ney/xmodits-cli"],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/B0ney%2Fxmodits-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/B0ney%2Fxmodits-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/B0ney%2Fxmodits-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/B0ney%2Fxmodits-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/B0ney","download_url":"https://codeload.github.com/B0ney/xmodits-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243725011,"owners_count":20337660,"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":["audio","cli","fasttracker2","impulsetracker","protracker","ripper","rust","screamtracker","tracker-music","xmodits"],"created_at":"2024-10-26T19:51:39.750Z","updated_at":"2025-03-15T11:33:00.124Z","avatar_url":"https://github.com/B0ney.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":" \n## Supported Tracker Formats\n| Extension | Format | \n| - | - |\n| ``.it`` | Impulse Tracker |\n| ``.xm`` | Extended Module | \n| ``.s3m`` | Scream Tracker 3 |\n| ``.mod`` | Amiga Pro Tracker |\n| ``.mptm`` | ModPlug Tracker module |\n| ``.umx`` | Unreal Music Package (Containing above) |\n\n## Supported Exports\n| Extension | Format |\n|-|-|\n|``.wav``| Microsoft Wave|\n|``.aiff``| Audio Interchange File Format |\n|``.its``| Impulse Tracker 2 sample |\n|``.s3i``| Scream Tracker 3 Instrument |\n|``.8svx``| 8-Bit Sampled Voice |\n|``.raw``| Headerless pcm |\n\n# Download\nThe command line version of xmodits can be downloaded [here](https://github.com/B0ney/xmodits-cli/releases).\n\nIf you want a more user friendly version, consider getting the gui version [here](https://github.com/B0ney/xmodits/releases). Do note that the gui version has less supported platforms.\n\nPlease have a look at [running on older systems](#running-on-older-systems).\n\n# How to Use\n\n```\nxmodits {ARGUMENTS} \u003cmodule path\u003e [destination folder]\n\ne.g:\n    xmodits ./test.s3m ~/Music/Samples/\n\n    xmodits ./test.s3m\n\n    xmodits ./mod1.mod ./mod2.it ./mod3.s3m [destination folder]\n\n    xmodits --fmt=\"8svx\" ./*.mod ~/Downloads/samples/8svx\n\n```\nNote: If the destination is not provided, xmodits will place the ripped samples in a self contained folder in the current working directory.\n\n## Additional Arguments\nIf you want to customize how ripped samples are named, the following arguments can be used:\n\n|short| long| Description|\n|-|-|-|\n|-s |--strict| ``Enabled by default.`` Only allow files with the supported file extensions: [``it``, ``xm``, ``s3m``, ``mod``, ``umx``, ``mptm``]|\n|-i |--index-only| Ripped samples will only be named with an index.|\n|-r |--index-raw| Preserve internal sample indexing.|\n|-p |--index-padding| Pad sample index with preceding zeros. 0-1 will disable padding.|\n|-n |--no-folder| Do not create a new folder for ripped samples.|\n|-u |--upper| Name samples in upper case. |\n|-l |--lower| Name samples in lower case. |\n|-g |--prefix| Prefix samples with the tracker's filename. |\n|-f|--fmt| Export samples to the following formats: [ ``wav (default)``, ``aiff``, ``8svx``,``its``,``s3i``, ``raw`` ]|\n\n## Commands\n|short|long|description|\n|-|-|-|\n||--info| Print information about a tracker module. |\n||--Meta| Print metadata about the binary.|\n|-V|| Print version|\n\n# Building\nInstall the Rust compiler if you haven't already: https://www.rust-lang.org/tools/install\n\nClone the source code:\n```shell\ngit clone https://github.com/B0ney/xmodits-cli\n```\n\nBuild:\n```shell\ncd xmodits-cli\ncargo build --release\n```\n\nThe compiled binary is placed in: ``xmodits-cli/target/release/``\n\n(***nix systems only**) You may get a ``Permission denied`` error if you attempt to run the program. In that case, you'll need to mark the binary as executable:\n\n```shell\nchmod +x xmodits\n```\n\n(**Optional**) Compile with build metadata embedded in the binary (enables ``--Meta`` flag), **This will take longer to compile**:\n```shell\ncargo build --release --features=\"with_metadata\"\n```\n\n(**Experimental**) Compile with multi-threading:\n```shell\ncargo build --release --features=\"rayon\"\n```\n\n# Running on older systems\n\u003c!--Unlike its [big brother](https://github.com/B0ney/xmodits), xmodits-cli will always run in a single thread\n(unless you compile with ``--features=\"rayon\"``).--\u003e\n\n## Windows\nMinimum supported OS: Windows 7\n\nXMODITS is compiled with vcruntime (msvc only) embedded, so it should run out of the box.\n\n## Linux\n**For backwards (and forwards) compatibility, it is recommended that you download the ``*-musl`` variant.**\n\nOlder linux systems may have glibc versions too old to run the program.\n\nYou'll most likely get an error like this if you attempt to run the ``*-gnu`` variant:\n```\nlibc.so.6: version `GLIBC_2.18` not found (required by ./xmodits)\n```\n\n# License\nxmodits-cli is licensed under the LGPLv3\n\n# Other xmodits projects\n\n|Program| License|Description|\n|--|--|--|\n|[XMODITS-GUI](https://github.com/B0ney/xmodits) | GPLv3| xmodits gui application|\n|[XMODITS-PY](https://github.com/B0ney/xmodits-py)| LGPLv3 | xmodits Python library \u003cbr\u003e (Mainly used for [DawVert](https://github.com/SatyrDiamond/DawVert))|\n|[XMODITS-LIB](https://github.com/B0ney/xmodits-lib) | MPLv2 | xmodits core library|\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fb0ney%2Fxmodits-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fb0ney%2Fxmodits-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fb0ney%2Fxmodits-cli/lists"}