HPL3/Scripting/Scripting Guide/Setting up CodeLite - Revision history

TiMan: /* Launching the Game From CodeLite */

2020-08-14T23:42:41Z

Launching the Game From CodeLite

TiMan: /* Setting-up CodeLite */

2020-08-14T23:41:10Z

Setting-up CodeLite

TiMan at 12:17, 13 August 2020

2020-08-13T12:17:27Z

TiMan: TiMan moved page HPL3/Scripting/Setting up CodeLite to HPL3/Scripting/Scripting Guide/Setting up CodeLite

2020-08-13T11:44:07Z

TiMan moved page HPL3/Scripting/Setting up CodeLite to HPL3/Scripting/Scripting Guide/Setting up CodeLite

TiMan: /* Setting-up CodeLite */

2020-08-11T20:22:55Z

Setting-up CodeLite

TiMan: /* Launching the Game From CodeLite */

2020-08-08T19:13:47Z

Launching the Game From CodeLite

TiMan: /* CodeLite - Introduction */

2020-08-08T19:12:52Z

CodeLite - Introduction

TiMan at 19:08, 8 August 2020

2020-08-08T19:08:36Z

TiMan at 19:08, 8 August 2020

2020-08-08T19:08:06Z

TiMan: Undo revision 4010 by TiMan (talk)

2020-08-08T18:36:58Z

Undo revision 4010 by TiMan (talk)

@@ Line 63: / Line 63: @@
 [[File:Codelite custom build.png|thumb|SOMA workspace with custom build command (click to view full size).|alt=|left]] {{clr}}
-For more information about available commands, visit the [[HPL3/SOMA/Modding/Developer Commands|Developer Commands]] article.
+For more information about available commands, visit the [[HPL3/Developer_Commands|Developer Commands]] article.
 '''Now, all you need to do is to press F7, and the game will run!'''

@@ Line 24: / Line 24: @@
 #[[CodeLite#Optimized_Color_Theme|Download the optimized color theme]]
-#[https://downloads.codelite.org/ReleaseArchive.php Download CodeLite version 12.0.0.]
+#[https://downloads.codelite.org/ReleaseArchive.php Download and install CodeLite version 12.0.0.]
 #'''Launch CodeLite and configure:'''
 ##<code>Settings → Code Completion → General</code>:

@@ Line 73: / Line 73: @@
 *Parameters with <code>&in</code> might break the coloring of function parameters, but will have no other side-effects.
-{{NavBar|HPL3/Scripting/What is scripting in HPL3?|What is scripting in HPL3?|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting Workflow and Structure|Scripting Workflow and Structure}}
+{{NavBar|HPL3/Scripting/Scripting_Guide/What is scripting in HPL3?|What is scripting in HPL3?|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Scripting Workflow and Structure|Scripting Workflow and Structure}}
 [[Category:HPL3 Scripting]]
 [[Category:English]]

