tadashi-hikari / sapphire-assistant-framework

An extensible framework for creating Android Assistants on-device. It does not require Google services or network connectivity

The Sapphire Assistant Framework

The Sapphire Assistant Framework is plug-in framework for Athena, an open source Google Assistant replacement (that doesn't require any Google services to run).

The Sapphire Framework is a data aggregation and processing framework for Android that allows users and developers to refine, customize, or develop a mobile assistant tailored to their needs.

Highlights

• Free and Open Source
• Doesn't use Google services
• Works on Android 7.1 to 11
• Works entirely offline/on device
• Highly modular and extensible

Motivation

The Sapphire Framework was developed to meet the needs of the open source community, while offering quality alternatives to producs in the closed source world. My original goal was simply to find a flexible mobile assistant that I could develop features for to help manage my ADHD. Finding nothing on the market to meet my need that also respected the ethics of free and open source software, I decided to start developing my own. It started out as a port of Mycroft for Android but due to system differences it quickly turned into its own project under the title "The Sapphire Assistant Framework". Due to concern that configuring the Sapphire Framework might overwhelm non-technical users, I split the code base in two to create Athena and the Sapphire Framework, which can be installed stand alone or as a plug-in to Athena.

How to Build The Sapphire Framework

It requires both Android platform 25 and 30 in order to build, and each individual module must be built and installed separately. The project was designed this way to test running 3rd party services in the background. If you are looking for something that works out of the box or is easier to build, I recommend looking at Athena

Build Status

Pre-Alpha

Frameworks and Libraries Used

• CMU PocketSphinx
• TensorSpeech TTS
• Stanford CoreNLP

Contributions

• Financial contributions are always appreciated, and can help me move to making this my full time job. Check out the sponsor button in the repository if you are interested in helping to fund the project
• Join in the community on Reddit or Matrix at #SapphireFramework:matrix.org
• Android, Machine Learning developers, and UI/UX developers would be greatly appreciated for the project (or consulting at a minimum). I will continue to move forward reguardless, but it will go a lot quicker with some domain specific expertise
• Documentation help would be greatly appreciated. I generally have all of the information locked up in my head and I am working on documentation, but sometimes I miss what others would find helpful or need more information on. Feel free to ask questions on Reddit or Matrix (I'm pretty responsive) if you would like to help out

sapphire-assistant-framework's Issues

A README or documentation detailing how it works and usage section would be appreciated!

TODO: port my plugin interface (plugin management system) to this project

https://github.com/mgood7123/Android-VST-Manager

Crashed whole system UI

when i ran it for few minutes and kept feeding voice, it crashed and except the status bar whole screen went black until restart. I know it's a prelease build, just wanted to report as much as i understand.

Consider f-droid inclusion

Hi, it seems that the project is still in earl development (it looks like an amazing idea!), once you feel it is polished up enough, would you consider releasing it on f-droid? https://gitlab.com/fdroid/rfp/-/issues If you don't know it, f-droid is an appstore for FLOSS only apps and it would be great having an assistant there :)

Request for simple editor in Chatbot Module

Could there be an easy way to let non-programmers help with the chatbot module? That way, they don't need as much experience coding, but the chatbot can be improved.

is there any new work or release

Please dear developer work more on it.

Make the CoreSimpleActivity textView horizontally scrollable.

I hate Android front end (I'm not very good at it yet), and for the life of me can't seem to get the TextView in CoreSimpleActivity to scroll horizontally. Help with that would be appreciated.

API23 support

As far as I can see, the app has no support for devices with API23 (Android 7.0 and greater) while the minimum is API24. Is there a possibility for supporting those devices?

Tested on Honor 6A, Android 7.0