Back to Recipes Homepage
recipe picture
Recipe: LuaFunctions1.4
Created by LociOiling 2 1
Your rating: None Average: 5 (1 vote)


Name: LuaFunctions1.4
ID: 102310
Created on: Mon, 03/20/2017 - 11:10
Updated on: Sun, 11/22/2020 - 00:31

Not a foldit recipe. LuaFunctions is a standalone Lua script used as step in producing the "Foldit Lua Functions" page on the wiki. The input to this script is the output from the series of Foldit help commands produced by LuaHelp2Help. Version 1.4 generates links to the function detail pages.

Best For


LociOiling's picture
User offline. Last seen 1 hour 57 min ago. Offline
Joined: 12/27/2012
updated to handle version 1 of the Foldit Lua interface

LuaFunctions is not a Foldit recipe. It should produce a polite message stating this fact if you run it from your cookbook.

This a standalone Lua script, so you must have Lua installed separately from Foldit to run.

This script takes the output from a list of help commands, and formats it to produce wiki text markup. The help commands are generated by the companion LuaHelp2Help script.

Due to problems with the "help", some manual fixes are needed to get the desired results.

See for more details.

Version 1.2 introduces support for version 1 of the Foldit Lua interface. Add "V1" at the end of the argument list to process version 1 functions. Each V1 function is cross-referenced to its V2 counterpart. There is no grouping by namespace for V1.

Some minor corrections to V2 cross-references were added in this release as well.

Joined: 09/24/2012
Groups: Go Science
Impressing !

Thanks Loci, that makes the Wiki in line with the software.

I appreciate the Lua V1 addition and the "Unimplemented/disabled functions" chapter. This avoids us to use these functions in recipes and/or gives ideas to ask to implement them again. For exemple, I would like to see "Tweak" functions implemented.

LociOiling's picture
User offline. Last seen 1 hour 57 min ago. Offline
Joined: 12/27/2012
Version 1.4

Version 1.4 generates cross-links between V1 and V2. Each V1 function should link to the corresponding V2, and each V2 function should link to its V1 counterpart, where one exists.

The program also generates a file called "detail.txt", containing the wiki markup for each function's detail page. This markup was used to create the function detail pages for all the V1 functions. (Previously, only one V1 function had a detail page.) The markup contains the same cross-links as the main list.

All of the V2 functions had detail pages already, so they're lacking the new cross-links. That will be corrected as time permits.

The name "detail.txt" is fixed, and can't be changed at the command line. The file is created in the current directory.

Version 1.4 also adds boldface to the "automatically generated page, do not update" warning at the top of the page. And the generated markup now includes an image for both V1 and V2.

Finally version 1.4 is now "LuaFunctions1.4.lua" with no spaces, for easier command line use.

Joined: 03/08/2012
Groups: None
Editiing recipe

Can't copy recipe into file editor (one line only).

Want to try?
Add to Cookbook!
To download recipes to your cookbook, you need to have the game client running.

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