CFX Run

CFX Run allows GitHub Copilot Chat (GitHub.copilot-chat) for debugging and interacting with CFX (FiveM / RedM) game clients. It provides Copilot tools to execute JavaScript code in a sandboxed environment, this becomes useful for Copilot to debug and interact with the game client for more integrated development experience.

Requirements

• FiveM server running CfxRun resource.

Contributing

Pull requests and issues are welcome!

Join our Discord for support and discussions.

Features

• Execute JavaScript code in FiveM client environment
• Run code in NUI/CEF contexts for UI debugging
• Get and insert player coordinates (with/without heading)
• Remote debugging over network

Planned Features

• User Input support (KEYBOARD, JOYSTICK, MOUSE, PAD, TOUCHPAD)
• Server-side code execution

Limitations

• Reference tools in chat messages to use them: @RunJSFiveMCode Get the player position
• No server-side code execution
• No User Input support (KEYBOARD, JOYSTICK, MOUSE, PAD, TOUCHPAD)

Remote CFX Run

To use CFX Run remotely, you need to expose client DevTools.

Same network

1. Open the game client.
2. In CMD, run:

   netsh advfirewall firewall add rule name="CEF DevTools Port" dir=in action=allow protocol=TCP localport=13172
   

3. In CMD, run:

   netsh interface portproxy add v4tov4 listenport=13172 listenaddress=0.0.0.0 connectport=13172 connectaddress=127.0.0.1
   

If you have already ran the commands: 3. Before running the game, you need to

netsh interface portproxy delete v4tov4 listenport=13172 listenaddress=0.0.0.0

4. Run the game client.
5. Repeat step 2.