Awesome
GriddyCode
Coding has never been more lit!
https://github.com/face-hh/griddycode/assets/69168154/df93830e-6e24-472d-a854-cea026b12890
P.S. Press CTRL + I for a quick introduction in the Editor :)
Table of Contents
Requirements
| Requirement | Notes |
|---|---|
| Nerdfont - we use Nerdfont for the file picker. | You'll know it's missing when your icons look like "□" |
| Linux - GriddyCode is tested mainly on Linux | No, macOS won't be supported. Gaming OS works. |
⌨️ Lua modding
GriddyCode allows you to extend its functionality via Lua.
Where?
To open the folder with Lua scripts, go to:
- Windows:
%APPDATA%\Godot\app_userdata\Bussin GriddyCode - macOS:
~/Library/Application Support/Bussin GriddyCode - Linux:
~/.local/share/godot/app_userdata/Bussin GriddyCode
Note: the paths are not accurate, we recommend you manually search for GriddyCode in the AppData of your OS.
How?
You may see the folders "langs" and "themes".
- "langs" holds a bunch of
.luafiles that power GriddyCode's syntax highlighting & autocomplete. - "themes" holds a bunch of
.luafiles that change GriddyCode's appearance.
Note: the Lua scripts are reloaded only if you switch from a different file extension (i.e. "README.md" -> "main.ts"), or if GriddyCode is restarted.
Docs?
Langs
Introduction
To extend the functionality of GriddyCode for a specific file extension, create a file with its name. (i.e. toml.lua)
Methods
| Method | Example | Description | Notes |
|---|---|---|---|
highlight(keyword: String, color: String) | highlight("const", "reserved") | Tells GriddyCode to highlight a certain keyword with a preset of colors. | Available colors: reserved, annotation, string, binary, symbol, variable, operator, comments, error, function, member |
highlight_region(start: String, end: String, color: String, line_only: bool = false) | highlight("/*", "*/", "comments", false) | Tells GriddyCode to highlight a region with a preset of colors. | The start must be a symbol. Due to Godot's limited functionality, you can't use RegEx. |
add_comment(comment: String) | add_comment("What is blud doing 🗣️🗣️🗣️") | Adds a comment to be randomly chosen in the CTRL + L menu. | The username, profile picture, date, and likes are chosen by GriddyCode. |
detect_functions(content: String, line: int, column: int) -> Array[String] | detect_functions("const test = 3; function main() {}; async init() => { main() }") | Called by GriddyCode upon input. Results are showed in the autocomplete feature. | This must be provided by the Lua script. It must return an array of strings (i.e. ["main", "init"]). "line" and "column" are the position of the cursor when the autocomplete was requested. |
detect_variables(content: String, line: int, column: int) -> Array[String] | detect_variables("const test = 3;") | Called by GriddyCode upon input. Results are showed in the autocomplete feature. | This must be provided by the Lua script. It must return an array of strings (i.e. ["test"]). "line" and "column" are the position of the cursor when the autocomplete was requested. |
Note: to provide reserved variables/functions (i.e. Math/parseInt() in JS) you can have them already set up in the array you return. GriddyCode will handle the rest!
Themes
Introduction
To add a theme, create a file in the "themes" folder with any name. (i.e. "dracula.lua"). You will be able to choose it within GriddyCode.
Methods
| Method | Example | Description | Notes |
|---|---|---|---|
set_keywords(property: String, new_color: String) | set_keywords("reserved", "#ff00ff") | Set the color of syntax highlighting. | The second argument must be a hex, # being optional. Available colors/properties listed above at langs. |
set_gui(property: String, new_color: String) | set_gui("background_color", "#ff00ff") | This method is dedicated to the overall GUI aspect of GriddyCode. | Available properties: background_color, current_line_color, selection_color, font_color, word_highlighted_color, selection_background_color. Properties except background_color, if not provided, will be set to a slightly modified version of background_color. Although possible, we don't recommend you rely on those & instead set all the values. |
disable_glow() | disable_glow() | Disables the "glow" setting. | This exists because Godot's glow seems to mess up on light colors. Not adding this on light themes may result in the entire screen going white. |
Note: if the HEX you input is invalid, it will default to #ff0000 (red)
Publishing
If you want to use a theme/plugin for yourself, you can put it into your AppData.
If you want to submit a theme/plugin, open a pull request adding it to Lua/Plugins or Lua/Themes respectively. If merged, it will be included in the next build.
Contributions
Contributions are heavily appreciated, whether it's for adding Lua plugins, themes, safely exposing more features to Lua, or adding features directly to GriddyCode!
Notice
- You will need to install the Godot Engine to run your proposed change & make sure it runs flawlessly.
- You don't have to submit executables.
- Use the v4.2 of the engine (currently Latest)
🐛 Current bugs/needed features:
HIGH PRIORITY
- The
VHS & CRTshader, on certain themes (One Dark Pro, GitHub Light, etc.), becomes completely white. Works good on GitHub Dark; - Light modes get affected by glow, while dark modes seem fine.
MEDIUM PRIORITY
- An option in the settings menu (
CTRL+,) to change the font; - The current limit for lines is ~1600. If the cursor moves past that amount, the
CodeEditnode will activate its scrolling, making the camera bug & go out of view. A limit should be implemented so that the camera won't go out of screen.
LOW PRIORITY
- Making the cat jumping video in the settings menu fade in/out along the actual menu. Currently it ignores the transition;
CTRL+Pto open a quick file picker, similar to VSCode.- Selecting a setting with the property "shader" should disable previously-enabled settings with "shader".
- The
CheckButtonnode for eachsettingscene doesn't change with the theme. This affects light themes specifically.
Please note that creating a Pull Request to fix these features does not guarantee its merge. Please don't open a Pull Request unless you are confident you've done a good job.