Difference between revisions of "Sublime Text"

m (Update for new version of LuaLove + correct code syntax)
(Simplified page and updated information)
Line 1: Line 1:
−
The following instructions work both in [http://sublimetext.com/ Sublime Text] 2 and 3 unless mentioned otherwise.
+
Fast and customizable cross-platform code editor.
  
−
== Lua Love ==
+
[[File:lualove.png|right|thumb|Sublime Text with [https://packagecontrol.io/packages/Lua%20Love Lua Love package] on Linux]]
  
−
The [https://packagecontrol.io/packages/Lua%20Love Lua Love Package] provides syntax highlighting, snippets, autocompletion and build rules.
+
== Lua Love package ==
  
−
# Install [https://packagecontrol.io/installation Package Control], restart Sublime.
+
The [https://packagecontrol.io/packages/Lua%20Love Lua Love Package] provides syntax highlighting, snippets, autocompletion and build systems.
−
# Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> to open the '''command palette''' and use the '''Package Control: Install Package''' command.
 
−
# Wait until another input field appears and install the '''Lua Love''' package.
 
−
# In the '''command palette''' enable syntax highlighting with '''Set Syntax: LOVE'''.
 
−
# In Sublime 3 and 4, you can use <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>B</kbd> to select the build system '''LuaLove''' which from then on you can start using <kbd>Ctrl</kbd>+<kbd>B</kbd>.
 
−
# In Sublime 2, you have to manually edit the build script (<code>C:\Users\....\AppData\Roaming\Sublime Text 2\Packages\Lua Love\LuaLove.sublime-build</code> in Windows):
 
−
 
 
−
<source lang="json">{
 
−
"file_regex": "^(?:(?:\t)|(?:.+: ))(.+):([0-9]+): (.*)$",
 
−
"selector": "source.lua",
 
−
"shell": true,
 
−
"cmd": ["love", "${project_path:${file_path:.}}"],
 
−
 
 
−
"variants": [
 
−
{
 
−
"name": "Love2D",
 
−
"shell": true,
 
−
"cmd": ["love", "${project_path:.}"],
 
−
"osx":
 
−
{
 
−
"cmd": ["love $project_path"]
 
−
}
 
−
},
 
−
{  "name": "ldoc: File",
 
−
"shell": true,
 
−
"cmd": ["ldoc -d $project_path/doc/$file_base_name -f markdown -t $file_base_name $file"]
 
−
},
 
−
{  "name": "ldoc: Project",
 
−
"shell": true,
 
−
"cmd": ["ldoc -d $project_path/doc -f markdown -t $project_base_name $project_path/src/"]
 
−
}
 
−
]
 
−
}
 
−
</source>
 
−
 
 
−
Both Sublime 2 and 3 require the directory of your LÖVE binary to be part of your [[PATH]] variable. You can avoid this by changing the <code>"love"</code> path in the build script. This is [http://stackoverflow.com/questions/21190392/how-to-change-default-code-snippets-in-sublime-text-3 more complicated in Sublime 3].
 
−
 
 
−
== Simple Build System  ==
 
−
 
 
−
Create a new Build System: <code>Tools -> Build System -> New Build System</code> and use the following code.
 
  
 +
=== Instalation ===
 +
# Install [https://packagecontrol.io/installation Package Control] and restart Sublime Text
 +
# Press <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>P</kbd> to open the '''Command palette''' and enter '''Package Control: Install Package'''
 +
# Wait until another input field appears and install the '''Lua Love''' package
 +
# In the '''Command palette''' enable syntax highlighting with '''Set Syntax: LOVE'''
 +
# Now select build system with <kbd>Ctrl</kbd>+<kbd>Shift</kbd>+<kbd>B</kbd> to '''LuaLove''' and then you can use <kbd>Ctrl</kbd>+<kbd>B</kbd> to start LOVE.
 +
# '''Optional''': Set LOVE syntax as default for all .lua files - <code>View</code>→<code>Syntax</code>→<code>Open all with current extension as...</code>→<code>LOVE</code>
 +
# '''Optional''': If LOVE is not in your [[PATH]] variable, go to <code>Preferences</code>→<code>Package Settings</code>→<code>Lua Love</code> and add:
 
<source lang="json">
 
<source lang="json">
 
{
 
{
−
     "selector": "source.lua",
+
     "build_system.love.cmd": ["absolute/path/to/love/executable", "${project_path:${folder:${file_path}}}"]
−
    "file_regex": "^Error: (?:[^:]+: )?([^: ]+?):(\\d+):() ([^:]*)$",
 
−
    "windows": {
 
−
        "cmd": ["C:/Program Files/LOVE/love.exe", "${folder:${file_path}}"],
 
−
        "shell": true
 
−
    },
 
−
    "osx": {
 
−
        "cmd": ["/Applications/love.app/Contents/MacOS/love", "${folder:${file_path}}"]
 
−
    },
 
−
    "linux": {
 
−
        "cmd": ["love", "${folder:${file_path}}"]
 
−
    }
 
 
}
 
}
 
</source>
 
</source>
  
−
Save it in the suggested location as <code>love-run.sublime-build</code>.
+
=== Console output ===
  
−
Now you can use Ctrl+B or Cmd+B to run your love project.
+
By default the console in Sublime Text will not display any output, such as <code>print()</code> calls, until the LOVE application has been closed.
−
 
 
−
=== Issues ===
 
−
 
 
−
* This build system depends on the location of your LÖVE binary. Check the path in the <code>"cmd":</code> line.
 
−
* This build system doesn't seem to work if you have spaces in your <code>$file_path</code>.
 
−
 
 
−
== Console output ==
 
−
 
 
−
By default the console in Sublime Text will not display any output, such as print() calls, until the LOVE application has been closed.
 
  
 
To make the console output display live add the following code to the top of your <code>main.lua</code> file, or inside <code>[[conf.lua]]</code>:
 
To make the console output display live add the following code to the top of your <code>main.lua</code> file, or inside <code>[[conf.lua]]</code>:
 
<source lang="lua">
 
<source lang="lua">
−
io.stdout:setvbuf("no")
+
io.stdout:setvbuf('no')
 
</source>
 
</source>
  
−
== Jumping to errors ==
+
=== Jumping to errors ===
  
 
If there was an error during execution, you can use the F4 (next error) and SHIFT-F4 (previous error) to go through the errors that lua encountered.
 
If there was an error during execution, you can use the F4 (next error) and SHIFT-F4 (previous error) to go through the errors that lua encountered.
  
 
== See also ==
 
== See also ==
−
* [http://www.sublimetext.com/ Sublime Text Website]
+
* [https://www.sublimetext.com/ Sublime Text Website]
−
* [http://sublime-text-unofficial-documentation.readthedocs.org/en/latest/reference/build_systems.html Sublime Text 2 Build Systems]
+
* [https://stackoverflow.com/questions/16338523/live-console-output-in-sublime-text-2 Stack Overflow question about console output]
−
* [http://stackoverflow.com/questions/16338523/live-console-output-in-sublime-text-2 Stack Overflow question about console output in Sublime Text 2]
 
  
 
[[Category:Software]]
 
[[Category:Software]]
Line 94: Line 42:
  
 
{{#set:Name=Sublime Text}}
 
{{#set:Name=Sublime Text}}
 +
{{#set:Author=Jon Skinner, Sublime HQ}}
 +
{{#set:License=Shareware}}
 +
{{#set:Type=Editor}}
 +
{{#set:Status=Active maintenance}}
 
{{#set:Description=Source Code Editor}}
 
{{#set:Description=Source Code Editor}}
−
{{#set:Type=Editor}}
+
{{#set:Screenshot=File:lualove.png}}

Revision as of 13:52, 10 June 2022

Fast and customizable cross-platform code editor.

Sublime Text with Lua Love package on Linux

Lua Love package

The Lua Love Package provides syntax highlighting, snippets, autocompletion and build systems.

Instalation

  1. Install Package Control and restart Sublime Text
  2. Press Ctrl+Shift+P to open the Command palette and enter Package Control: Install Package
  3. Wait until another input field appears and install the Lua Love package
  4. In the Command palette enable syntax highlighting with Set Syntax: LOVE
  5. Now select build system with Ctrl+Shift+B to LuaLove and then you can use Ctrl+B to start LOVE.
  6. Optional: Set LOVE syntax as default for all .lua files - View→Syntax→Open all with current extension as...→LOVE
  7. Optional: If LOVE is not in your PATH variable, go to Preferences→Package Settings→Lua Love and add:
{
    "build_system.love.cmd": ["absolute/path/to/love/executable", "${project_path:${folder:${file_path}}}"]
}

Console output

By default the console in Sublime Text will not display any output, such as print() calls, until the LOVE application has been closed.

To make the console output display live add the following code to the top of your main.lua file, or inside conf.lua: 

io.stdout:setvbuf('no')

Jumping to errors

If there was an error during execution, you can use the F4 (next error) and SHIFT-F4 (previous error) to go through the errors that lua encountered.

See also





Retrieved from "https://www.love2d.org/w/index.php?title=Sublime_Text&oldid=27886"