User:Nosoop/Guide/Development Environments - Revision history

Nosoop: /* Visual Studio Code */

2022-11-22T04:39:11Z

‎Visual Studio Code

Nosoop: /* Syntax Highlighting */ Change github username

2021-04-11T05:02:48Z

‎Syntax Highlighting: Change github username

Nosoop: /* Visual Studio Code */ Add known extension

2021-04-11T05:01:31Z

‎Visual Studio Code: Add known extension

Nosoop: /* Sublime Text */ Note specific version requirements

2021-02-07T02:50:20Z

‎Sublime Text: Note specific version requirements

Nosoop: /* Sublime Text 3 */ Add download link for completions

2021-02-05T14:33:41Z

‎Sublime Text 3: Add download link for completions

Nosoop: Note that SPCode is the maintained successor to SPEdit

2020-09-24T06:02:02Z

Note that SPCode is the maintained successor to SPEdit

Nosoop: Nosoop moved page Nosoop/Guide/Development Environments to User:Nosoop/Guide/Development Environments: Meant to stick this in User page. oop

2020-05-01T11:37:31Z

Nosoop moved page Nosoop/Guide/Development Environments to User:Nosoop/Guide/Development Environments: Meant to stick this in User page. oop

Nosoop: Initial submit

2020-05-01T11:36:15Z

Initial submit

New page

Below are a number of editors suitable for editing SourceMod plugins in.

This page covers basic configuration and usage of each development environment. Configuration may involve third-party addons / extensions to the specific editor; such external packages are linked as options and are not endorsements over any other existing ones.

The environments are ordered alphabetically.

= BasicPawn =

