Ugoku-v2

Bot Setup Tutorial

Follow these steps to get started with Ugoku !

Want to see a preview of Ugoku ?

Click on the button below to invite a sample of the bot. Note that Chatbot features are not enabled on servers, but you can still talk in DM. Moreover, the sample bot can restart at any time without prior notice.

Invite Ugoku-v2 Playground
Quick Setup Guide
  1. Install FFmpeg. You can follow this guide if you are on a Windows machine.
  2. Copy the repo.
  3. Create a virtual environment.
    python -m venv venv
    OR
    python3 -m venv venv
  4. Enable the venv.
    Windows:
    ./venv/Scripts/activate.bat
    Linux:
    source venv/bin/activate
  5. Install the dependencies.
    pip install -r requirements.txt
  6. Create a bot and add it to a Discord server, or add it to your apps. You can follow the first 3 sections of the guide.
  7. Create an .env file in the root directory.
  8. Set the environment variables for the services you want to use, based on the template.
  9. Restart the IDE (to update the env variables).
  10. On linux machines, you may want to switch the protobuf implementation to Python if the .env variable has been ignored by doing so:
    echo 'export PROTOCOL_BUFFERS_PYTHON_IMPLEMENTATION=python' >> ~/.bashrc
    source ~/.bashrc
    You can now restart your instance.
  11. Configure and activate the features in the config.py file.
  12. Run main.py.
  13. If Spotify is enabled, log in to Librespot from your Spotify client (it should appear in the device list)*.
  14. Done !

TIP

*This action will create a credentials.json file in the root folder. If you are having trouble creating it on a remote machine, try creating it on your local machine and exporting it.