Installation

Windows

  1. Install Python 3.5.
  2. Download Plumeria (or via Git if you know how to use Git).
  3. Double click install.bat. If successful, it should say “SUCCESSFUL” at the very end. If not, please file an issue.

Try double clicking run_default.bat to run the bot. Since it hasn’t been configured yet, nothing will happen, but it should still start.

Debian/Ubuntu

Make sure that you have Python 3.5+ installed. Try running python3 in shell and see what version is printed.

  1. Install system packages:

    sudo apt-get install python3-pip
    
  2. Install:

    pip3 install virtualenv
    git clone https://github.com/sk89q/Plumeria.git plumeria
    cd plumeria
    python3 -m virtualenv .venv
    . .venv/bin/activate
    pip install -r requirements.txt
    cp config.ini.example config.ini
    

Try running the bot:

.venv/bin/python plumeria-bot.py

Since it hasn’t been configured yet, nothing will happen, but it should still start.

Mac OS X

  1. Install Python 3.5.

  2. If you haven’t installed Git yet, run git in Terminal and say yes to the prompt.

  3. Open Terminal in the directory where you want to download Plumeria and run these commands:

    pip3 install virtualenv
    git clone https://github.com/sk89q/Plumeria.git plumeria
    cd plumeria
    python3 -m virtualenv .venv
    . .venv/bin/activate
    pip install -r requirements.txt
    cp config.ini.example config.ini
    

Try running the bot:

.venv/bin/python plumeria-bot.py

Since it hasn’t been configured yet, nothing will happen, but it should still start.