For the complete documentation index, see llms.txt. This page is also available as Markdown.
Running from Source
Introduction
Gum is an open source project so you can run it from source instead of running the pre-compiled project. Running from source is not a requirement, and is only needed if you intend to contribute to Gum or if you'd like to diagnose problems in a debugger.
If you downloaded the .zip file from the GitHub main page, unzip the file
If you downloaded the file through a Git client, be sure to be on the main branch
Gum repository in Github Desktop
Running the code
Locate the Gum.sln file
If you downloaded the .zip, it is in the root folder of the zip
If you cloned the repository, it is at the root of the Gum folder
Double-click it to open Visual Studio, or open Visual Studio and load the .sln
Be sure to build solution rather than pressing F5 (which only builds the current project). This guarantees that all plugins are built and copied correctly. For more information see below.
Once the project has been built, you can run (with or without a debugger attached).
Building Plugins
Gum depends on a number of plugins for its functionality. By default if you build the project and run it (such as by pressing F5 in Visual Studio), then plugins are not automatically built. To build plugins, you need to explicitly build all plugin projects. The easiest way to do this is to select the Build -> Rebuild Solution option in Visual Studio.
Build -> Rebuild Solution in Visual Studio
Troubleshooting
Missing Editor Tab
If your Editor Tab is missing, be sure to Build -> Build Solution. The Editor tab is a plugin, and you can verify that the plugin is in fact being built/loaded.
First view plugins:
Next, look for the Editor tab plugin in the list that appears:
If you are missing this, be sure to Build -> Build Solution.
A project with an Output Type of Class Library cannot be started directly
If you have this popup, you need to set Gum as the startup project.
