Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
michaelphagen committed Apr 28, 2023
1 parent ab135e4 commit dc2511e
Show file tree
Hide file tree
Showing 6 changed files with 45 additions and 5 deletions.
50 changes: 45 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,49 @@ A Max/MSP Package Library of simple wrappers for the shell external object.
Gives users not profficient with shell commands or scripting access to usefull system functions in the form of modular max objects (subpatches).

Includes:
- shelly.directory: Create Directories directly from Max
- shelly.notification: Generate MacOS Notifications
- shelly.play: Play audio directly to your system DAC using the shell object
- shelly.sr: Check Sample Rate of DAC/ADC Devices
- shelly.volume: Change System DAC Volume
- [shelly.directory](#shellydirectory): Create Directories directly from Max
- [shelly.notification](#shellynotification): Generate MacOS Notifications
- [shelly.play](#shellyplay): Play audio directly to your system DAC using the shell object
- [shelly.sr](#shellysr): Check Sample Rate of DAC/ADC Devices
- [shelly.volume](#shellyvolume): Change System DAC Volume
- and [Jeremy Bernstein and Bill Orcutt's Incredible Shell Object](https://github.com/jeremybernstein/shell), which enables the 5 wrappers.

## Installation
1. Download the zip file from the [releases page](https://github.com/michaelphagen/Shelly/releases).
2. Unzip the file and place the folder in your Max Library directory (either `~/Documents/Max 7 or 8/Library` or `/Users/Shared/Max 7 or 8/Packages`).


# Modules
# shelly.directory
![shelly.directory](./docs/shelly.directory.png)

Create Directories directly from Max. The directory can be specifified as an an argument or a message box input to the module.
# shelly.notification

![shelly.notification](./docs/shelly.notification.png)

Generate MacOS Notifications. The notification title and message can both be specified as arguments or message box inputs to the module. The notifications will be hidden if the user is in do-not-disturb mode.
# shelly.play
![shelly.play](./docs/shelly.play.png)

Play audio directly to your system DAC using the shell object. Supports any format that afplay supports, including:
- .3gp
- .aac
- .aiff
- .aif
- .m4a
- .ec3
- .flac
- .mpeg
- .mp3
- .mp4
- .au
- .wav
# shelly.sr
![shelly.sr](./docs/shelly.sr.png)

Check Sample Rate of DAC/ADC Devices. The module takes a string input of the device name and outputs the sample rate.
# shelly.volume
![shelly.volume](./docs/shelly.volume.png)

Change System DAC Volume. The module takes an integer from 0-127 for easy mapping to a slider or dial.
Binary file added docs/shelly.directory.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/shelly.notification.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/shelly.play.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/shelly.sr.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/shelly.volume.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit dc2511e

Please sign in to comment.