banana/README.mdown

110 lines
3.1 KiB
Plaintext
Raw Normal View History

2021-12-05 19:29:43 +00:00
# Elder Scrolls Online Commadline Addon Manager
2021-12-14 22:21:42 +00:00
Elder Scrolls Online addon manager and a Tamriel Trade Centre price table updater.
2021-12-05 19:29:43 +00:00
2021-12-05 20:09:32 +00:00
[MIT License](LICENSE)
2021-12-14 22:21:42 +00:00
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\
```
2021-12-14 22:21:42 +00:00
Make a copy of the `live` folder and rename it to something meaningful like `old` or `backup`.
2021-12-05 20:09:32 +00:00
# Windows Installation
2021-12-05 19:29:43 +00:00
Install the latest Python 3 using the installer provided by [python.org](https://www.python.org/downloads/windows/).
Open [Windows Terminal](https://www.microsoft.com/en-US/p/windows-terminal/9n0dx20hk701) or any windows command prompt and navigate to this project.
Use the Python package manager PIP to install `eso-banana`.
```powershell
cd .\eso-banana\
pip install .
```
Once the project is installed to python's packages you may invoke the addon script with the following command:
```powershell
eso-banana-script.exe
```
2022-01-05 23:23:54 +00:00
# Windows Scheduled
To schedule a periodic background run of `eso-banana`, open Powershell as a user and enter the following commands.
```powershell
2022-01-05 23:20:32 +00:00
$Command = (Get-Command "eso-banana-script.exe").Source
$Action = New-ScheduledTaskAction -Execute $Command -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
```
2022-01-05 23:45:02 +00:00
# Windows Unschedule
Only run the following command if you wish to remove scheduled run of `eso-banana`.
To remove the schedule, use the `Unregister-ScheduledTask` command:
```
Unregister-ScheduledTask eso-banana
```
Press enter to confirm removal.
2021-12-05 20:09:32 +00:00
2022-01-05 23:23:54 +00:00
# Linux Installation
Install `python3` and `pip3`, the following instructions are for Debian.
```
sudo apt install python3-pip
2022-01-05 23:24:56 +00:00
cd ./eso-banana/
2022-01-05 23:23:54 +00:00
pip3 install .
```
Once the project is installed to python's packages you may invoke the addon script with the following command:
```
eso-banana-script
```
2022-01-05 23:45:46 +00:00
# Linux Scheduled
2022-01-05 23:23:54 +00:00
2022-01-05 23:36:05 +00:00
Linux command scheduling can be performed with the [crontab](https://help.ubuntu.com/community/CronHowto) command:
```bash
crontab -e
2022-01-05 23:45:02 +00:00
```
Add the following line to your `crontab`.
```
0 11 * * * eso-banana-script --verbose
```
# Linux Unschedule
Only run the following command if you wish to remove scheduled run of `eso-banana`.
To remove the schedule, delete the following line from your `crontab -e`.
```
2022-01-05 23:36:05 +00:00
0 11 * * * eso-banana-script --verbose
```