banana/README.mdown

3.0 KiB

Elder Scrolls Online Commadline Addon Manager

Elder Scrolls Online addon manager and a Tamriel Trade Centre price table updater.

MIT License

It is recommended that you back up your ESO live profile before using banana in case you want to revert back.

On Windows, press Windows Key + e to open a file explorer and enter the following path in the address bar:

%HOME%\Documents\Elder Scrolls Online\

or on Windows 11

Documents\Elder Scrolls Online\

Make a copy of the live folder and rename it to something meaningful like old or backup.

Dependencies

python3-pip

Linux Installation

Install python3 and pip3, the following instructions are for Debian.

sudo apt install python3-pip
pip3 install .

Once the project is installed to python's packages you may invoke the addon script with the following command:

eso-banana-script

Linux Scheduled

TODO linux chron job instructions.

Windows Installation

Install the latest Python 3 using the installer provided by python.org.

Open Windows Terminal or any windows command prompt and navigate to this project. Use the Python package manager PIP to install eso-banana.

cd .\eso-banana\
pip install .

Once the project is installed to python's packages you may invoke the addon script with the following command:

eso-banana-script.exe

Windows Scheduled

To schedule a periodic background run of eso-banana, open Powershell as a user and enter the following commands.

$Action = New-ScheduledTaskAction -Execute "eso-banana-script.exe" -Argument "--verbose"
$Trigger = New-ScheduledTaskTrigger -Daily -At 11am
$Settings = New-ScheduledTaskSettingsSet -RunOnlyIfNetworkAvailable -StartWhenAvailable -RunOnlyIfIdle
Register-ScheduledTask -TaskName "eso-banana" -Action $Action -Trigger $Trigger -Settings $Settings -Description "Elder Scrolls Online addon manager and a Tamriel Trade Centre price table updater."

To check to make sure the task is registered correctly, enter Get-ScheduledTask and check that the first entry looks similar:

TaskPath                                TaskName                          State
--------                                --------                          -----
\                                       eso-banana                        Ready

Development

Use docker to test the python components. For docker installation run the following commands on Ubuntu 20.04:

sudo apt-get update && sudo apt-get install -y \
    docker-compose \
    docker.io \
    && apt-get clean

sudo usermod -aG docker $USER

Build and run the dev environment by entering the following commands:

cd ./banana/
docker-compose build
docker-compose run banana

Notes