Skip to content

Overview

GMPulse is separated into five sections:

When you first open the GUI from your game (by pressing F3 by default) you will see the Settings screen first. Clicking the buttons at the top of screen will let you navigate between the sections. If you're accessing the GUI from a device with a small screen, the header buttons may be hidden by default, in which case you can access them by clicking on the "Menu" button on the top right.

Accessing the GUI manually

As long as GMPulse is enabled, your game is hosting the GUI website. When you press F3 (or whatever key you set GM_PULSE_DEBUG_KEY to) it simply opens the proper URL in your browser. This URL can be typed in manually by following this format:

http://localhost:{GM_PULSE_PORT}/

By default, GM_PULSE_PORT is set to 1234, and so the default URL is http://localhost:1234/. You can access certain pages in the GUI by manually constructing a proper URL, which can come in handy. See Editing specific instances.

Accessing the GUI on another device

By replacing "localhost" with the local IP address of your computer, you should be able to access the GUI from other devices on the same network. If you fail to connect from other devices, double check that your firewall settings aren't blocking connections to your game / PC.

INFO

Unless you setup port forwarding through your router to the specific port that GMPulse is using, the GUI website will not be accessible outside of your home network. So no need to worry about someone on the internet accidentally getting access.