Ode Script Editor: A simple embedded script editor entirely in Roblox

Resources Community Resources
, , ,
#1

Installation:

Ode Script Editor is a simple and embedded Luau source-code editor in Roblox that can run both in-game and contained in a plugin. It includes some QoL features such as syntax highlighting and auto-indentation.

Here is a very simple snippet that demonstrates its usage. It works almost entirely out of the box with no tinkering required!

local OdeSE = require(path.to.OdeScriptEditor)
local FrameInstance: Frame = path.to.FrameInstance

local scriptEditor = OdeSE.Embed(FrameInstance)

odecode

To see it in action, check out my plugin Exestack!

Wait, how do I use this? [DOCUMENTATION]

Ode Script Editor requires minimal setup, only needing a GuiObject (preferably a Frame) and a single function to attach the editor. However, to actually use it for something useful needs some more work. Ode provides a simple API under the ScriptEditor class created by .Embed().

ScriptEditor OdeScriptEditor.Embed(Gui: GuiBase2d)

Creates a ScriptEditor class.

nil ScriptEditor:LoadStringAsync(str: string, lineNumber: number?)

Loads a string and jumps to the specified line number or 1 if none is given.

nil ScriptEditor:LoadScriptAsync(scriptObject: LuaSourceContainer, lineNumber: number)

Loads a script and jumps to the specified line number or 1 if none is given. Ode does not save changes if you use this! It needs to be done in conjunction with .OnEdit.

nil ScriptEditor:Unload()

Unloads the script editor’s source code text.

nil ScriptEditor:ReadOnly(allowEditing: boolean?)

Sets the script editor to read only. If allowEditing is set to true then it re-enables editing.

nil ScriptEditor:ApplyTheme(odeThemeData: OdeThemeData)

Applies a theme to Ode. Read the source code for more information.

nil ScriptEditor:ApplyStudioTheme(studio: Studio)

Applies a studio theme to Ode.

Event ScriptEditor.OnEdit (source: string)

An event that fires whenever an edit has been made.

number ScriptEditor.LineFocused

The line that is first displayed.

string ScriptEditor.RawSource

The raw source code the editor is using.

Frame ScriptEditor.Background

The GUI container for the script editor

number ScriptEditor.VisibleLines

An internal value used to describe the number of lines visible in the editor.

LuaTable ScriptEditor.SourceData

An internal data type used to represent source code.

OdeThemeData ScriptEditor.Theme

An internal table for Ode’s theme data. To change this use the :ApplyTheme method given. For more information check out the GitHub repo.

Any other features?

I’m quite busy as of right now and can’t find the time to develop much. However, you are welcome to help in the repo!

14 Likes
#2

Is there anyway to run the script?

1 Like
#3

This sounds pretty awesome! I’m thinking of utilizing this to have an AI write its own code like in that Stanford paper on minecraft.
For something like that you would need to prompt an AI model to write code. ChatGPT is the best API for this. You can send a system message to only respond in code format then recieve the string from the API and execute the string using

LoadString(response.response_text). But you would

function GPT4(inputText)
-- Import the HttpService
-- Define the API URL
	local API_URL =""
-- Define the headers with your authorization key
local headers = {
	["Authorization"] = Bearerkey
}

-- Define a function to query the API with a payload
local function query(payload)
	-- Encode the payload as a JSON string
	local jsonPayload = HttpService:JSONEncode(payload)
	-- Send a POST request to the API URL with the headers and the payload
	local response = HttpService:PostAsync(API_URL, jsonPayload, Enum.HttpContentType.ApplicationJson, false, headers)
	-- Decode the response as a JSON table
	local jsonResponse = HttpService:JSONDecode(response)
	-- Return the JSON table
	return jsonResponse
end
	
-- Define your input text
	
-- Query the API with your input text as the inputs field
	local output = query({
["system_message"] ="You are a Lua coding assistant in the context of ROBLOX Studio. Only provide your response in code block format and only provide explanations in comments."		
["inputs"] = chatmodule.randomizeString(inputText),
	})
	
	-- or
	local generatedText = output[1]["generated_text"]
--print(output)
	-- Print the string
	return generatedText
-- Print the output

end

You can then save this string if it passes into a function key array. You can then use a function like this to input the prompt and store the generated command into an array. This is just concept. I haven’t done it myself but I’ve looked into it. :slight_smile: I’m working on a library of action functions right now, but a more advanced version of this concept here would be good for creating self learning AIs that write their own code using a LLM.

---example of table function
local Labeldb={
	["search query"]=wikidb,
}
--example of writing a input into an existing table
--- and receiving api input to store the function into an array
function WriteData(playerinput)
local savedfunction=GPT4(playerinput)
Labeldb[playerinput]= function() return savedfunction:LoadString() end --This way the recieved variable is stored and the function is executed with the
Labeldb[playerinput]()
end
#4

Edit: I just realized you wanted to run the script you wrote in Ode. Sorry but this resource doesn’t come with a compiler/interpreter of any kind. That’s something you have to do yourself.

ORIGINAL REPLY:

It’s already explained in the original post with my simple code snippet but I’m gonna guide you through the process since it seems you’re struggling a bit.

  1. Install the module script. This can be done with the GitHub repo using plugins like Rojo or installing the one provided in the Creator Marketplace.
  2. Create a new Roblox place or use an old one.
  3. Once you’ve installed it, place it inside ReplicatedStorage.
  4. Create a ScreenGui and a Frame instance. I recommend resizing the Frame to take up more space.
  5. Create a local script inside of the ScreenGui and write this inside:
local OdeSE = require(game.ReplicatedStorage.OdeScriptEditor)
local FrameInstance = script.Parent.Frame

local scriptEditor = OdeSE.Embed(FrameInstance)
  1. You’re done!

I can’t actually test this since I’m not on my computer right now but it should work. If you want an additional example you can use the uncopylocked Roblox place I listed to see how the code works.

#5

welp is there anyone i could get all the text the player written then run it with load string or something?

#6

Yes. I just forgot to include it in the documentation.

odeScriptEditor.OnEdit:Connect(function(source)
    --prints luau code the user wrote
    print(source)
end)

or

local source = odeScriptEditor.RawSource

As for running the code, use loadstring or this: vLua: Loadstring reimplemented in Lua

#7

Version 1.0.1

  • Added some new builtin identifiers (Font, SharedTable, buffer, etc.).
  • Partial syntax highlighting support for string interpolation.
#8

Version 1.0.2

  • Fixed a bug introduced with Roblox’s TextBox Scrolling update where moving your cursor could cause a desync between the text and syntax highlighting.
  • Fixed a bug where line numbers would not properly update.
1 Like