Skip to content
Ashesh edited this page Feb 11, 2025 · 13 revisions

πŸ“„ Keys Configuration

This page explains the structure, purpose, and available options for the JSON configuration used in this project. Understanding these settings will help you customize the project effectively.


πŸ“¦ Example JSON Structure

{
  "type": "key",
  "key": "G",
  "price": 69420
}

Each property in this JSON serves a specific purpose, which is detailed below.


πŸ”‘ 1. type

  • Purpose: Defines the category or function of the configuration.
  • Data Type: string
  • Available Values:
    • key - Represents a keyboard key binding (e.g., G, W, Enter)
    • Mouse - Represents a mouse (left|right) click and scroll | IN PROGRESS
    • Typing - Typing a text using keyboard
    • action - Triggers a specific in-game action or event. | IN PROGRESS

Example:

"type": "Typing" 

This means the configuration is related to an keyboard key


⌨️ 2. key

  • Purpose: Specifies the actual key or identifier based on the type.
  • Data Type: string (for keys or IDs)
  • Usage Based on type:
    • If type is key: Represents a keyboard key (e.g., G, W, Enter).
    • If type is mouse: Represents a mouse (e.g., slide, click).
    • If type is action: Represents the action ID (e.g., jump, shoot).

Example:

{ 
    "type": "key", 
    "key": "G" 
}

This binds an action to the G key.


πŸ’° 3. price

  • Purpose: Indicates the cost associated with donation amount
  • Data Type: number (integer)

Example:

{ 
    "type": "key", 
    "key": "G", 
    "price": 69420
}

this means that the letter G on the keyboard will be clicked automatically when there is a donation of 69420


πŸ“Œ key list

key type
alphabet: eg (A, B, Z)
list special keys:

"enter", "space", "tab", "esc", "backspace", "delete", "shift", "ctrl", "alt", "cmd",
"caps_lock", "up", "down", "left", "right", "page_up", "page_down", "home", "end", "insert",
"f1", "f2", "f3", "f4", "f5", "f6", "f7", "f8", "f9", "f10", "f11", "f12"

typing: typing a text using keyboard

mouse type
slide: list available slide

- eg. "slide_up(100)" mean slide mouse up to 100 pixel
- slide_up(pixel)
- slide_down(pixel)
- slide_left(pixel)
- slide_right(pixel)

left_click: left click on mouse
middle_click: middle click on mouse
right_click: right click on mouse


πŸš€ Summary

The JSON structure provides flexibility in defining various configurations, such as key bindings, trigger prices, and in-game actions. Understanding the type, key, and price fields allows you to easily customize the project to fit your needs.


Need more information or examples? Feel free to suggest updates! ⚑

Made with ❀️ - Ashesh

Clone this wiki locally