ICEAgent

A local service for research.
ICEAgent allow you to add custom functionality via modules.
The main propose of this project is helping you use Google Cloud TTS more regularly.

Get Started

1. Prepare a virtual Python 3.7 environment. (3.8 is not support yet)
   conda is recommended, venv is also a good choice.

2. Enter into the root directory of ICEAgent, run pip install -r requirements.txt in Terminal/Command Prompt.

3. Add GOOGLE_APPLICATION_CREDENTIALS to your PATH.

   • You can get your credential file from Google
   • Windows: Search "edit environment variables" in your Start Menu, and find PATH to add the path of your json file.
   • macOS/Linux: run env GOOGLE_APPLICATION_CREDENTIALS=path/to/your/json/file in Terminal.
   • IDE(PyCharm etc.): Add environment variables to your project.

4. Install VLC media player.

   • macOS with Homebrew: run brew cask install vlc in Terminal
   • Others: Download from VLC homepage.

5. Install Postman. (Optional, Just for testing)

   • macOS with Homebrew: run brew cask install postman in Terminal.
   • Others: Download from Postman homepage.

6. run ICEAgent with python main.py.

FAQ

1. It warns me that the program cannot find LibVLC.
   A: Add vlc folder to your PATH. Same as you add GOOGLE_APPLICATION_CREDENTIALS.

2. I want to add my own modules.
   A: ICEAgent use Flask Blueprint to handle modules. After you building a module with blueprint, you can easily add a route to your module in main.py

Author

Zhou Fang @ Intelligent Computer Entertainment Laboratory of Ritsumeikan Unviersity

License

ICEAgent, including all git submodules are 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/>.