Keybind System

​

Overview

​

Keybind Architecture

​

Bind Class

• key: Integer key code (GLFW key code)
• isMouse: Boolean flag indicating if it’s a mouse button

public class Bind {
    int key;           // Default: -1 (unbound)
    boolean isMouse;   // Default: false
}

​

Module Integration

public class Module extends Feature implements IBindable {
    Bind bind;
    
    public Module(String name, Category category) {
        this.bind = new Bind();
        BindManager.INSTANCE.getBindables().add(this);
    }
    
    @Override
    public void onKey() {
        if (!bind.getIsMouse())
            this.toggle();
    }
}

​

Binding Keys in ClickGUI

​

Keyboard Keys

1. Open ClickGUI (default: Right Shift)
2. Navigate to the module you want to bind
3. Click on the bind button/field
4. Press the desired keyboard key
5. The keybind is immediately saved

​

Mouse Buttons

​

Unbinding Modules

1. Navigate to the module in ClickGUI
2. Right-click the bind button
3. The bind is cleared (set to -1)

​

Mouse Button Binds

​

Format

ModuleName:
  bind: MOUSE_<button_number>

​

Mouse Button Numbers

​

Example Configuration

AutoTrap:
  bind: MOUSE_4
  enabled: false
  # ... other settings

AutoFeetPlace:
  bind: MOUSE_3
  enabled: false
  # ... other settings

​

How to Set Mouse Binds

1. Close Minecraft
2. Open your config file in Minecraft/Sn0w/configs/
3. Find the module you want to bind
4. Change the bind value to MOUSE_X (replace X with button number)
5. Save the file
6. Launch Minecraft
7. Load the config with .config load <name>

You do it in your config.yml, i.e., MOUSE_4
See Module.java:226

​

Keybind Storage Format

​

In Memory

• Keyboard keys: Stored as integer GLFW key codes
• Mouse buttons: Stored as integers with isMouse = true

​

In Config Files

​

Keyboard Keys

ModuleName:
  bind: 78  # N key (GLFW code)

​

Mouse Buttons

ModuleName:
  bind: MOUSE_4  # Side button

​

Serialization Code

@Override
public Map<String, Object> save() {
    Map<String, Object> toSave = super.save();
    if (bind.getIsMouse()) {
        toSave.put("bind", "MOUSE_" + bind.getKey());
    } else {
        toSave.put("bind", bind.getKey());
    }
    return toSave;
}

@Override
public void load(Map<String, Object> objects) {
    super.load(objects);
    
    if (objects.get("bind").toString().contains("MOUSE_")) {
        bind.setIsMouse(true);
        String bindString = objects.get("bind").toString();
        bind.setKey(Integer.parseInt(bindString.replace("MOUSE_", "")));
    } else {
        bind.setKey((int) objects.get("bind"));
    }
}

​

Bind Manager

​

Keyboard Events

@SubscribeEvent
public void onKey(KeyboardEvent event) {
    if (mc.currentScreen == null)
        for (IBindable bindable : getBindables()) {
            if (bindable.getKey() == event.getKey() 
                && event.getAction() == GLFW.GLFW_PRESS) {
                bindable.onKey();
            }
        }
}

• Only triggers when no GUI is open
• Checks for GLFW_PRESS action (key down)
• Calls onKey() on matching module

​

Mouse Events

@SubscribeEvent
public void onKey(MouseEvent event) {
    if (!event.getType().equals(MouseEvent.Type.CLICK)) return;
    
    for (Feature feature : FeatureManager.INSTANCE.getFeatures()) {
        if (feature instanceof Module) {
            Module module = (Module) feature;
            if (module.getBind().getIsMouse()) {
                if (module.getBind().getKey() == event.getButton()) {
                    module.toggle();
                }
            }
        }
    }
}

• Only processes CLICK type events
• Iterates through all modules
• Toggles module if mouse button matches

​

Common Key Codes

​

Example Binds from Config

# From basicconfig.yml
AutoTrap:
  bind: 78  # N key
  
Scaffold:
  bind: 82  # R key
  
CatAura:
  bind: 88  # X key
  
AutoArmor:
  bind: 84  # T key
  
TickBase:
  bind: 69  # E key

​

Bind Priority

​

Keyboard Binds

• Only trigger when no GUI screen is open
• Checked every frame on key press
• Multiple modules can share the same bind (all will toggle)

​

Mouse Binds

• Always active (even with GUI open)
• Processed on mouse click events
• Can interfere with GUI interactions if using common buttons

​

Best Practices

​

Choosing Keybinds

1. Accessibility: Use keys near WASD for frequently used modules
2. Avoid conflicts: Don’t bind to keys used for movement or vanilla functions
3. Categorize: Group related modules on nearby keys
4. Mouse buttons: Reserve for toggle-intensive modules (AutoCrystal, etc.)

​

Recommended Binds

• AutoCrystal: X, C, or MOUSE_4
• KillAura: R or MOUSE_3
• AutoTrap: N or Y

• Scaffold: V or G
• Flight: F or H
• Speed: B

• FreeCam: F4
• HudEditor: F5

​

Troubleshooting

​

Bind Not Working

1. Verify the module is not disabled
2. Ensure no GUI is open (for keyboard binds)
3. Check if another program is intercepting the key
4. Verify the bind code is correct in config file

​

Mouse Bind Not Triggering

1. Verify MOUSE_ prefix is in the config file
2. Check the button number matches your mouse
3. Ensure the config was loaded after editing
4. Restart the client if hotloading fails

​

Multiple Modules Toggle Together

1. Check your config for duplicate binds
2. Unbind unwanted modules (right-click in GUI)
3. Assign unique keys to each module

​

Bind Resets After Restart

1. Save your config: .config save <name>
2. Ensure the client shuts down properly (don’t force close)
3. Check file permissions on the Sn0w folder

​

See Also

• Configuration Overview - Config system basics
• Config Files - File format details
• FAQ - Common questions about binds