Skip to content

kelsos/mbrc

 
 

Repository files navigation

CI codecov GitHub GitHub release Discord Join the chat at https://gitter.im/musicbee-remote/Lobby


Logo

MusicBee Remote

Application for controlling MusicBee through your Android Device
Play Store

Help · MusicBee Forum · Report Bug · Request Feature

Table of Contents

About the Project

MusicBee Remote Screenshot

MusicBee Remote is an application that allows you to control MusicBee player. This is achieved by using a plugin that acts as a server. The plugin exposes a TCP socket server and uses a JSON based protocol to communicate with the Android application.

The application development started in 2011 for personal usage and then it was open sourced and released to Play Store so others could use it. The application was also presented as part of my thesis title "Android and application development for mobile devices".

Built With

Getting Started

In order to get started with the project as a developer there are a few steps you need to follow.

Prerequisites

Android Studio should be installed on your local machine and it should be up to date.

During development the Canary version of the Android Studio is used, but for release versions the stable version of AGP is always preferred.

To get started with the the project you first have to clone the project.

git clone https://github.com/musicbeeremote/android-app.git

Then you can open the project with Android Studio.

Installation

There is a number of ways you could install the application on your device. If you are a developer you can run install on Android Studio and that should take care of the installation.

Alternatively you could download a stable version of the Remote from Play Store.

The Play Store version of the remote include FireBase and Crashlytics and collects anonymous analytics.

Alternatively there is a GitHub version on the releases page that doesn't include any Crash or analytics reporting for people that are cautious about their privacy.

Usage

In order to use the application you need a working WiFi connection, that doesn't have access point isolation.

You have to first install the plugin.

After installing the plugin if you are not prompted to allow MusicBee or the plugin through the Windows Firewall you might have to manually configure Windows Firewall to allow the plugin to receive connections.

For more detailed information you can check the help page.

Contributing

Contribution is always welcome. The contribution guide should follow soon.

License

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

MusicBee Remote (for Android)
Copyright (C) 2011-2019  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/>.

Contact

MusicBee Remote - @MusicBeeRemote

Project Link: https://github.com/musicbeeremote/android-app

Acknowledgements

Tasos created many of the icons, and was responsible for the Holo design of the application. Most of the icons are licenced under the Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License..

Jordan is responsible for the conception and creation of the application logo.

  • Carlos Parga

Carlos created some really nice mockups from where I drew inspiration while working on the UI.

Apollo Player was one of the original sources of inspiration for the UI of MusicBee Remote

About

MusicBee Remote for Android

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Kotlin 97.6%
  • HTML 2.4%