Home

Welcome to the Amy wiki!

Amy is a personal assistance system, which tries to use as few cloud services as necessary.

The main audience of this wiki are developers, who want to contribute or just understand the code. If you are looking for instructions on how to install Amy look in our README.

Our code is based on some rough architecture sketches. A short explanation of how we use issues can be found here.

Building

Due to an issue with jersey and an issue with MaryTTS, the project currently only builds with java 8.

IDE

We are using Eclipse to develop Amy. In git the required eclipse config are present, for Eclipse Oxygen and Eclipse Photon. IntelliJ can also be used, by importing the project as eclipse project.

The code

Our project can be seperated in to major parts. The framework and the plugins.

The framework mainly consist of these parts:

• The core
• The dependency injection
• The http server
• The message hub
• The rest resources of the framework
• The main part of the web app
• The dialog system

Then there are currently the following plugins:

• Example and Hello World
• Alarmclock
• Calendar
• Email
• Navigation
• Spotify
• Systemtime
• Timer
• Weather
• Tosca

How To's

• How to create a plugin
• How to test