Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Ale32bit/Quartz
MDFPWM player for ComputerCraft
https://github.com/Ale32bit/Quartz
cctweaked computercraft computercraft-tweaked dfpwm
Last synced: about 2 months ago
JSON representation
MDFPWM player for ComputerCraft
- Host: GitHub
- URL: https://github.com/Ale32bit/Quartz
- Owner: Ale32bit
- License: gpl-3.0
- Created: 2024-02-12T18:02:59.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-04-08T10:19:57.000Z (9 months ago)
- Last Synced: 2024-08-04T02:07:42.272Z (5 months ago)
- Topics: cctweaked, computercraft, computercraft-tweaked, dfpwm
- Language: Lua
- Homepage:
- Size: 82 KB
- Stars: 9
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-switchcraft - Quartz - DFPWM and MDFPWM audio player for ComputerCraft (Programs / Other)
README
# Quartz
DFPWM and MDFPWM audio player for ComputerCraft.
## Installation
Quartz can be installed by executing the `download.lua` file or by copy pasting this command:
```
wget run https://raw.github.com/Ale32bit/Quartz/main/download.lua
```
## Usage
Run the `player.lua` program and insert a disk containing a .dfpwm or a .mdfpwm file.
### Controls
| Key | Description |
| --------- | ----------------------------------- |
| Space | Play/Pause/Resume |
| S | Stop |
| Left | Backward 5 seconds |
| Right | Forward 5 seconds |
| Up | Volume up |
| Down | Volume down |
| Page Up | Distance Up |
| Page Down | Distance Down |
| F1 | Toggle log screen (keys still work) |
## Configuration
Quartz can be configured with the use of the `set` command.
| Key | Description | Type | Default |
| ---------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------- | ------------------------ |
| `quartz.left` | Left channel speaker, can be a side of the computer or a network name. | string | `left` |
| `quartz.right` | Right channel speaker, can be a side of the computer or a network name. | string | `right` |
| `quartz.volume` | Volume of the audio, must be a float number between 0.0 and 1.0. | number | `1.0` |
| `quartz.distance` | The range of the audio, must be an integer number between 0 and 128. | number | `1` |
| `quartz.loop` | Replays the audio track when it ends. | boolean | `true` |
| `quartz.autoplay` | Automatically plays the disk when the program is started. | boolean | `true` |
| `quartz.distributed` | Play mono audio on all speakers attached to the network. This setting disables `quartz.left` and `quartz.right`. Fine tune `quartz.distance` for best coverage. | boolean | `false` |
| `quartz.raw` | Skip the audio filters when decoding DFPWM. | boolean | `false` |
| `quartz.stream.server` | Server URL of the conversion service. No trailing slash. | string | `https://cc.alexdevs.me` |