|
1 | | -# tui |
| 1 | +# Modder TUI |
2 | 2 |
|
3 | | -[](https://github.com//tui/actions) |
| 3 | +A Terminal User Interface for Modder-rs, a command-line Minecraft mod manager. |
4 | 4 |
|
5 | | -TUI Wrapper for Modder-rs |
| 5 | +## Features |
| 6 | + |
| 7 | +* List installed mods |
| 8 | +* Enable and disable mods |
| 9 | +* Add new mods from Modrinth or GitHub |
| 10 | +* Search for mods |
| 11 | +* View mod details |
| 12 | + |
| 13 | +## Installation |
| 14 | + |
| 15 | +1. Clone the repository: |
| 16 | + ```bash |
| 17 | + git clone https://github.com/JayanAXHF/modder-rs.git |
| 18 | + ``` |
| 19 | +2. Navigate to the `tui` directory: |
| 20 | + ```bash |
| 21 | + cd modder-rs/tui |
| 22 | + ``` |
| 23 | +3. Build the project: |
| 24 | + ```bash |
| 25 | + cargo build --release |
| 26 | + ``` |
| 27 | +4. Run the application: |
| 28 | + ```bash |
| 29 | + ./target/release/tui --dir /path/to/your/mods |
| 30 | + ``` |
| 31 | + |
| 32 | +## Usage |
| 33 | + |
| 34 | +The application is divided into several modes, each with its own set of keybindings and functionality. |
| 35 | + |
| 36 | +### Home |
| 37 | + |
| 38 | +The default mode, which displays a menu of available actions. |
| 39 | + |
| 40 | +### List |
| 41 | + |
| 42 | +Displays a list of all installed mods in the specified directory. You can view details for each mod. |
| 43 | + |
| 44 | +### Toggle |
| 45 | + |
| 46 | +Allows you to enable or disable mods by renaming the mod files (e.g., `mod.jar` to `mod.jar.disabled`). |
| 47 | + |
| 48 | +### Add |
| 49 | + |
| 50 | +Search for and download new mods from Modrinth or GitHub. |
| 51 | + |
| 52 | +## Keybindings |
| 53 | + |
| 54 | +### Global |
| 55 | + |
| 56 | +* `Ctrl-c`, `Ctrl-d`, `q`: Quit the application |
| 57 | +* `Ctrl-z`: Suspend the application |
| 58 | + |
| 59 | +### Home |
| 60 | + |
| 61 | +* `j` or `Down Arrow`: Select next item |
| 62 | +* `k` or `Up Arrow`: Select previous item |
| 63 | +* `g` or `Home`: Select first item |
| 64 | +* `G` or `End`: Select last item |
| 65 | +* `Enter`: Select the highlighted mode and switch to it |
| 66 | + |
| 67 | +### List |
| 68 | + |
| 69 | +* `h` or `Left Arrow`: Deselect item |
| 70 | +* `j` or `Down Arrow`: Select next item |
| 71 | +* `k` or `Up Arrow`: Select previous item |
| 72 | +* `g` or `Home`: Select first item |
| 73 | +* `G` or `End`: Select last item |
| 74 | +* `/`: Enter Search mode |
| 75 | +* `Esc`: Go back to Home |
| 76 | + |
| 77 | +#### Search Mode |
| 78 | + |
| 79 | +* `Tab` or `Esc`: Exit Search mode |
| 80 | +* Any other key: Updates the search query |
| 81 | + |
| 82 | +### Toggle |
| 83 | + |
| 84 | +* `h` or `Left Arrow`: Deselect item |
| 85 | +* `j` or `Down Arrow`: Select next item |
| 86 | +* `k` or `Up Arrow`: Select previous item |
| 87 | +* `g` or `Home`: Select first item |
| 88 | +* `G` or `End`: Select last item |
| 89 | +* `Space`: Toggle whether a mod is enabled or disabled |
| 90 | +* `Enter`: Apply the changes (rename files) |
| 91 | +* `/`: Enter Search mode |
| 92 | +* `Esc`: Go back to Home |
| 93 | + |
| 94 | +#### Search Mode |
| 95 | + |
| 96 | +* `Tab` or `Esc`: Exit Search mode |
| 97 | +* Any other key: Updates the search query |
| 98 | + |
| 99 | +### Add |
| 100 | + |
| 101 | +* `h` or `Left Arrow`: Deselect item in the current mods list |
| 102 | +* `j` or `Down Arrow`: Select next item in the current mods list |
| 103 | +* `k` or `Up Arrow`: Select previous item in the current mods list |
| 104 | +* `g` or `Home`: Select first item in the current mods list |
| 105 | +* `G` or `End`: Select last item in the current mods list |
| 106 | +* `S`: Change source (Modrinth/Github) |
| 107 | +* `R`: View search results |
| 108 | +* `V`: Enter version |
| 109 | +* `/`: Enter search mode |
| 110 | +* `l`: View search results |
| 111 | +* `J` or `s`: View selected mods |
| 112 | +* `L`: Change loader |
| 113 | +* `Esc`: Go back to Home |
| 114 | + |
| 115 | +#### Search Mode |
| 116 | + |
| 117 | +* `Tab` or `Esc`: Exit search mode |
| 118 | +* `Enter`: Perform search |
| 119 | +* Any other key: Updates the search query |
| 120 | + |
| 121 | +#### Toggle Source Mode |
| 122 | + |
| 123 | +* `h` or `Left Arrow`: Deselect source |
| 124 | +* `j` or `Down Arrow`: Select next source |
| 125 | +* `k` or `Up Arrow`: Select previous source |
| 126 | +* `g` or `Home`: Select first source |
| 127 | +* `G` or `End`: Select last source |
| 128 | +* `Enter`: Perform search if version, search query and loader are set |
| 129 | +* `Esc`: Go back to Normal mode |
| 130 | + |
| 131 | +#### Change Loader Mode |
| 132 | + |
| 133 | +* `Tab` or `Esc`: Go back to Normal mode |
| 134 | +* `Enter`: Perform search if version and search query are set, otherwise go to search mode |
| 135 | +* `h` or `Left Arrow`: Deselect loader |
| 136 | +* `j` or `Down Arrow`: Select next loader |
| 137 | +* `k` or `Up Arrow`: Select previous loader |
| 138 | +* `g` or `Home`: Select first loader |
| 139 | +* `G` or `End`: Select last loader |
| 140 | + |
| 141 | +#### Version Input Mode |
| 142 | + |
| 143 | +* `Tab` or `Esc`: Go back to Normal mode |
| 144 | +* `Enter`: Perform search if version, search query and loader are set, otherwise go to search mode |
| 145 | +* Any other key: Updates the version input |
| 146 | + |
| 147 | +#### Search Result List Mode |
| 148 | + |
| 149 | +* `h` or `Left Arrow`: Deselect item |
| 150 | +* `j` or `Down Arrow`: Select next item |
| 151 | +* `k` or `Up Arrow`: Select previous item |
| 152 | +* `g` or `Home`: Select first item |
| 153 | +* `G` or `End`: Select last item |
| 154 | +* `Space`: Toggle selection of a mod |
| 155 | +* `Enter`: Download selected mods |
| 156 | +* `Esc`: Go back to Normal mode |
| 157 | + |
| 158 | +#### Selected List Mode |
| 159 | + |
| 160 | +* `j` or `Down Arrow`: Select next item |
| 161 | +* `k` or `Up Arrow`: Select previous item |
| 162 | +* `g` or `Home`: Select first item |
| 163 | +* `G` or `End`: Select last item |
| 164 | +* `J`: Go to Version Input mode |
| 165 | +* `Esc`: Go back to Normal mode |
0 commit comments