saamlaura

🎮 resolink-mcp - Control Your Resonite VR World Easily

🚀 Getting Started

Welcome to the ResoniteLink MCP. This tool helps you manage and operate your Resonite VR world using the WebSocket protocol. Follow these steps to download and run the software.

📥 Download & Install

1. Visit the Releases Page: To download the software, click here.
2. Select the Latest Release: Find the latest version of the software on the releases page. Click on the appropriate file for your operating system.
3. Download the File: Save the file to your device.

🛠️ Installation Steps

1. Open Your Terminal: Access your command line interface. This depends on your system:
   • Windows: Use Command Prompt or PowerShell.
   • macOS: Open the Terminal app.
   • Linux: Use your Linux shell.
2. Navigate to the Download Folder: Change the directory to where you downloaded the file. Use the command:

   cd path/to/your/download/folder
   

3. Install Required Packages: Run the following commands to install necessary packages:

   npm install
   npm run build
   

4. Configuration Setup: Once installed, configure your MCP server settings.

⚙️ Configuring the MCP Server

💬 Claude Code Setup

1. Open the project root directory and locate the .mcp.json configuration file.
2. This file contains the settings you need. After saving changes, restart Claude Code. The MCP server will now be available automatically.

🖥️ Claude Desktop Setup

1. Find the claude_desktop_config.json file on your system.
2. Add the following configuration to set up the MCP server:

   {
     "mcpServers": {
       "resonitelink": {
         "command": "node",
         "args": ["C:/Users/neo/GitHub/resolink_mcp/dist/mcp-server.js"],
         "env": {
           "RESONITE_WS_URL": "ws://localhost:29551"
         }
       }
     }
   }
   

🛠️ Available Tools

You can use the following commands to perform various tasks within your Resonite VR world:

Tool	Description
connect	Connect to Resonite
disconnect	Disconnect from Resonite
get_slot	Fetch information about slots
find_slot	Search slots by name
add_slot	Add a new slot
remove_slot	Delete a slot
update_slot	Modify an existing slot
add_component	Add a new component
get_component	Retrieve component information
update_component	Update a component
remove_component	Delete a component
import_texture_file	Import textures from a file
search_components	Look for specific components

📜 Usage Instructions

1. Connecting to Resonite:
   • Use the connect command to establish a connection to your Resonite world.
2. Managing Slots:
   • Use get_slot to view current slots.
   • Add new slots with add_slot and remove existing ones with remove_slot.
3. Handling Components:
   • Manage components using the relevant commands like add_component and remove_component.

📑 Useful Tips

• Make sure you have Node.js installed on your system. You can download it from Node.js Official Site.
• If you face issues during setup, ensure all paths and configurations are set correctly in the JSON files.
• Regularly check the Releases page for updates to the software. New features and fixes may be added over time.

For detailed information and troubleshooting, you can refer back to this README or seek more assistance on community forums.

Remember, managing your Resonite VR world is simple with the right tools. Happy exploring!