roturMusic

Rotur Music is a self hosted music streaming server built in OSL.go and lets you serve your music library to your devices.

Philosophy

• roturMusic aims to be simple, lightweight and not require any configuration to get started.
• all music is downloaded to your device in order to play it. There is no streaming involved.
• roturMusic is not a music player, it is a music server.

Features

• Download music from your local music library
• Playlist support
• Search for songs, albums, and artists
• Playback controls (play, pause, skip, etc.)
• Volume control
• Shuffle and repeat options
• Responsive design for mobile and desktop
• Open standard for custom clients to connect to the server

Installation

To install Rotur Music, you will need to have OSL.go installed on your system. Once you have OSL.go installed, you can clone the Rotur Music repository and run the following command to install the dependencies:

git clone https://github.com/roturTW/music
cd music
osl run main.osl

Usage

To start the Rotur Music server, run the following command:

osl run main.osl

This will start the server on port 8080. You can then access the Rotur Music web interface by navigating to localhost:8080 in your web browser.

Configuration

Rotur Music can be configured by editing the config.json file in the root directory of the project. The following options are available:

• port: The port number to use for the server. Default is 8080.
• musicDir: The directory where your music files are stored. Default is /music.
• playlistDir: The directory where your playlists are stored. Default is /playlists.

Contributing

Contributions to Rotur Music are welcome! If you would like to contribute, please fork the repository and create a pull request with your changes. Please ensure that your code follows the existing code style and includes appropriate comments and documentation.

License

Rotur Music is licensed under the MIT License. See the LICENSE file for more information.