aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/SUMMARY.md1
-rw-r--r--docs/modding/squirrel/setup-syntax-highlighting.md24
2 files changed, 25 insertions, 0 deletions
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
index 89e0cd6..f242f23 100644
--- a/docs/SUMMARY.md
+++ b/docs/SUMMARY.md
@@ -35,6 +35,7 @@
* [Tutorials](modding/tutorials/modding-tutorials.md)
* [Cheatsheet](modding/cheatsheet.md)
* [Squirrel](modding/squirrel/what-is-squirrel.md)
+* [Setup Syntax Highlighting](modding/squirrel/setup-syntax-highlighting.md)
* [Localisation](modding/localisation_files.md)
***
diff --git a/docs/modding/squirrel/setup-syntax-highlighting.md b/docs/modding/squirrel/setup-syntax-highlighting.md
new file mode 100644
index 0000000..e0ec465
--- /dev/null
+++ b/docs/modding/squirrel/setup-syntax-highlighting.md
@@ -0,0 +1,24 @@
+# Syntax Highlighting
+## Notepad++
+For Notepad++, define a custom language for Squirrel.
+Luckily, [samisalreadytaken has written a squirrel highlighter](https://gist.github.com/samisalreadytaken/5bcf322332074f31545ccb6651b88f2d#file-squirrel-xml).
+1. Download Squirrel.xml
+2. At the top, edit ' ext="nut" ' to ' ext="nut gnut" ' so it works with gnut files as well
+3. Open Notepad++
+4. Navigate to Language > User Defined Language > Define your language
+5. Click import, and select Squirrel.xml
+
+(If the colors/style are not to your taste)
+1. Select 'Squirrel' in User Language at the top
+2. Navigate through the tabs to find what you want to change
+3. Click its 'Styler' button and make the changes you wish to
+
+## VSCode
+VSCode has extensions avaliable for working with squirrel, and searching "squirrel" in the extensions marketplace will give you them.
+
+However, installing this will only create an associastion for .nut files, and not .gnut files.
+To fix this:
+1. Open a .gnut file
+2. Do CTRL+K, M (not CTRL+K, CTRL+M)
+3. Select 'Configure File Association for .gnut'
+4. Select 'Squirrel' (only appears if you have the extension) \ No newline at end of file