freesound-credits
| Crates.io | freesound-credits |
| lib.rs | freesound-credits |
| version | 0.2.20 |
| source | src |
| created_at | 2024-08-06 13:01:00.004912 |
| updated_at | 2024-10-20 10:38:40.270603 |
| description | A simple command line utility to credit Freesound samples in a usable markdown file |
| homepage | https://andreacfromtheapp.github.io/apps/freesound-credits |
| repository | https://github.com/andreacfromtheapp/freesound-credits |
| max_upload_size | |
| id | 1327250 |
| size | 91,036 |
Andrea C (gacallea)
documentation
README
freesound-credits
A command line utility to help you credit Freesound samples for a given project more easily.
Giving credits
Giving credits in the Creative Commons community is often the sole requirement to freely use samples in your own creations. This tool helps you abide to Copyleft and credit the generous artists that contribute sounds on Freesound, helping you being more creative.
Until today, giving credits may have been a process that you begrudged. This may have been stopping you from giving credits altogether. Not because you didn't want to, but because it was cumbersome and tedious.
Not anymore! Thanks to freesound-credits it takes seconds now!
Install
Use cargo binstall to install
freesound-credits directly from GitHub:
cargo binstall freesound-credits
Homebrew
On Linux and macOS homebrew is also available:
brew install gacallea/tap/freesound-credits
Usage
The command line comes with a straight-forward usage function:
freesound-credits -h
Usage example
- open your favorite terminal.
cdto the folder where you want to save the credits file.- run
freesound-creditson your desired samples folder. - if necessary, use the absolute path to the samples folder.
Ableton Example
Running against an Ableton Samples/Imported directory, will generate a
markdown file named field-notes-credits.md in the current directory.
freesound-credits -p Samples/Imported/ -t "Field Notes" -a "Aner Andros" -d "2017-10-28"
Supported file names
freesound-credits matches samples adhering to Freesound naming standard that
kept their original samples names per downloads from the platform. For example:
- new standard with double underscore:
69604__timkahn__subverse_whisper.wav - old standard with single underscore:
2166_suburban_grilla_bowl_struck.flac
Supported DAWs
freesound-credits should work for any samples stored in a flat folder.
freesound-credits filters out metadata files associated with audio imports.
To add more DAWs and associated metadata or extraction, please file an
issue.
| DAW | Samples Folder | Metadata | Extraction | Notes |
|---|---|---|---|---|
| Ableton | Samples/Imported |
.asd |
no | |
| Reaper | Audio Files |
.reapeaks |
no | |
| Renoise | SamplesData |
no | unzip |
extraction |
| Logic Pro X | Audio Files |
no | no | Package vs Folder |
Adding more DAWs
I did the best I could with what I have. I've tested it with Ableton, Reaper, and Renoise projects on macOS. Logic Pro X uses no metadata and a clean Audio files folder, thus I decided to add it but it hasn't been tested.
However, any DAW with these characteristics should work out of the box. I would appreciate anybody confirming more DAWs or adding new ones. When you do request or add a new DAW, please keep the above table and the extra steps section in mind for any extra information.
Extra DAWs steps
Renoise extraction
Extract with unzip your_project.xrns first. Once unzipped, you will find a
Song.xml file and a SamplesData directory containing each Instrument.
Contributing
Thanks for your help improving the project! :balloon: Happy to have you! Peruse the contributing guide to help you get involved in the project.