← Older revision		Revision as of 20:22, 11 August 2020
Line 47:		Line 47:

	{{note\|If the list disappears, you can make it re-appear again by pressing <code>ctrl-space</code>. If you want to bring up hints when inside the () of a function, press <code>ctrl-shift-space</code>.}}		{{note\|If the list disappears, you can make it re-appear again by pressing <code>ctrl-space</code>. If you want to bring up hints when inside the () of a function, press <code>ctrl-shift-space</code>.}}
		+	<br>
		+	{{warning\|CodeLite won't update automatically the location of workspace files. If you moved them outside of CodeLite, you will need to re-add them. The same goes for creating new file after setting up a workspace}}

	==Launching the Game From CodeLite==		==Launching the Game From CodeLite==

← Older revision		Revision as of 19:13, 8 August 2020
Line 62:		Line 62:

	For more information about available commands, visit the [[HPL3/SOMA/Modding/Developer Commands\|Developer Commands]] article.		For more information about available commands, visit the [[HPL3/SOMA/Modding/Developer Commands\|Developer Commands]] article.
		+
		+	'''Now, all you need to do is to press F7, and the game will run!'''

	==Issues & Info==		==Issues & Info==

@@ Line 4: / Line 4: @@
 ==CodeLite - Introduction==
-As mentioned Scripting in HPL3 can look a lot like regular programming, but less complicated.
+As mentioned, scripting in HPL3 can look a lot like regular programming, but less complicated.
 Because of that, we need tools that will be able to aid us when we write our code. For HPL2, Notepad++ or even Notepad were enough for that. This time around, something more powerful is needed.

← Older revision		Revision as of 19:08, 8 August 2020
Line 47:		Line 47:

	{{note\|If the list disappears, you can make it re-appear again by pressing <code>ctrl-space</code>. If you want to bring up hints when inside the () of a function, press <code>ctrl-shift-space</code>.}}		{{note\|If the list disappears, you can make it re-appear again by pressing <code>ctrl-space</code>. If you want to bring up hints when inside the () of a function, press <code>ctrl-shift-space</code>.}}
		+
		+	==Launching the Game From CodeLite==
		+
		+	One additional thing you can do is to launch the game or your mod in dev mode through CodeLite itself.
		+
		+	To do this, right click on your project and go to settings. Then Click on <code>Customize → Custom Build</code>.
		+	Turn on <code>Enable Custom Build</code>. In the working directory, select the game folder.
		+
		+	Now you will need to add the command that launches the game or the mod. For example, a command that launches the main game of SOMA in dev mode will look like this:
		+	<pre>Soma.exe -user Dev -cfg config/main_init_dev.cfg</pre>
		+
		+	Add the command to the <code>Build</code> section in the table.
		+	[[File:Codelite custom build.png\|thumb\|SOMA workspace with custom build command (click to view full size).\|alt=\|left]] {{clr}}
		+
		+	For more information about available commands, visit the [[HPL3/SOMA/Modding/Developer Commands\|Developer Commands]] article.

	==Issues & Info==		==Issues & Info==

@@ Line 26: / Line 26: @@
 #[https://downloads.codelite.org/ReleaseArchive.php Download CodeLite version 12.0.0.]
 #'''Launch CodeLite and configure:'''
-##<span style="font-family: monospace,monospace;">'''Settings → Code Completion → General'''</span>:
+##<code>Settings → Code Completion → General</code>:
-##*Add <span style="font-family: monospace,monospace;">''';*.hps'''</span> at the end of the <span style="font-family: monospace,monospace;">'''Additional file extensions to parse'''</span> list.
+##*Add <code>;*.hps</code> at the end of the <code>Additional file extensions to parse</code> list.
-##*Enable <span style="font-family: monospace,monospace;">'''Keep function signature un-formatted'''</span>.
+##*Enable <code>Keep function signature un-formatted.</code>
-##*Enable <span style="font-family: monospace,monospace;">Re-parse on workspace loaded<span>.
+##*Enable  <code>Re-parse on workspace loaded</code>.
-##<span style="font-family: monospace,monospace;">Settings → Code Completion → Colouring<span>: Enable <span style="font-family: monospace,monospace;">Apply context aware colouring<span>.
+##<code>Settings → Code Completion → Colouring</code>: Enable <code>Apply context aware colouring</code>.
-##<span style="font-family: monospace,monospace;">Settings → Code Completion → CTags → Search Paths<span>: Click <span style="font-family: monospace,monospace;">Add...<span>, navigate to the game folder and select the <span style="font-family: monospace,monospace;">script<span> folder.
+##<code>Settings → Code Completion → CTags → Search Paths</code>: Click <code>Add...</code>, navigate to the game folder and select the <code>script</code> folder.
-##<span style="font-family: monospace,monospace;">Settings → Colours and Fonts...<span>: Click on <span style="font-family: monospace,monospace;">Import settings from a zip archive<span> and select the <span style="font-family: monospace,monospace;">CodeLiteColorSettings.zip<span> file.
+##<code>Settings → Colours and Fonts...</code>: Click on <code>Import settings from a zip archive</code> and select the <code>CodeLiteColorSettings.zip</code> file.
 ##Configure the rest of CodeLite to your liking.
-#'''Create a new workspace:''' Create a folder inside your game directory and name it <span style="font-family: monospace,monospace;">_src<span>. Go to the <span style="font-family: monospace,monospace;">Workspace<span> menu and click on <span style="font-family: monospace,monospace;">New Workspace...<span>. Save the workspace inside the <span style="font-family: monospace,monospace;">_src<span> folder.
+#'''Create a new workspace:''' Create a folder inside your game directory and name it <code>_src</code>. Go to the <code>Workspace</code> menu and click on <code>New Workspace...</code>. Save the workspace inside the <code>_src</code> folder.
-#'''Create a new project:''' <span style="font-family: monospace,monospace;">Right click on the workspace → New → New Project<span>. Select <span style="font-family: monospace,monospace;">Others → Non-code project<span>. Give the project a name (For example: "soma"). Leave the rest as default.
+#'''Create a new project:''' <code>Right click on the workspace → New → New Project</code>. Select <code>Others → Non-code project</code>. Give the project a name (For example: "soma"). Leave the rest as default.
-#'''Add a folder to the project:''' Right-click on the project and choose <span style="font-family: monospace,monospace;">New Virtual Folder<span>. Name it <span style="font-family: monospace,monospace;">_api<span>.
+#'''Add a folder to the project:''' Right-click on the project and choose <code>New Virtual Folder</code>. Name it <code>_api</code>.
 #'''Add the game script files:'''
-##Right-click on <span style="font-family: monospace,monospace;">_api → Add An Existing File...<span>, add the file <span style="font-family: monospace,monospace;">hps_api.hps<span> from the game folder (If the file does not appear in your game folder, launch the game, and the file will appear).
+##Right-click on <code>_api → Add An Existing File...</code>, add the file <code>hps_api.hps</code> from the game folder (If the file does not appear in your game folder, launch the game, and the file will appear).
-##Right-click on the project and choose <span style="font-family: monospace,monospace;">Import Files From Directory<span>. Navigate to the game folder and select it. In the next window, check the boxes for the folders: <span style="font-family: monospace,monospace;">maps, script, mods<span> and click ok.
+##Right-click on the project and choose <code>Import Files From Directory</code>. Navigate to the game folder and select it. In the next window, check the boxes for the folders: <code>maps, script, mods</code> and click ok.
-'''Lastly, go to <span style="font-family: monospace,monospace;">Workspace<span> and click on <span style="font-family: monospace,monospace;">Parse Workspace<span>.'''
+'''Lastly, go to <code>Workspace</code> and click on <code>Parse Workspace</code>.'''
 That should be it, you should now have three top folders in your project and a lot of sub-folders with various script files.
@@ Line 47: / Line 47: @@
 {{note|If the list disappears, you can make it re-appear again by pressing <code>ctrl-space</code>. If you want to bring up hints when inside the () of a function, press <code>ctrl-shift-space</code>.}}
 ==Issues & Info==