banana/README.mdown

198 lines
6.3 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)
2022-01-11 18:34:34 +00:00
It is recommended that you back up your ESO live profile before using `eso-banana` in case you want to revert back.
2021-12-14 22:21:42 +00:00
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`.
2022-01-05 23:58:44 +00:00
# Usage
Follow the installation instructions for your `platform`:
- [Windows](#windows-installation)
- [Linux](#linux-installation)
On first run, the `addons.list` file will be created in your ESO live directory.
2022-01-05 23:58:44 +00:00
It will look similar to the following:
2022-06-19 20:02:26 +00:00
```
https://www.esoui.com/downloads/info7-LibAddonMenu.html
https://www.esoui.com/downloads/info1245-TamrielTradeCentre.html
https://www.esoui.com/downloads/info1146-LibCustomMenu.html
2022-01-05 23:58:44 +00:00
```
Add the ESOUI url for each additional addon you wish to keep updated.
2022-06-19 20:02:26 +00:00
Make sure to include the `www.` indicator that ESOUI requires for some stupid reason.
2022-01-05 23:58:44 +00:00
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/).
2022-01-06 00:13:51 +00:00
When the python installer asks, [add python to PATH](https://docs.python.org/3/using/windows.html#installation-steps).
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
2022-06-19 19:48:34 +00:00
cd .\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
```
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
2022-01-06 00:24:26 +00:00
$Action = New-ScheduledTaskAction -Execute $Command -Argument "--log"
$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-06-19 19:48:34 +00:00
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
# Steam Deck Installation
The following instructions are for arch linux system installed with the Steam Deck.
0. From the [Steam Deck instructions](https://help.steampowered.com/en/faqs/view/671A-4453-E8D2-323C):
> From the STEAM menu, select Power, then Switch to Desktop
1. Once you've become familiar with desktop mode, open a terminal and enter the following commands to install python.
```
sudo btrfs property set -ts / ro false
sudo pacman-key --init
sudo pacman-key --populate archlinux
sudo pacman -S python-pip
```
2. Run the following commands to download this project and install the scheduled service.
```
wget https://joyo.dev/eso/banana/archive/master.tar.gz -O banana.tgz
tar xvf banana.tgz
cd ./banana/
pip install .
cp banana.timer banana.service /etc/systemd/system/
sudo systemctl enable banana.timer
sudo systemctl enable banana.service
```
3. Now that `eso-banana-script` has been installed, run it once to create the `addons.list` file.
If the mentioned command is missing your may need to restart the TTY.
4. The created file can be edited with vim to include additional adddon URLs at the following path.
`vim "~/.steam/steam/steamapps/compatdata/306130/pfx/drive_c/users/steamuser/Documents/Elder Scrolls Online/live/addons.list"`
It will look similar to the following:
```
https://www.esoui.com/downloads/info7-LibAddonMenu.html
https://www.esoui.com/downloads/info1245-TamrielTradeCentre.html
https://www.esoui.com/downloads/info1146-LibCustomMenu.html
```
Add the ESOUI url for each additional addon you wish to keep updated.
Make sure to include the `www.` indicator that ESOUI requires for some stupid reason.
5. Run `eso-banana-script` once more to download and install the additional addons.
6. To return to [Gaming Mode](https://help.steampowered.com/en/faqs/view/671A-4453-E8D2-323C):
> ...there's a shortcut link to 'Return to Gaming Mode'.
> Select that to get back to standard Steam Deck UI.
> You can also go through the system menus to Log Off to get back.
# Steam Deck Unschedule
Only run the following command if you wish to remove scheduled run of `eso-banana`.
```
systemctl list-timers --all
sudo systemctl disable banana.timer
```
2022-01-05 23:23:54 +00:00
# Linux Installation
2022-06-09 00:56:10 +00:00
The following instructions are for any linux system using systemd.
2022-06-19 19:48:34 +00:00
Using your distros package management system, install python3-pip.
```
sudo apt install python3-pip
```
Because systemd is cancer you will need to edit the `banana.service` file to include your user's home path.
2022-06-19 20:05:38 +00:00
In the unlikely event that the script is not installed to `~/.local/bin/eso-banana-script`, open a new terminal and use the results from `which eso-banana-script`.
2022-06-19 19:48:34 +00:00
```
[Unit]
Description=Run banana daily and on boot.
Wants=banana.timer
[Service]
Type=oneshot
ExecStart=/home/user_name_here/.local/bin/eso-banana-script
User=deck
2022-01-05 23:23:54 +00:00
2022-06-19 19:48:34 +00:00
[Install]
WantedBy=multi-user.target
2022-01-05 23:23:54 +00:00
```
2022-06-19 19:48:34 +00:00
Finally, install `eso-banana` using pip and install the systemd timer and service to run `eso-banana` everyday.
```
cd ./banana/
pip install .
2022-06-09 01:22:38 +00:00
cp banana.timer banana.service /etc/systemd/system/
2022-06-09 00:56:10 +00:00
sudo systemctl enable banana.timer
2022-06-09 01:22:38 +00:00
sudo systemctl enable banana.service
2022-01-05 23:23:54 +00:00
```
2022-01-05 23:45:02 +00:00
# Linux Unschedule
Only run the following command if you wish to remove scheduled run of `eso-banana`.
```
2022-06-09 00:56:10 +00:00
systemctl list-timers --all
sudo systemctl disable banana.timer
```