[https://forums.alliedmods.net/showthread.php?t=289127 BasicPawn] is a Windows, Visual Basic .NET-based SourcePawn editor written by Timocop. There are reports that suggest it runs on Linux via Wine with .NET Framework 3.5.

== Compiling Plugins ==

TODO figure out how the compiler is installed and provide instructions on how to compile plugin

= Notepad++ =

[https://notepad-plus-plus.org/ Notepad++] is a free and open source Windows code editor that uses the Scintilla editor component.

== Compiling Plugins ==

Install NppExec through the ''Plugins → Plugins Admin'' menu option, and restart.

Navigate to ''Plugins → NppExec → Execute...'' or use <kbd>F6</kbd>, and copy the following code into the "Command(s)" text entry:

<pre>cd "$(CURRENT_DIRECTORY)"
"C:\spcomp\spcomp.exe" "$(FILE_NAME)" -i"include/" -v0
</pre>
Replace <code>"C:\spcomp\spcomp.exe"</code> with the location to <code>spcomp.exe</code> on your system, then save it.

<kbd>F6</kbd> will re-open the dialog. Press on "OK" to compile the plugin. <kbd>CTRL</kbd> + <kbd>F6</kbd> will execute the last run script, skipping the dialog.

The console will output the results of the compile without the header dialog (only warnings, errors, or successful compile message containing byte sizes). It will generate an <code>.smx</code> file with the same name as the plugin in the same directory.

== Syntax Highlighting ==

# Download <code>npp_docs_*.zip</code> from [https://github.com/raziEiL/SourceMod-Npp-Docs/releases raziEiL/SourceMod-Npp-Docs].
# Extract <code>sourcemod.xml</code> and move it into the <code>notepad++\plugins\APIs\</code> directory.
# Navigate to ''Language → Define your language...'' and open <code>userDefineLang.xml</code>. (TODO: Is this right?)

= SPEdit =

[https://forums.alliedmods.net/showthread.php?t=259917 SPEdit] is a Windows, C#-based SourcePawn editor written by _AeonOne_.

= Spider =

[https://spider.limetech.io/ Spider] is a web-based SourcePawn (and AMX Mod X) editor and compiler written by asherkin. It has a simple, one-file interface.

It's perfect for beginners that aren't invested enough into installing and configuring the entire toolchain on their local system. Once you get to working on multiple files or larger projects, you'll want to use a less ephemeral setup.

As of this writing, the <code>spcomp</code> built into Spider is at SourceMod 1.10 support; a number of newer language features may not be available yet.

== Compiling Plugins ==

Click on the "Compile" button in the sidebar at the right. If you only see a gray rectangle with a left-facing triangle, click on that to open the sidebar.

The textbox above the button will show the compiler log output.

On a successful compile, you can click "Download" to save the compiled plugin to your system. The green "play" button allows you to run plugins that use a very limited subset of natives without a game.

= Sublime Text 3 =

[https://www.sublimetext.com/ Sublime Text] is a shareware, cross-platform code editor.

== Syntax Highlighting ==

# Download the files in [https://github.com/404UNFca/SourcePawn-Syntax-Highlighting 404UNFca/SourcePawn-Syntax-Highlighting] by clicking on the green "Clone or download" button above the file listing.
# Install them in your Sublime Text user packages directory.

= Visual Studio Code =

[https://code.visualstudio.com/ Visual Studio Code] is a free and open source cross-platform code editor developed by Microsoft.

@@ Line 79: / Line 79: @@
 = Visual Studio Code =
-[https://code.visualstudio.com/ Visual Studio Code] is a free and open source cross-platform code editor developed by Microsoft.
+[https://code.visualstudio.com/ Visual Studio Code] is a free and open source cross-platform code editor developed by Microsoft.  However, the official installation does include non-free components; [https://vscodium.com/ VSCodium] is a third-party release without Microsoft's proprietary customizations.
-[https://github.com/Sarrus1/sourcepawn-vscode Sarrus1/sourcepawn-vscode] is an extension that provides SourcePawn highlighting and autocompletion.
+[https://github.com/Sarrus1/sourcepawn-vscode Sarrus's SourcePawn extension] provides an extensive list of features for SourceMod development, including SourcePawn highlighting and autocompletion.

@@ Line 68: / Line 68: @@
 The following package is intended for use with Sublime Text 3:
-# Download the files in [https://github.com/404UNFca/SourcePawn-Syntax-Highlighting 404UNFca/SourcePawn-Syntax-Highlighting] by clicking on the green &quot;Clone or download&quot; button above the file listing.
+# Download the files in [https://github.com/NiagaraDryGuy/SourcePawn-Syntax-Highlighting NiagaraDryGuy/SourcePawn-Syntax-Highlighting] by clicking on the green &quot;Clone or download&quot; button above the file listing.
 # Install them in your Sublime Text user packages directory.

← Older revision		Revision as of 05:01, 11 April 2021
Line 80:		Line 80:

	[https://code.visualstudio.com/ Visual Studio Code] is a free and open source cross-platform code editor developed by Microsoft.		[https://code.visualstudio.com/ Visual Studio Code] is a free and open source cross-platform code editor developed by Microsoft.
		+
		+	[https://github.com/Sarrus1/sourcepawn-vscode Sarrus1/sourcepawn-vscode] is an extension that provides SourcePawn highlighting and autocompletion.

@@ Line 60: / Line 60: @@
 On a successful compile, you can click &quot;Download&quot; to save the compiled plugin to your system. The green &quot;play&quot; button allows you to run plugins that use a very limited subset of natives without a game.
-= Sublime Text 3 =
+= Sublime Text =
 [https://www.sublimetext.com/ Sublime Text] is a shareware, cross-platform code editor.
 == Syntax Highlighting ==
 # Download the files in [https://github.com/404UNFca/SourcePawn-Syntax-Highlighting 404UNFca/SourcePawn-Syntax-Highlighting] by clicking on the green &quot;Clone or download&quot; button above the file listing.
@@ Line 70: / Line 72: @@
 == Completions ==
 # Refer to [https://github.com/JoinedSenses/sourcepawn_sublime_stuff/tree/wip/Packages/SourcePawn#installing the installation instructions for JoinedSenses/sourcepawn_sublime_stuff].  You may manually download the package or install it via package control.

@@ Line 38: / Line 38: @@
 # Navigate to ''Language → Define your language...'' and open <code>userDefineLang.xml</code>. (TODO: Is this right?)
-= SPEdit =
+= SPEdit / SPCode =
 [https://forums.alliedmods.net/showthread.php?t=259917 SPEdit] is a Windows, C#-based SourcePawn editor written by _AeonOne_.
 = Spider =

← Older revision	Revision as of 11:37, 1 May 2020
(No difference)