https://github.com/mr2011/wowaddonmanager
TUI for managing World of Warcraft addons.
https://github.com/mr2011/wowaddonmanager
command-line-tool linux rust tui world-of-warcraft world-of-warcraft-addon
Last synced: 3 months ago
JSON representation
TUI for managing World of Warcraft addons.
- Host: GitHub
- URL: https://github.com/mr2011/wowaddonmanager
- Owner: MR2011
- License: mit
- Created: 2020-06-27T10:15:04.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2021-05-13T11:25:55.000Z (about 5 years ago)
- Last Synced: 2024-10-12T08:23:06.431Z (over 1 year ago)
- Topics: command-line-tool, linux, rust, tui, world-of-warcraft, world-of-warcraft-addon
- Language: Rust
- Homepage:
- Size: 715 KB
- Stars: 6
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wowAddonManager
This is an open source World of Warcraft addon managager for Linux. It supports the following addon repositories:
- [Curseforge](https://www.curseforge.com/)
## Screenshots
## Requirements
- Rust 1.43.0
This project uses [Termion](https://gitlab.redox-os.org/redox-os/termion) for communicating with the TTY. Therefore, it only runs on Linux. In order to support Windows and macos, [Crossterm](https://github.com/crossterm-rs/crossterm) might be a better solution. If there is enough demand, I might consider switching to Crossterm.
## Installation
### Binary
1. Download the latest [release](https://github.com/MR2011/wowAddonManager/releases)
2. Run `./wowAddonManager`
### Source
1. Make sure you have [Rust](https://rustup.rs/) installed
2. Clone the repository: `git clone https://github.com/MR2011/wowAddonManager.git`
3. Run with `cargo run`
### Cargo
`cargo install wowAddonManager`
## Configuration
The `Config.toml` configuration file is stored in `$HOME/.config/wowAddonManager` (or if set `$XDG_CONFIG_HOME/wowAddonManager`).
### Important
Before you run the program for the first time, you have to define the path to your World of Warcraft addon folders in the configuration file:
```
[paths]
classic = "/path/to/wow/classic/interface/addons"
retail = "/path/to/wow/retail/interface/addons"
tbc = "/path/to/wow/retail/interface/addons"
```
### TBC Update
Make sure you have:
- set your Tbc path in your `Config.toml`
- created an `.addons.json` file with the content `{"addons":[]}` in your Tbc addon folder
- added a keybinding for the Tbc tab in your `Config.toml`
## Default keybindings:
```
[keybindings]
update_addon = "u"
update_all_addons = "U"
remove_addon = "r"
download_addon = "d"
install_addon = "i"
select_retail_version = "R"
select_classic_version = "C"
select_tbc_version = "T"
search_addon = "/"
next_tab = "l"
prev_tab = "h"
next_table_item = "j"
prev_table_item = "k"
quit = "q"
scroll_down_log = "J"
scroll_up_log = "K"
```
## Notes
- This program creates a file called `.addons.json` in your addon folders to manage your addons. There is no addon detection for already installed addons for now, so you have to install your addons again with the wow addon manager.