Because typing is too much effort

Smart Completion

## 📖 About Client-side mod that provides better autocompletion suggestions for commands. Supports modded and custom commands from datapacks or server plugins, and it's not required on the server to work. ## 💡 Usage In order to type a command/argument **made up of several words**, type only **a few initials** of its words. For example, if you want to type `/gamerule doDaylightCycle true`, you could type `/gr dc t`.

Typing `/gr dc t` results in `/gamerule doDaylightCycle true`

## ⌨ Keyboard Shortcuts In addition of ``, you may also use `+` to accept suggestions, which automatically inserts a space so you can start typing the next argument. Additionally, if the current command is known to be incomplete (your text is in red), pressing `` will accept the selected suggestion, if any, rather than attempting to execute an invalid command. By default, accepting a suggestion with `+` or by using the middle button to click it will also erase the remaining text after the cursor, if you decide to edit an earlier argument at some point. This behavior can be configured per key/mouse button. ## 🔀 Disambiguating Suggestions To disambiguate between suggestions, you may need to type more than one letter per word. For example, to type `fireDamage` instead of `fallDamage`, which appears first when typing `fd`, you may type `fid`.

Disambiguate between `[f]all[D]amage` and `[f]ire[D]amage` by typing more letters

In general, it's way faster to type a few more letters to get the suggestion you want in front of the list rather than using the arrows/cycling with `` to select it, as typing can build muscle memory. Over time you will become used to the minimum number of letters you need to type the commands you frequently use, and typing them will feel like a breeze. ## 🔍 Browsing Suggestions Since the words you type don't need to be at the start of the name you're typing, you may discover way more useful suggestions compared to how Minecraft suggestions usually work. For example, if you type `/give @p wood`, you'll see suggestions for all items that **contain a word** that starts with `wood` (e.g., `oak_[wood]`), not just items whose name itself starts with `wood` (e.g., `[wood]en_axe`).

Suggestions offered when the player types `/give @p wood`

Additionally, if your query doesn't match any of the initials of a suggestion, it will also look anywhere within suggestions to provide fuzzy matches, which are listed after smart matches. This is helpful when you don't know exactly what you're looking for. ## 🎁 Extra Features This mod also inverts the order of suggestions by default, so the most relevant suggestion is the closest one to the input bar and where your eyes are already looking at. If you find this too confusing, you may disable it with the following command: ``` /smartcompletion invert_suggestion_order false ``` It also prevents the mouse from selecting suggestions as they appear under it, an old bug that makes typing commands in small windows harder than it needs to be. ## ✨ How does it work? For each command you type, we ask the server for suggestions **twice**. Once omitting whatever you've typed for your last argument (*blind query*), and another including everything *as a guarantee* (*informed query*). Most of the time, only one request is sent, since we also cache requests while you type to reduce latency and blinking of the suggestions list. Then, we work under the assumption that the server will reply with all possible suggestions to the blind query, and perform a **smart filtering and sorting** of the suggestions in the **client side**. If there are any unexpected suggestions in the informed list that **were not matched** by our filtering, they'll also be shown in a **different color**, so you **never fail to see any suggestion** from potential complex commands that provide their own smart suggestions. To filter suggestions, we use **two approaches**: - A smart match between segments of your query and the initials of parts of the suggestion (`gr` matches `[g]ame[r]ule`) (how completion works in any code editor) - A weak search for each part of your query within the suggestion (`lock on` matches `b(lock)Explosi(on)DropDecay`) (helpful when you don't know what you're looking for) ## ✂ How are words split? We split words at any non-alphabetic character, as well as at `camelCase` words. In addition, if a command cannot be split in this way, we will assume it's written in `flatcase`, like most Minecraft commands. Unfortunately, unless you have a dictionary, breaking down `flatcase` systematically is impossible. That's why use a small dictionary of words used by Minecraft, Fabric, [Neo]Forge and WorldEdit commands to attempt to break down commands into words. This dictionary can be overridden by resource packs (see [wiki](https://github.com/endorh/smart-completion/wiki/Flatcase-Splitting-Settings)), but feel free to report any issues with words not being split correctly. ## 📋 How are suggestions sorted? Suggestions are sorted according to the following criteria, whichever applies first: 1. Suggestions **closer to the cursor** are **shown first** (`/give @p chest` suggests `[` before `minecart_chest`) 2. Matches of **word initials** are shown before **fallback matches** (`[d]oWeather[C]ycle` > `sen[dC]ommandFeedback`) 3. **Significant matches** beyond *some thresholds* are shown first (`[app]le` > `[a]cacia_[p]ressure_[p]late`) 4. Matches with **more initial matches** are shown first (`[d]o[I]nsomnia` > `[di]sableRaids`) 5. Matches where **some initials** could've matched **more than one word** are shown first (`[d]o(D)aylight[C]ycle` > `[d]oWeather[C]ycle`) 6. Suggestions with **less words** are shown first (`[d]o[I]nsomnia` > `[d]o[I]mmediateRespawn`) 7. Matches **closer to the start** of the suggestion are shown first (`[g]ame[m]ode` > `default[g]ame[m]ode`) 8. **Shorter suggestions** are shown first (`[t]p` > `[t]ell`) 9. Otherwise, the suggestions are shown in the **original order** provided by the server **(usually alphabetic)** (`[f]all[D]amage` > `[f]ire[D]amage`). Currently, there's no way to customize this order. If you have any suggestions to improve it, **please let me hear them**. The reasoning behind these criteria is matching natural expectations, and enabling conflict disambiguation by typing more initials right away. ## 🎨 Customization Suggestions are highlighted according to the styles defined in the `style.json` file, which can be **overridden by resource packs** (see [wiki](https://github.com/endorh/smart-completion/wiki/Suggestion-Style-Settings)). By default, **matches** inside a suggestion (`[g]ame[r]ule`) are highlighted in *blue*. **Alternative matches** for a query part (`[d]o(D)aylight[C]ycle`), **fallback matches** (`sen[dC]ommandFeedback`) and **unexpected server suggestions** are all highlighted in *dark aqua*. In addition, if a suggestion starts with a **prefix** of words, **followed by a colon**, (i.e., a *resource location namespace*), it will be highlighted in *dark gray* unless matched (`{minecraft:}[g]olden_[ap]ple`). ## ❓ Help This mod has a [wiki](https://github.com/endorh/smart-completion/wiki), which you may check out. Also, if you're having any trouble, or maybe just want to say *hello*, feel free to drop by our [Discord Server](https://discord.gg/gqYVjBq65U). ## 🤝 Support this project If you want to support this project, **share it with your friends!**