Skip to content

Latest commit

 

History

History
121 lines (87 loc) · 4.55 KB

README.md

File metadata and controls

121 lines (87 loc) · 4.55 KB
Raw

Discord


Logo

MusicBee Remote (plugin)

A Plugin for MusicBee that allows you to control it through the MusicBee Remote Android Application
Application

Help · MusicBee Forum · Report Bug · Request Feature

Table of Contents

About the Project

Project Screenshot

The plugin is an essential part of MusicBee Remote. It acts as a bridge that allows the Android application to communicate with MusicBee. The plugin exposes a socket server (TCP) that listens for incoming connections from the plugin.

It uses a text based protocol that is uses newline separated JSON messages. Those messages are then translated to calls of the MusicBee API.

Built With

Getting Started

If you are an end user you can download the plugin from releases. You can find an installer for a regular installation of MusicBee along with a zip that can be used with the store version.

As a developer there are a few steps you need to follow to get started:

Prerequisites

The project requires Visual Studio 2022 Community and MusicBee installed.

After getting the basic environment setup you just need to clone the project from command line:

git clone https://github.com/musicbeeremote/mbrc-plugin.git

or you could use your visual Git interface to clone the repository.

Installation

After cloning the project you can go and open the MBRC.sln solution in Visual Studio. The first thing you need to do is to restore the NuGet dependencies so that you can start build the solution.

Usage

While building and testing the application you need a network interface that will listen for incoming connections. This has to be in the same network as the one where the device you use to test is.

If you are using a Windows Virtual Machine for development as I do, then you have to make sure that the virtual machine is using a Bridged connection, otherwise you might not be able to connect to the plugin.

Contributing

Contributions are always welcome. The contribution guide should follow soon.

Building

You can build the application either through Visual Studio or by running build.bat. The bat file supports either Release by default or Debug configurations.

It will also copy the merged mb_remote.dll to the MusicBee plugin's folder.

License

The source code of the application is licensed under the GPLv3 license. See LICENSE for more information

MusicBee Remote (Plugin for MusicBee)
Copyright (C) 2011-2023  Konstantinos Paparas

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.