Skip to content

MythicKeys

Jump to bottom
AlonsoAliaga edited this page Aug 31, 2023 · 7 revisions

PENDING TO RELEASE

What are the requirements?

These are mandatory requirements, if one of them is missing, feature will NOT work.

Server requirements:

  • Version 1.17 or newer.
  • MythicKeys plugin installed.
  • BetterBackpacks Pro version 2.0-BETA-PRO or newer. (Pending)
    (Free version is not and will never be supported. This is a Pro exclusive feature.)

Clients/players requirements:

  • Fabric version 1.17 or newer.
  • MythicKeys mod installed.

What it is?

MythicKeys is a plugin and fabric mod that allows 1.17+ servers to detect when 1.17+ players press an specific key of the keyboard.
This allows developers create interesting systems by binding keys to actions in plugins, which makes interaction easier and giving a more inmersive sensation to players.

Is this safe?

It should be safe, this is how system works:

  1. Player installs the mod and joins a server.
  2. Both client and server communicate and inform the client which keys will be recognized.
    • This can be seen pressing ESCAPE, options and checking if letter M appears (that means server supports MythicKeys and is listening to certain keys)
  3. Once "connection" is done, client will send the data only if that specific key is pressed.

Why is this safe then?

  1. No data is sent when player has inventory opened or text area active:
    That means it doesnt send any data when you are typing messags or using inventories.
  2. You can change the key to be used for that specific action:
    If by default the registered key is KEY C, you can change that to be, for example, KEY X. This means you can change the key input, doesn't matter which it is, only "key identifier" will be sent. (No key data) In few words, if key identifier is "mycustomplugin:skill1", no matter what key you select for it, only "mycustomplugin:skill1" is sent.
  3. Only registered keys and default ones are sent:
    Registered keys are the keys registered in config.yml file of the plugin in the server, which is registered after joining the server and will always appear in ESCAPE -> Options menu (when clicking the blue M option is available). This means you'll always know which keys are being "tracked".
    What about "default" ones? Well, these are keys from base minecraft, E for "inventory", Q for "drop", W for "forward", tab for "playerlist" and so on. This is a default behavior and cannot be disabled (as far as i know), however, due to what was explained above, no key is tracked on inventory open or when writing messages in game.
  4. Only keys used with minecraft windows focused are registered:
    No need to worry about having the game opened while using web browsers, only in-game keys are registered.

Installation

Instalation is very simple and depends on your client version and server version.\

⚠️ ⚠️ ⚠️ Under construction! Waiting for developer's response. ⚠️ ⚠️ ⚠️

⚠️ You need latest version of BetterBackpacksPro. (1.3-BETA-PRO or newer)
Free version is not and will never be supported. This is a Pro exclusive feature.

Version 1.19.1: 🔔

Server 1.19.1:

  • Download latest MythicKeys plugin version from SpigotMC.

Client 1.19.1:

Version 1.18.2: 🔔

Server 1.18.2:

  • Download 1.4.1 MythicKeys plugin version from SpigotMC.

Client 1.18.2:

Version 1.17.1: 🔔

Server 1.17.1:

  • Download 1.4.1 MythicKeys plugin version from SpigotMC.

Client 1.17.1:

Setup

BetterBackpacksPro has a command to make the setup process easier for server owners.
After making sure you meet all requirements from #What are the requirements? section follow step below:

  1. Use in console the command /betterbackpacks setupmythickeys.
    This will add required data for MythicKeys plugin and remove default values which are not used.

Testing (As server owner)

To test this feature make sure you are using Fabric and the mod is installed.

  1. Disconnect from the server (if you are connected) and join your server again.
  2. To test the behavior of the features you must enable first the shortcut for your player. Run the command /betterbackpacks shortcut and select backpacks shortcuts. Then enable "Backpack Key R shortcut". Open shorcuts menu again and select crafting shortcuts. Then enable "Crafting table Key X shortcut".
  3. Craft a backpack or get one with the command /betterbackpacks give [your player] 6. Place the backpack in slot 9 in your inventory and close your inventory. Press Key R. Backpack will be opened!
  4. To test crafting table upgrade, purchase one "Crafting Table upgrade" from /betterbackpacks upgrades or get one using the command /betterbackpacks giveupgrade [your player] crafting-table. Drag and drop the upgrade in the backpack located in slot 9 and close the inventory Press Key X. A portable crafting table will be opened!

Usage (For your players)

Your players must join with the mod installed to the server and after enabling the shortcuts in the menu /betterbackpacks shortcuts or /bbp shortcuts they will be able to use Key R to open backpacks if a backpack is in slot 9 or Key X to open portable crafting table if backpack in slot 9 has crafting table upgrade.

⚠️ You can also test this feature in our test server! IP: plugins.alonsoaliaga.com

BetterBackpacks - Made by AlonsoAliaga

Getting started

Features

Plugin stats

Developer API

Clone this wiki locally