banana/README.mdown

144 lines
4.8 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)
2024-06-07 22:31:48 +00:00
It is recommended that you back up your ESO live profile before using `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
2024-06-07 22:31:48 +00:00
0. Download the latest `banana.exe` release for [Windows](https://git.joyo.dev/eso/banana/releases/).
2024-06-07 22:31:48 +00:00
1. Add the executable to the [user's path](https://www.wikihow.com/Change-the-PATH-Environment-Variable-on-Windows) or replace "banana.exe" with the full path to where the executable is stored.
2024-06-07 22:31:48 +00:00
2. Run the executable from the commandline with `banana.exe -h` for usage.
2024-06-07 22:31:48 +00:00
# Windows Optional
2024-06-07 22:31:48 +00:00
To schedule a periodic background run of `banana`, open Powershell as a user and enter the following commands.
```powershell
2024-06-07 22:31:48 +00:00
$Command = (Get-Command "banana.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
2024-06-07 22:31:48 +00:00
## Windows Unschedule
2022-01-05 23:45:02 +00:00
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
2024-06-07 22:31:48 +00:00
# SteamOS 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
2024-06-07 22:31:48 +00:00
1. Download the latest `banana.elf` release for [SteamOS](https://git.joyo.dev/eso/banana/releases/).
2024-06-07 22:31:48 +00:00
2. Set executable with `chmod +x banana.elf` and add the executable to `~/.local/bin/` or any directory in the user's $PATH environment.
2024-06-07 22:31:48 +00:00
- optionally replace "banana.elf" with the full path to where the executable is stored.
2024-06-07 22:31:48 +00:00
3. Run the executable from the commandline with `banana.elf -h` for usage.
2024-06-07 22:31:48 +00:00
Note: banana will create and `addons.list` file which can be edited to include additional adddon URLs at the following path:
2024-06-07 22:31:48 +00:00
`$EDITOR "~/.steam/steam/steamapps/compatdata/306130/pfx/drive_c/users/steamuser/Documents/Elder Scrolls Online/live/addons.list"`
2024-06-07 22:31:48 +00:00
5. 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.
2024-06-07 22:31:48 +00:00
# SteamOS Optional
2022-06-19 19:48:34 +00:00
Because systemd is cancer you will need to edit the `banana.service` file to include your user's home path.
2024-06-07 22:31:48 +00:00
In the unlikely event that the script is not installed to `~/.local/bin/banana.elf`, open a new terminal and use the results from `which banana.elf`.
2022-06-19 19:48:34 +00:00
```
[Unit]
2024-06-07 22:31:48 +00:00
Description=Run ESO banana daily and on boot.
2022-06-19 19:48:34 +00:00
Wants=banana.timer
[Service]
Type=oneshot
2024-06-07 22:31:48 +00:00
ExecStart=/home/user_name_here/.local/bin/banana.elf
2022-06-19 19:48:34 +00:00
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
2024-06-07 22:31:48 +00:00
Finally, install the systemd timer and service to run `banana` everyday.
2022-06-19 19:48:34 +00:00
```
cd ./banana/
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
```
2024-06-07 22:31:48 +00:00
## SteamOS Unschedule
2022-01-05 23:45:02 +00:00
2024-06-07 22:31:48 +00:00
Only run the following command if you wish to remove scheduled run of `banana`.
2022-01-05 23:45:02 +00:00
```
2022-06-09 00:56:10 +00:00
systemctl list-timers --all
sudo systemctl disable banana.timer
2024-06-07 22:31:48 +00:00
```