Skip to content

Latest commit

ย 

History

History
106 lines (102 loc) ยท 5.12 KB

File metadata and controls

106 lines (102 loc) ยท 5.12 KB

VitaLite SDK Documentation

Overview

Key Classes

๐Ÿ“ฆ VitaLite SDK
โ”œโ”€โ”€Static       # Static access to client object, and others. Also Static access
โ”‚               # to helper methods such as inboking on/getting returns from client 
โ”‚               # thread.
โ”‚
โ”œโ”€โ”€Logger       # Static logger for logging to the embedded console window.

API

Everything in the built-in API is designed with thread safety in mind

๐Ÿ“ฆ VitaLite SDK
โ”œโ”€โ”€ ๐ŸŽฎ Game APIs
โ”‚   โ”œโ”€โ”€ ๐Ÿƒโ€โ™‚๏ธ entities/
โ”‚   โ”‚   โ”œโ”€โ”€ ActorAPI          # Actor api
โ”‚   โ”‚   โ”œโ”€โ”€ NpcAPI            # NPC api
โ”‚   โ”‚   โ”œโ”€โ”€ PlayerAPI         # Player api
โ”‚   โ”‚   โ”œโ”€โ”€ TileItemAPI       # Tile item api
โ”‚   โ”‚   โ””โ”€โ”€ TileObjectAPI     # Tile object api
โ”‚   โ”‚
โ”‚   โ”œโ”€โ”€ ๐ŸŽฏ game/
โ”‚   โ”‚   โ”œโ”€โ”€ ClientScriptAPI   # CS2 script execution
โ”‚   โ”‚   โ”œโ”€โ”€ CombatAPI         # Combat calculations & state
โ”‚   โ”‚   โ”œโ”€โ”€ GameAPI           # Core game utilities
โ”‚   โ”‚   โ”œโ”€โ”€ HouseAPI          # Player-owned house api
โ”‚   โ”‚   โ”œโ”€โ”€ MovementAPI       # Walking api
โ”‚   โ”‚   โ”œโ”€โ”€ QuestAPI          # Quest progress & completion
โ”‚   โ”‚   โ”œโ”€โ”€ SceneAPI          # Scene/region management
โ”‚   โ”‚   โ”œโ”€โ”€ SkillAPI          # Skill levels & experience
โ”‚   โ”‚   โ””โ”€โ”€ VarAPI            # Game variable access
โ”‚   โ”‚
โ”‚   โ””โ”€โ”€ ๐Ÿ”„ threaded/
โ”‚       โ”œโ”€โ”€ Cannon            # Dwarf cannon automation
โ”‚       โ”œโ”€โ”€ Delays            # Smart timing utilities
โ”‚       โ”œโ”€โ”€ Dialogues         # Dialogue interaction system
โ”‚       โ”œโ”€โ”€ GrandExchange     # GE trading automation
โ”‚       โ”œโ”€โ”€ Minigames         # Minigame-teleport API
โ”‚       โ””โ”€โ”€ WorldsAPI         # World hopping & selection
โ”‚
โ”œโ”€โ”€ ๐ŸŽจ Widget APIs
โ”‚   โ”œโ”€โ”€ BankAPI               # Banking operations
โ”‚   โ”œโ”€โ”€ DialogueAPI           # Chat & dialogue handling
โ”‚   โ”œโ”€โ”€ EmoteAPI              # Emote api
โ”‚   โ”œโ”€โ”€ EquipmentAPI          # Equipment api
โ”‚   โ”œโ”€โ”€ GrandExchangeAPI      # Grand Exchange automation
โ”‚   โ”œโ”€โ”€ InventoryAPI          # Inventory api
โ”‚   โ”œโ”€โ”€ MagicAPI              # Spellcasting & magic
โ”‚   โ”œโ”€โ”€ PrayerAPI             # Prayer api
โ”‚   โ”œโ”€โ”€ ShopAPI               # Shop interface handling
โ”‚   โ”œโ”€โ”€ SlayerRewardsAPI      # Slayer rewards interface api
โ”‚   โ”œโ”€โ”€ TabsAPI               # Inventory tabs management
โ”‚   โ”œโ”€โ”€ WidgetAPI             # General widget api
โ”‚   โ”œโ”€โ”€ MiniMapAPI            # Minimap api
โ”‚   โ””โ”€โ”€ WorldMapAPI           # World map api
โ”‚
โ”œโ”€โ”€ ๐Ÿ—บ๏ธ Advanced Services
โ”‚   โ”œโ”€โ”€โ”€ ๐Ÿงญ ipc/
โ”‚   โ”‚   โ”œโ”€โ”€ ChannelBuilder      # Builder class for Channel instance
โ”‚   โ”‚   โ””โ”€โ”€ Channel             # Stateless inter-client comunications service
โ”‚   โ””โ”€โ”€โ”€ ๐Ÿงญ pathfinder/
โ”‚       โ”œโ”€โ”€ Pathfinder          # OSRS Pathfinding
โ”‚       โ””โ”€โ”€ Walker              # World walker
โ”‚
โ”œโ”€โ”€ ๐Ÿ” Query System
โ”‚   โ”œโ”€โ”€ InventoryQuery           # Inventory filtering & search
โ”‚   โ”œโ”€โ”€ NpcQuery                 # NPC filtering & selection
โ”‚   โ”œโ”€โ”€ PlayerQuery              # Player filtering & search
โ”‚   โ”œโ”€โ”€ TileItemQuery            # Ground item queries
โ”‚   โ”œโ”€โ”€ TileObjectQuery          # Game object queries
โ”‚   โ”œโ”€โ”€ WidgetQuery              # UI widget queries
โ”‚   โ””โ”€โ”€ WorldQuery               # World queries
โ”‚
โ”œโ”€โ”€ ๐ŸŽจ UI Components
โ”‚   โ”œโ”€โ”€ VPluginPanel             # Base plugin panel
โ”‚   โ”œโ”€โ”€ FancyButton              # Styled button component
โ”‚   โ”œโ”€โ”€ FancyDropdown            # Enhanced dropdown menus
โ”‚   โ”œโ”€โ”€ ToggleSlider             # Modern toggle switches
โ”‚   โ””โ”€โ”€ UI utilities             # Layout & styling helpers
โ”‚
โ””โ”€โ”€ ๐Ÿ”ง Utilities
    โ”œโ”€โ”€ ActorPathing             # NPC/player movement utilities
    โ”œโ”€โ”€ ClickManagerUtil         # Click interaction helpers
    โ”œโ”€โ”€ ClientConfig             # Client configuration management
    โ”œโ”€โ”€ Coroutine                # Async task management
    โ”œโ”€โ”€ Location                 # Location & coordinate utilities
    โ”œโ”€โ”€ MessageUtil              # Game message handling
    โ”œโ”€โ”€ Profiler                 # Performance profiling
    โ”œโ”€โ”€ ReflectBuilder           # Fluent reflection API
    โ”œโ”€โ”€ ReflectUtil              # Reflection helpers
    โ”œโ”€โ”€ ResourceUtil             # Resource loading utilities
    โ”œโ”€โ”€ RuneliteConfigUtil       # RuneLite config integration
    โ”œโ”€โ”€ TextUtil                 # Text processing utilities
    โ”œโ”€โ”€ ThreadPool               # Thread management
    โ””โ”€โ”€ WorldPointUtil           # World coordinate utilities

Key Features:

  • ๐Ÿš€ High-Performance: Optimized for speed with advanced caching
  • ๐Ÿง  Smart Automation: Built-in pathfinding, dialogue, and interaction systems
  • ๐Ÿ”Œ Plugin Ecosystem: Hot-swappable plugin architecture