Skip to content

Latest commit

 

History

History
82 lines (54 loc) · 2.67 KB

README.md

File metadata and controls

82 lines (54 loc) · 2.67 KB
Raw

Musicify

License badge Mentioned in Awesome ComputerCraft CC: Tweaked Version: 1.100+

Musicify is a command line utility for ComputerCraft:Tweaked to stream* songs in game.

Install

To install, run

wget run https://raw.githubusercontent.com/knijn/musicify/main/install.lua

Codespaces

To develop under Codespaces, you'll need the CraftOS VSCode Extention and install CraftOS-PC with the following commands:

sudo add-apt-repository ppa:jackmacwindows/ppa
sudo apt update
sudo apt install craftos-pc

License

Musicify is licensed under the GNU General Public License v3.0.

Commands

musicify help

Shows the help menu showing all commands

musicify list

Shows all of the playable songs in the repository set

musicify info

Displays info about the current version of Musicify, and about the repository set

musicify play

Plays the song with the specified ID

musicify playlist

A playlist file has the following format: <songid>,<songid>,<songid>,<songid>. These song IDs can be found using musicify list. And can also be URLs.

musicify gui

Show an in development GUI

musicify shuffle [from] [to]

Shuffle the songs in the repository, and optionally from and to a specific song id

musicify update

Forces an update on Musicify

musicify loop

Loops over a specific song or URL

musicify url

Plays a specific URL

Setup

Set up your Computer with the install command above. Make sure to have a speaker and a modem (or ender modem) attached if you want to use multiple speakers

Musicify offers the following configuration options:

  • musicify.repo: Sets the repo to music load from (default: https://raw.githubusercontent.com/knijn/musicify-songs/main/index.json)
  • musicify.autoUpdates: Sets whether Musicify will automatically update when there's a new version. (default: true)
  • musicify.serverChannel: Sets the channel to broadcast audio packets on
  • musicify.serverMode: Sets whether Musicify will broadcast audio packets

Development

The program also should work as an api, this is not tested though. If you want to support the program, please make a pull request. It helps out a ton!

If you want to run the development version of Musicify, run

wget run https://raw.githubusercontent.com/knijn/musicify/mian/git_install.lua