Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
NotRyken committed Aug 24, 2024
1 parent 53752d6 commit bd49582
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 40 deletions.
79 changes: 39 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## CommandKeys

Send pre-written chat messages and commands using hotkeys.
A powerful command macro mod.

[![Environment](https://img.shields.io/badge/Environment-Client-blue?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAABhWlDQ1BJQ0MgcHJvZmlsZQAAKJF9kT1Iw0AYht+malUqDnYQEclQneyiIo6likWwUNoKrTqYXPoHTRqSFBdHwbXg4M9i1cHFWVcHV0EQ/AFxdnBSdJESv0sKLWI8uLuH97735e47QGhUmGp2RQFVs4xUPCZmc6ti4BU9CKCP1jGJmXoivZiB5/i6h4/vdxGe5V335xhQ8iYDfCJxlOmGRbxBPLtp6Zz3iUOsJCnE58STBl2Q+JHrsstvnIsOCzwzZGRS88QhYrHYwXIHs5KhEs8QhxVVo3wh67LCeYuzWqmx1j35C4N5bSXNdZqjiGMJCSQhQkYNZVRgIUK7RoqJFJ3HPPwjjj9JLplcZTByLKAKFZLjB/+D3701C9NTblIwBnS/2PbHOBDYBZp12/4+tu3mCeB/Bq60tr/aAOY+Sa+3tfARMLgNXFy3NXkPuNwBhp90yZAcyU9TKBSA9zP6phwwdAv0r7l9a53j9AHIUK+Wb4CDQ2CiSNnrHu/u7ezbvzWt/v0ATphymIBZ6aQAAAAGYktHRAAKAAwAGd6C8noAAAAJcEhZcwAADdcAAA3XAUIom3gAAAAHdElNRQfoBgcOHRYlcgoRAAABRklEQVR42u2YMUoDQRRAX0axUzCteIZ4hKn0FDmFhalSWKkgnkHt9AQWwhzBNr2tBGNno82ACwm6EZvxvwdTzP8s7P8zu8w8EJHIDABKKfvAFXAIbP/zmt+AR2CSc54NavFPwDDY4s+BUaorPwy4+3eBy1S3fVSOUoBv/jt2UmMv/A6cAHt1TGqsb36JzcYaMM05X3Tm56UUgLOe+SVa2wE3K2LXa+Sbb8BgRWxjjXzzDRj/EBv3fOarY6WUj8Z+glPgtlPcKbDVM998A/6cVM/GUXlN9WIQlYdUDwvzgMW/AMcp5zwDRsA9sAhQ+AK4Aw5yzs8aEZHY6AR1gjpBnaBOsLHrsE6wM9cJohPUCeoE0Qn+Hp0gOkGdoE5QRMKiE9QJ6gR1gjrBxq7DOsHOXCeITlAnqBNEJ/h7dILoBHWCOkERCcsncuextWq5TzoAAAAASUVORK5CYII=)]()
[![Latest Minecraft](https://img.shields.io/modrinth/game-versions/65UyswbY?label=Latest%20Minecraft&color=%2300AF5C&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAEAAAABACAYAAACqaXHeAAABhWlDQ1BJQ0MgcHJvZmlsZQAAKJF9kT1Iw0AYht+malUqDnYQEclQneyiIo6likWwUNoKrTqYXPoHTRqSFBdHwbXg4M9i1cHFWVcHV0EQ/AFxdnBSdJESv0sKLWI8uLuH97735e47QGhUmGp2RQFVs4xUPCZmc6ti4BU9CKCP1jGJmXoivZiB5/i6h4/vdxGe5V335xhQ8iYDfCJxlOmGRbxBPLtp6Zz3iUOsJCnE58STBl2Q+JHrsstvnIsOCzwzZGRS88QhYrHYwXIHs5KhEs8QhxVVo3wh67LCeYuzWqmx1j35C4N5bSXNdZqjiGMJCSQhQkYNZVRgIUK7RoqJFJ3HPPwjjj9JLplcZTByLKAKFZLjB/+D3701C9NTblIwBnS/2PbHOBDYBZp12/4+tu3mCeB/Bq60tr/aAOY+Sa+3tfARMLgNXFy3NXkPuNwBhp90yZAcyU9TKBSA9zP6phwwdAv0r7l9a53j9AHIUK+Wb4CDQ2CiSNnrHu/u7ezbvzWt/v0ATphymIBZ6aQAAAAGYktHRAAKAAwAGd6C8noAAAAJcEhZcwAADdcAAA3XAUIom3gAAAAHdElNRQfoBgcOGBJfaDpNAAAE40lEQVR42u2bbYhUVRjHf/tiaRFkWVEaZJG2YNq2mYRFf0o/RPatDYk0ssAIKi0zbfMtXKxILRJqowy3FyqjD2ZvlPEQFlLh1qpIRVLWEq7p+rK11tpuH+ZZmqZ7Z3Zm79x5aZ5vc8+9557/f87//5zznBmoxP87qgr1YjMbBpzpHzsl9ZY9AQ56JjAbmAqM8KYeYCvQCrweJxlVMQGvAhqBVcD5GW7fAywGNkrqL3kCzKwBWAtcleWjnwPzJX1WkgSY2TnAMuB2oCbHbvqBN4EHJP1YEgSY2QjgHqAJOCWibn8HngZWSuouWgLM7AbgKWBsniZWB/AQ8FJU/lAVEfDLXOdXxmTeX7g/fFpQApJ0fgdQHXMKj8QfqnIEfhJwd8Q6H6o/NEs6mlcCPJ/fCDwOnFdkq9oO4BHgeUl9kRNgZpNd51OLfHn/pfvD1kgIMLPRwNIC6Xyo/rBQ0g85E2Bmc4HVwMklutn7DbhfUkvYDdVpwA/3fF5D6UYNMNax5CyBc4Fm4JZCbp9ziM3AvZL2RGWCU9wEryhy4NvdBD/JyQTNrAa4E2iRdDylrRqY5TNidBGmwSZfJveljLsWmAs8K+mvTB5wFrAO2GVmM5IbJPVJ2gCMAxYB3UUAvAd4DKiTtCEA/DSfFev4pwKVdgZMBL5OuvSeO+nuEH9YBdxcAH/oB14FFkv6KWBsdZ7Brku6PElSeyYCLgHaUi4fB9YDD0vaX8ybITMbCTwIzAdOSGmul/RVLgQMRJdPt7WS/izAdvjnJJ33B+h8DrASOCPk+f8QkO3KbiTwKLDDzBpTGyW9DVwEzAOORLygWQGMk9QaAH6af2ktacAPOgukmwGpscWn4o6Afs4GlhNNSWyBpL0B7xgPPAHMGGR/Q5ZAUAz4wxJJnQH91bs/XJ0l+G1O7raAPk8DFoboPHYCUv3hSUl/hPjDWuCCDP3sBZaE6HwYcFsGnWdFQJS7uwF/aE/jD3XuD4cDnu92nY9Po/Ptueg8nx6QyR/uS827/o7TfYt9l38Jr3hpa1+IzlcD10cwprxKIMwfWoBlkg4EvGuCz46dISSt8CVsbUTjiZ2AgTjk8gj0hxCdNwOjIh5HXj0gXZyabv0Qks9HxTGwWuKNC4E3zOxDYKakg0lp7TVgetw7qULV+KYDY5I+jykE+EISUDRRIaBCQIWACgEVAioE/DuOlTHeY4Mh4JcyJqAjIwGSDgNHyxD8kaAfUIR5wAdlSMD72ZhgM9BbRuB7HNPgCPA985wyIaHXd57tWaVBSS8DU4D2EgbfDlwuaVNO6wBJbUADibLU/hIC3kXi8HZyagUoNTIWRPyI/Dkz20j4mVuxRNozzJwISCKiC1hkZutJ1OUbiwz8RyQOUnZm81DWJTFJ3wI3mdm1wBpgYoGBf0Pi+P6dWPcCkrYA9cCtQGcBgB8kccgyIVfwOc2AFBL6gFYz2+SmMw84MYa09iLQJOnXoXYWSVVY0iH3hxd8wdGYR53Pk7Qrqg4jLYtL+s794Rr3h0kRdb2bxBH5uyVRD5D0MXCp+8O+IXR1wGV1cT7ARz4DQvzhLWCBryGGZ6HzZ4ClvjvNW+T9ZMj/47M8af0wK8Mjm13n38eRSmI7GvOfuMx2ItYE3NJG4jjd4sylsdcEHWCDG1uyyTXEDb4SlYC/AW0t3IQpiA17AAAAAElFTkSuQmCC)](https://modrinth.com/mod/65UyswbY/versions)
Expand All @@ -20,17 +20,23 @@ Send pre-written chat messages and commands using hotkeys.

### Features

- 1:n key:command binding
- Cycling mode
- Type assist mode
- Configurable conflict handling
- Modifier key binding
- Automatic profile switching
- Multiple commands per macro
- Multiple macros per keybind
- Optional delay timing between commands
- Efficient keybind conflict management with modifier key support
- Four modes:
1. Send all commands when the key is pressed
2. Cycle through commands, one per keypress
3. Repeat on a configurable interval
4. Type the command in chat, but don't send it
- Profiles with automatic switching based on server address or world name
- Fully custom GUI for easy configuration

<table style="width:100%;">
<tr>
<td style="width:50%;"><img src="https://raw.githubusercontent.com/TerminalMC/CommandKeys/HEAD/assets/images/showcase/config_01.png" style="width:100%;"></td>
<td style="width:50%;"><img src="https://raw.githubusercontent.com/TerminalMC/CommandKeys/HEAD/assets/images/showcase/config_02.png" style="width:100%;"></td>
<td style="width:33%;"><img src="https://raw.githubusercontent.com/TerminalMC/CommandKeys/HEAD/assets/images/showcase/config_01.png" style="width:100%;"></td>
<td style="width:33%;"><img src="https://raw.githubusercontent.com/TerminalMC/CommandKeys/HEAD/assets/images/showcase/config_02.png" style="width:100%;"></td>
<td style="width:33%;"><img src="https://raw.githubusercontent.com/TerminalMC/CommandKeys/HEAD/assets/images/showcase/config_03.png" style="width:100%;"></td>
</tr>
</table>

Expand All @@ -39,51 +45,44 @@ Send pre-written chat messages and commands using hotkeys.
#### Profiles

- **Access**
- View the profile menu by selecting CommandKeys from your mod list ([ModMenu](https://modrinth.com/mod/modmenu/)
list on Fabric/Quilt), or by pressing the edit key (default:K) in-game and clicking the "Change Profile" button.

- View the profile menu by selecting CommandKeys from your mod list ([ModMenu](https://modrinth.com/mod/mOgUt4GM)
list on Fabric), or by pressing the edit key (default: `K`) in-game and clicking the `Switch Profile` button.

- **Automatic Switching**
- When you join a world/server, the name/address will be checked against the list of profiles. If there is a profile
linked to that world/server, it will be activated. Otherwise, the corresponding default profile will be used.
- You can change the default profiles using the `S` and `M` buttons.

linked to that world/server, it will be activated. Otherwise, the default profile will be used.
- Use the `S` and `M` buttons to make a profile the default for singleplayer or multiplayer.

- **Manual Switching**
- In-game, you can activate any profile using the arrow on the left. When you do, the world name or server address
will be automatically saved to the profile.
- You can change the name of a profile and remove links to worlds/servers using the edit button.

- To activate a profile manually, click the up-arrow button on the left.
- Click the link button to link the profile to the world/server for future automatic activation.
- Click the settings button to rename the profile or remove links.

#### Command Keys
#### Macros

- **Access**
- You can edit a profile by clicking the main button from the profile selection screen, or by pressing the edit key
(default: K) in-game.

- Edit a profile by clicking the large button on the profile selection screen, or by pressing the edit key
(default: `K`) in-game.

- **Binding Keys**
- You can bind almost any keyboard key or mouse button to a Command Key, similar to Minecraft's own Controls screen.
- You can bind almost any keyboard key or mouse button to a macro, similar to Minecraft's own Controls.
However, you can also bind any *pair* of keys; just press one while holding the other (e.g. press 'T' while holding
'Shift').


- **Conflict Strategy**
- If a key is already used by Minecraft, you can choose a conflict strategy;
- Submit: The Command Key will be ignored, the Minecraft keybind will function normally.
- Assert: The Command Key and the Minecraft keybind will both function.
- Veto: The Command Key will function, the Minecraft keybind will be cancelled (if possible).
- Avoid: The Command Key will only function if its key is pressed while on the profile edit screen.


- **Mode**
- This allows you to choose what happens when the Command Key is activated;
- Send: All messages for the Command Key will be sent. You can optionally configure the delay between consecutive
messages.
- Type: The first message will be typed into the chat box, but not sent.
- Cycle: The messages will be cycled through as you repeatedly press the key, one message per key-press.
- If you need to send multiple messages in a single cycling key-press, enter them into a single box, separated by
pairs of commas (e.g. /say hi,,/say hello,,/say bye) (doesn't work for any other mode).
- If a key is already in use by Minecraft, you can choose a conflict strategy;
- `Submit`: The macro will be ignored, the Minecraft keybind will function normally.
- `Assert`: The macro and the Minecraft keybind will both function.
- `Veto`: The macro will function, the Minecraft keybind will be cancelled (if possible).
- `Avoid`: The macro will not work in-game, but you can still activate it by pressing the key while on the edit
screen (with nothing selected). For example, if you have a macro bound to `W`, press `K` then `W` to activate it.

- **Send Mode**
- `Send`: All commands for the macro will be sent. You can configure delays between commands.
- `Type`: The first command will be typed into the chat box, but not sent.
- `Cycle`: The commands will be cycled through, with one command sent each time you press the key.
- Note: In `Cycle` mode, if you need more than one command to be sent for a single key-press, enter those commands
into a single box, separated by pairs of commas (e.g. `/tick freeze,,/say Stopped`).


### Dependencies
Expand Down
Binary file removed assets/images/banner.png
Binary file not shown.
Binary file modified assets/images/showcase/config_01.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified assets/images/showcase/config_02.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/showcase/config_03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bd49582

Please sign in to comment.