Big Announcements for the New Year

Hey folders! The Foldit team is happy to announce an awesome update for you!

Early next year, we will be rolling out a brand new website! This website will have loads of new features that we hope will help players share ideas with each other and help our scientists share more cool science updates with you! Additionally, this change will come with a big clean-up from some of our old systems, which will make development much smoother moving forward and take care of a few bugs which have been sitting around for years. In particular:

When the new website is rolled out, we will remove support for GUI and Lua V1 recipes.

This means that you will no longer be able to write or run GUI and Lua V1 recipes. In preparation for this change, we ask that you convert your recipes into Lua V2 recipes so that they will not be lost in the transition. For V1 to V2 conversions, Foldit player Rav3n_pl has made a converter script, available for Windows users here. For GUI to V2 conversions, we encourage you to ask questions in the #recipes channel of the official Foldit Discord. As we begin this transition, more conversion resources may become available, so following the #recipes channel will be the best way to stay up-to-date. These resources will also be posted to the Foldit Wiki, and we encourage you to use our wiki for all documentation. If you need additional help converting a recipe, please contact us directly at with a link to the recipe you'd like converted. It may take us some time, but we will make sure that we get you a Lua V2 version of the recipe.

Why are we getting rid of these systems? Supporting GUI and Lua V1 has always been tricky for us ever since Lua V2 came out. By switching to only one system, we will be able to make new Lua functions and other game features much more quickly, as well as better prevent and eliminate recipe-related bugs. This switch also allows us to roll out the new website much quicker if we only need to support one recipe system.

Thank you so much for your patience and understanding as we work on creating new features for you to enjoy. Your contributions to scientific research are very much appreciated, and we look forward to sharing new science updates soon.

As always, happy folding.

(Mon, 11/23/2020 - 17:24  |  4 comments)
LociOiling's picture
User offline. Last seen 3 hours 20 min ago. Offline
Joined: 12/27/2012
Groups: Beta Folders
on the wiki...

Check out GUI to Lua - converting Co lapse's Settle for a detailed example of converting a GUI recipe.

There's also GUI commands to Lua functions, which gives the Lua V2 equivalents for each of the 21 GUI recipe commands. Each of the GUI commands now has its own detail page, too.

On the Lua V1 front, the V2 list, Foldit Lua Functions, and the V1 list, Foldit Lua Functions (v1), have been updated to link to each other's functions. There are also new detail pages for each of the V1 functions, just for completeness.

LociOiling's picture
User offline. Last seen 3 hours 20 min ago. Offline
Joined: 12/27/2012
Groups: Beta Folders
more wiki...
LociOiling's picture
User offline. Last seen 3 hours 20 min ago. Offline
Joined: 12/27/2012
Groups: Beta Folders
python eats cookbook

Check out MacroScanner over on Github.

This Python script scans all.macro and generates a Lua recipe for each GUI recipe it finds.

It's an automatic version of the process described in GUI to Lua - converting Co lapse's Settle.

You'll have to have Python installed to run MacroScanner yourself. I'll also take requests....

This version of MacroScanner is a rough cut. It doesn't try to figure out what the recipe is doing. It just generates one set of Lua commands for each GUI recipe command, and moves on. See GUI to Lua - refining Co lapse's Settle for an example of a smarter approach.

There are some special cases and GUI recipe errors that generate non-working Lua code from MacroScanner.

There's no Lua equivalent for the "user pick" option on segments and bands. MacroScanner generates code that works with a table of segments or bands, but you must add the table.

Similarly, if a GUI recipe is incomplete, the Lua code from MacroScanner won't work. You must supply any missing arguments.

Both the "user pick" and the "missing arguments" cases generate "TODO" comments in the recipe output.

Each new Lua recipe is written to a separate file. The filename is based on the recipe name, and is intended to work across platforms. So spaces become underscores, and some other characters get substituted. For example, the GUI recipe "Hand-Folding: GUI banding " becomes "Hand-Folding_GUI_banding.lua".

Testing revealed that the "quicksave" and "quickload" commands may disappear from GUI recipes with no warning. This seems to happen when a GUI recipe is shared via the Foldit website. Recipes that were downloaded some time ago seem to retain their quicksaves and quickloads.

LociOiling's picture
User offline. Last seen 3 hours 20 min ago. Offline
Joined: 12/27/2012
Groups: Beta Folders
more python

The MacroScanner utility has been refined and expanded.

As before, it's command line Python program. Although Python is easy to install and run, I know that some people may not feel comfortable with it, so I'll take requests. Send me a PM here, or reach out on the #recipes channel on the Foldit Discord server.

As far as the update goes, version 1.1 uses new Lua functions to handle the "user pick" option in GUI recipes for segments and bands.

The new version optionally dumps existing Lua recipes, so it can now unpack an entire cookbook. Lua recipes aren't modified, except that the various parameters found in the cookbook are added as a comment at the beginning of the recipe. (A similar format is used for the converted GUI recipes.)

Version 1.1 also lets you specify a separate output directory for the Lua recipes. The directory is created if it doesn't exist.

There are some fixes to the Lua code generated for GUI recipes. (The output for local wiggle was wrong in certain cases in the previous version.)

Some additional cases that previously produced errors are now handled. Version 1.1 can list the old GUI "example" recipes that used to be found in an empty cookbook. It can also detect and process the single.macro format, where the file contains just one recipe.

We still don't know the date when GUI recipes will be phased out. It's always a good idea to have a backup of all.macro and other Foldit files (such as options.txt, theme.txt, hotkeys.txt, and so on). Make sure your backup lives outside of Foldit. sSo if you have c:\Foldit, put your backed-up files anywhere else, for example c:\folditbackups.

User login
Download links:
  Windows    OSX    Linux  
(10.12 or later)

Are you new to Foldit? Click here.

Are you a student? Click here.

Are you an educator? Click here.
Social Media

Only search
Other Games: Mozak
Recommend Foldit
Top New Users

Developed by: UW Center for Game Science, UW Institute for Protein Design, Northeastern University, Vanderbilt University Meiler Lab, UC Davis
Supported by: DARPA, NSF, NIH, HHMI, Amazon, Microsoft, Adobe, Boehringer Ingelheim, RosettaCommons