Roblox Studio MCP Server Updated

🚀 Roblox Project Configuration

This guide provides detailed instructions on configuring and using a Roblox project, including project configuration, script usage, server startup, and troubleshooting.

✨ Features

• Comprehensive configuration options for Roblox projects.
• Examples of Lua scripts for game initialization and client/server startup.
• Instructions on using MCP tools for code generation and template application.
• Troubleshooting guidance for common issues.

📦 Installation

1. Configuration File Structure

Create a config.json file in the root directory of your project with the following content:

{
    "version": "1.0.0",
    "name": "my_roblox_project",
    "description": "A basic Roblox platformer game project.",
    "configuration": {
        "api_key": "your_roblox_api_key_here",
        "server_url": "http://localhost:3000",
        "cache_enabled": true,
        "logging": {
            "level": "info",
            "output_file": "logs/app.log"
        },
        "performance_tuning": {
            "max_connections": 100,
            "request_timeout": 30
        }
    },
    "tools": [
        {
            "name": "mcp",
            "description": "Roblox Studio MCP server interface call tool",
            "parameters": {
                "$schema": "http://json-schema.org/draft-04/schema",
                "type": "object",
                "properties": {
                    "server_url": {
                        "type": "string",
                        "description": "URL address of the MCP server"
                    },
                    "tool_name": {
                        "type": "string",
                        "description": "Name of the MCP tool to be called"
                    },
                    "tool_parameters": {
                        "type": "object",
                        "description": "Specific parameters passed to the MCP tool"
                    }
                },
                "required": ["server_url", "tool_name"]
            }
        }
    ],
    "scripts": [
        {
            "name": "generate_roblox_code",
            "description": "Generate Roblox game code",
            "parameters": {
                "$schema": "http://json-schema.org/draft-04/schema",
                "type": "object",
                "properties": {
                    "script_type": {
                        "type": "string",
                        "enum": ["ClientScript", "ServerScript"],
                        "description": "Script type, optional values are ClientScript or ServerScript"
                    },
                    "functionality": {
                        "type": "string",
                        "description": "Functional description of the script"
                    },
                    "include_comments": {
                        "type": "boolean",
                        "description": "Whether to include comments, default is false"
                    }
                }
            }
        }
    ],
    "templates": [
        {
            "name": "roblox_platformer_template",
            "description": "Basic platformer game template",
            "source": "template://roblox/game/platformer" // Template source URL
        }
    ]
}

2. Start the Server

Run the following command to start the Roblox project server:

rbxserver.exe --project="path/to/your/project" --server-port=8080

💻 Usage Examples

Basic Usage

Generate Code

Use the following command to generate Roblox game code via the MCP tool:

mcp-cli call generate_roblox_code \
--parameters '{"script_type": "ServerScript", "functionality": "Player join event handler", "include_comments": true}'

Apply Template

Use the following command to apply a game template via the MCP tool:

mcp-cli call apply_template \
--parameters '{"template_name": "roblox_platformer_template"}'

Advanced Usage

The provided Lua scripts can be further customized to meet specific game development requirements. For example, modify the event handling logic in the game initialization script:

-- Game initialization script example
local Players = game:GetService("Players")
local player = Players.LocalPlayer or Players.PlayerAdded:WaitForPlayer()
player.CharacterAdded:Connect(function(char)
    -- Event handling logic when the player's character is loaded
    print("Character loaded:", char.Name)
    -- Additional custom logic can be added here
end)

-- Triggered when exiting the game
game:BindKey(Enum.KeyCode.Escape, function()
    print("Game exited by player")
    game.Players.LocalPlayer:Kick() -- Force exit the game
end)

📚 Documentation

Troubleshooting

Common Issues

• Q1: How to handle server connection timeouts?
  • A1: Check the request_timeout setting in config.json. It is recommended to increase the timeout or optimize the network configuration.
• Q2: What if the log file path cannot be written?
  • A2: Ensure that the project directory has write permissions and check if the logging.output_file path is correct.

🔧 Technical Details

The project uses a JSON configuration file to manage project settings, including API keys, server URLs, caching, logging, and performance tuning. The MCP tool provides a convenient way to call functions such as code generation and template application. Lua scripts are used for game initialization and event handling, and the Roblox server is started using a Bash script.

📄 License

No license information is provided in the original document.