SQF Bytecode - Revision history

Lou Montana: Fix CSS

2024-11-12T18:44:27Z

Fix CSS

← Older revision		Revision as of 20:44, 12 November 2024
Line 6:		Line 6:


	{\| class="wikitable valign-top" style="margin: auto; width: 80em"		{\| class="wikitable valign-top" style="margin: auto; max-width: 80em"
	\|+ Using bytecode as opposed to raw scripts		\|+ Using bytecode as opposed to raw scripts
	! style="width: 66%" \| Pros		! style="width: 66%" \| Pros

Lou Montana: Text replacement - "\[ (https?:\/\/[^ = ]+) +([^= ]+) \]" to "{{Link|$1|$2}}"

2023-04-28T14:11:36Z

Text replacement - "\[ *(https?:\/\/[^ = ]+) +([^= ]+) *\]" to "{{Link|$1|$2}}"

← Older revision		Revision as of 16:11, 28 April 2023
Line 22:		Line 22:
	== How to use SQF Bytecode ==		== How to use SQF Bytecode ==

	In order to use bytecode, a SQF script compiler is needed. See [https://github.com/dedmen/ArmaScriptCompiler Dedmen's Arma Script Compiler] for an example of an SQF compiler.		In order to use bytecode, a SQF script compiler is needed. See {{Link\|https://github.com/dedmen/ArmaScriptCompiler\|Dedmen's Arma Script Compiler}} for an example of an SQF compiler.


Line 28:		Line 28:
	# Mount the [[P drive]] (called "Mount the Project Drive" in [[Arma 3: Tools Installation\|Arma 3 Tools]])		# Mount the [[P drive]] (called "Mount the Project Drive" in [[Arma 3: Tools Installation\|Arma 3 Tools]])
	# Copy the script files into a folder on the P drive. They can be organized into sub-folders if needed.		# Copy the script files into a folder on the P drive. They can be organized into sub-folders if needed.
	# Download [https://github.com/dedmen/ArmaScriptCompiler/releases Arma Script Compiler] and extract the files into a folder.		# Download {{Link\|https://github.com/dedmen/ArmaScriptCompiler/releases\|Arma Script Compiler}} and extract the files into a folder.
	# Create a '''sqfc.json''' file next to the script compiler's executable file ('''ArmaScriptCompiler.exe''').		# Create a '''sqfc.json''' file next to the script compiler's executable file ('''ArmaScriptCompiler.exe''').
	# Edit the '''sqfc.json''' file according to the following template:<syntaxhighlight lang="json">		# Edit the '''sqfc.json''' file according to the following template:<syntaxhighlight lang="json">

Lou Montana: Some wiki formatting

2023-04-09T16:58:39Z

Some wiki formatting

← Older revision		Revision as of 18:58, 9 April 2023
Line 1:		Line 1:
	~~== What is~~ SQF ~~Bytecode? ==~~		An [[SQF Syntax\|SQF]] {{Link\|https://en.wikipedia.org/wiki/Bytecode\|bytecode}} is a file that contains the instructions to be executed in an SQF script.
	An SQF [https://en.wikipedia.org/wiki/Bytecode bytecode] is a file that contains the instructions to be executed in an SQF script. The bytecode is obtained after parsing the SQF script, which is written in a human-readable text-based file. Unlike an SQF script, SQF bytecode is not human-readable.		The bytecode is obtained after parsing the SQF script, which is written in a human-readable text-based file. Unlike an SQF script, SQF bytecode is not human-readable.

	As of {{arma}} 3 v2.04, it is possible to use SQF bytecode files (with .sqfc ~~format~~) as compilation sources of in-game scripts instead of normal .sqf scripts, using the [[compileScript]] command. The [[~~Arma_3~~:~~_Functions_Library~~\|Functions Library]] has also been modified to use this command.		As of {{arma}} 3 v2.04, it is possible to use SQF bytecode files (with the {{hl\|.sqfc}} extension) as compilation sources of in-game scripts instead of normal .sqf scripts, using the [[compileScript]] command.
			The [[Arma 3: Functions Library\|Functions Library]] has also been modified to use this command.

	~~== Bytecode Advantages ==~~
	~~Using bytecode, as opposed to raw scripts, has the following benefits:~~
	# Since the script is already parsed, parsing is skipped during compilation, which reduces compilation time. This improvement can be quite significant if the script uses [[PreProcessor_Commands\|preprocessor commands]].
	~~# Certain optimizations - that would take a long time to detect by the in-game compiler - can be detected and included in the bytecode, which improves execution performance.~~

	== ~~Bytecode Disadvantages~~ ==		{\| class="wikitable valign-top" style="margin: auto; width: 80em"
	A bytecode is not human-readable and thus cannot be easily modified.		\|+ Using bytecode as opposed to raw scripts
			! style="width: 66%" \| Pros
			! Cons
			\|-
			\| style="padding-right: 3em" \|

			* Since the script is already parsed, parsing is skipped during compilation, which reduces compilation time. This improvement can be quite significant if the script uses [[PreProcessor Commands]].
			* Certain optimisations - that would take a long time to detect by the in-game compiler - can be detected and included in the bytecode, which improves execution performance.
			\|
			* A bytecode is not human-readable and thus cannot be easily modified.
			\|}


	== How to use SQF Bytecode ==		== How to use SQF Bytecode ==

	In order to use bytecode, a SQF script compiler is needed. See [https://github.com/dedmen/ArmaScriptCompiler Dedmen's Arma Script Compiler] for an example of an SQF compiler.		In order to use bytecode, a SQF script compiler is needed. See [https://github.com/dedmen/ArmaScriptCompiler Dedmen's Arma Script Compiler] for an example of an SQF compiler.


	To compile an SQF script into SQF Bytecode using Arma Script Compiler:		To compile an SQF script into SQF Bytecode using Arma Script Compiler:
	# Mount the [[P drive]] (called "Mount the Project Drive" in [[~~Arma_3~~:~~_Tools_Installation~~\|Arma 3 Tools]])		# Mount the [[P drive]] (called "Mount the Project Drive" in [[Arma 3: Tools Installation\|Arma 3 Tools]])
	# Copy the script files into a folder on the P drive. They can be organized into sub-folders if needed.		# Copy the script files into a folder on the P drive. They can be organized into sub-folders if needed.
	# Download [https://github.com/dedmen/ArmaScriptCompiler/releases Arma Script Compiler] and extract the files into a folder.		# Download [https://github.com/dedmen/ArmaScriptCompiler/releases Arma Script Compiler] and extract the files into a folder.
Line 23:		Line 32:
	# Edit the '''sqfc.json''' file according to the following template:<syntaxhighlight lang="json">		# Edit the '''sqfc.json''' file according to the following template:<syntaxhighlight lang="json">
	{		{
	"inputDirs": [		"inputDirs": [
	"P:/folder1/",		"P:/folder1/",
	"P:/folder2/"		"P:/folder2/"
	],		],
	"includePaths": [		"includePaths": [
	"P:/"		"P:/"
	],		],
	"excludeList": [		"excludeList": [
	"subfolder1",		"subfolder1",
	"subfolder2",		"subfolder2",
	"subfolder3/subfolder4"		"subfolder3/subfolder4"
	],		],
	"outputDir": "P:/",		"outputDir": "P:/",
	"workerThreads": 8		"workerThreads": 8
	}		}
	</syntaxhighlight>		</syntaxhighlight>
	#* inputDirs: List of folders that should be searched for .sqf scripts. Search is performed recursively (sub-folders are searched as well)		#* inputDirs: List of folders that should be searched for .sqf scripts. Search is performed recursively (sub-folders are searched as well)
	#* includePaths: list of paths that contain the [[~~PreProcessor_Commands~~#.23include\|#include]]d files into the scripts. This should be set the same as the P drive path {{hl\|P:\}} to work correctly. If an external file is being [[~~PreProcessor_Commands~~#.23include\|#include]]d by the .sqf script, such as <syntaxhighlight lang="cpp" inline>#include "\a3\ui_f\hpp\definedikcodes.inc"</syntaxhighlight>, you need to create that file on the P drive, such as: {{hl\|P:\a3\ui_f\hpp\definedikcodes.inc}}		#* includePaths: list of paths that contain the [[PreProcessor Commands#.23include\|#include]]d files into the scripts. This should be set the same as the P drive path {{hl\|P:\}} to work correctly. If an external file is being [[PreProcessor Commands#.23include\|#include]]d by the .sqf script, such as <syntaxhighlight lang="cpp" inline>#include "\a3\ui_f\hpp\definedikcodes.inc"</syntaxhighlight>, you need to create that file on the P drive, such as: {{hl\|P:\a3\ui_f\hpp\definedikcodes.inc}}
	#* outputDir: Set this the same as P drive if you want the .sqfc files to be created next to each .sqf file.		#* outputDir: Set this the same as P drive if you want the .sqfc files to be created next to each .sqf file.
	#* excludeList: List of folders to be excluded from searching.		#* excludeList: List of folders to be excluded from searching.

R3vo: grammar

2022-09-03T09:22:23Z

grammar

← Older revision		Revision as of 11:22, 3 September 2022
Line 1:		Line 1:
	== What is SQF Bytecode? ==		== What is SQF Bytecode? ==
	An SQF [https://en.wikipedia.org/wiki/Bytecode bytecode] is a file that contains the instructions to be executed in an SQF script. The bytecode is obtained after parsing the SQF script, which is written in a human-readable text-based file. Unlike an SQF script, an SQF bytecode is not human-readable.		An SQF [https://en.wikipedia.org/wiki/Bytecode bytecode] is a file that contains the instructions to be executed in an SQF script. The bytecode is obtained after parsing the SQF script, which is written in a human-readable text-based file. Unlike an SQF script, SQF bytecode is not human-readable.

	As of {{arma}} 3 v2.04, it is possible to use SQF bytecode files (with .sqfc format) as compilation sources of in-game scripts instead of normal .sqf scripts, using the [[compileScript]] command. The [[Arma_3:_Functions_Library\|Functions Library]] has also been modified to use this command.		As of {{arma}} 3 v2.04, it is possible to use SQF bytecode files (with .sqfc format) as compilation sources of in-game scripts instead of normal .sqf scripts, using the [[compileScript]] command. The [[Arma_3:_Functions_Library\|Functions Library]] has also been modified to use this command.
Line 13:		Line 13:

	== How to use SQF Bytecode ==		== How to use SQF Bytecode ==
	In order to use bytecode, an SQF script compiler is needed. See [https://github.com/dedmen/ArmaScriptCompiler Dedmen's Arma Script Compiler] for an example of an SQF compiler.		In order to use bytecode, a SQF script compiler is needed. See [https://github.com/dedmen/ArmaScriptCompiler Dedmen's Arma Script Compiler] for an example of an SQF compiler.

Leopard20 at 11:53, 23 July 2022

2022-07-23T11:53:46Z

← Older revision		Revision as of 13:53, 23 July 2022
Line 20:		Line 20:
	# Copy the script files into a folder on the P drive. They can be organized into sub-folders if needed.		# Copy the script files into a folder on the P drive. They can be organized into sub-folders if needed.
	# Download [https://github.com/dedmen/ArmaScriptCompiler/releases Arma Script Compiler] and extract the files into a folder.		# Download [https://github.com/dedmen/ArmaScriptCompiler/releases Arma Script Compiler] and extract the files into a folder.
	# Create a '''sqfc.json''' file ~~in the same folder as where~~ the script compiler's executable file ~~is located~~.		# Create a '''sqfc.json''' file next to the script compiler's executable file ('''ArmaScriptCompiler.exe''').
	# Edit the '''sqfc.json''' file according to the following template:<syntaxhighlight lang="json">		# Edit the '''sqfc.json''' file according to the following template:<syntaxhighlight lang="json">
	{		{

Leopard20 at 11:50, 23 July 2022

2022-07-23T11:50:36Z

← Older revision		Revision as of 13:50, 23 July 2022
Line 17:		Line 17:

	To compile an SQF script into SQF Bytecode using Arma Script Compiler:		To compile an SQF script into SQF Bytecode using Arma Script Compiler:
	# Mount the [[P drive]]		# Mount the [[P drive]] (called "Mount the Project Drive" in [[Arma_3:_Tools_Installation\|Arma 3 Tools]])
	# Copy the script files into a folder on the P drive. They can be organized into sub-folders if needed.		# Copy the script files into a folder on the P drive. They can be organized into sub-folders if needed.
	# Download [https://github.com/dedmen/ArmaScriptCompiler/releases Arma Script Compiler] and extract the files into a folder.		# Download [https://github.com/dedmen/ArmaScriptCompiler/releases Arma Script Compiler] and extract the files into a folder.

Leopard20: minor typo

2022-07-23T11:37:36Z

minor typo

← Older revision		Revision as of 13:37, 23 July 2022
Line 40:		Line 40:
	</syntaxhighlight>		</syntaxhighlight>
	#* inputDirs: List of folders that should be searched for .sqf scripts. Search is performed recursively (sub-folders are searched as well)		#* inputDirs: List of folders that should be searched for .sqf scripts. Search is performed recursively (sub-folders are searched as well)
	#* includePaths: list of paths ~~that~~ that contain the [[PreProcessor_Commands#.23include\|#include]]d files into the scripts. This should be set the same as the P drive path {{hl\|P:\}} to work correctly. If an external file is being [[PreProcessor_Commands#.23include\|#include]]d by the .sqf script, such as <syntaxhighlight lang="cpp" inline>#include "\a3\ui_f\hpp\definedikcodes.inc"</syntaxhighlight>, you need to create that file on the P drive, such as: {{hl\|P:\a3\ui_f\hpp\definedikcodes.inc}}		#* includePaths: list of paths that contain the [[PreProcessor_Commands#.23include\|#include]]d files into the scripts. This should be set the same as the P drive path {{hl\|P:\}} to work correctly. If an external file is being [[PreProcessor_Commands#.23include\|#include]]d by the .sqf script, such as <syntaxhighlight lang="cpp" inline>#include "\a3\ui_f\hpp\definedikcodes.inc"</syntaxhighlight>, you need to create that file on the P drive, such as: {{hl\|P:\a3\ui_f\hpp\definedikcodes.inc}}
	#* outputDir: Set this the same as P drive if you want the .sqfc files to be created next to each .sqf file.		#* outputDir: Set this the same as P drive if you want the .sqfc files to be created next to each .sqf file.
	#* excludeList: List of folders to be excluded from searching.		#* excludeList: List of folders to be excluded from searching.

Leopard20: remove WIP

2022-07-15T11:16:48Z

remove WIP

← Older revision		Revision as of 13:16, 15 July 2022
Line 1:		Line 1:
	~~{{TOC\|side}}{{Wiki\|WIP}}~~
	== What is SQF Bytecode? ==		== What is SQF Bytecode? ==
	An SQF [https://en.wikipedia.org/wiki/Bytecode bytecode] is a file that contains the instructions to be executed in an SQF script. The bytecode is obtained after parsing the SQF script, which is written in a human-readable text-based file. Unlike an SQF script, an SQF bytecode is not human-readable.		An SQF [https://en.wikipedia.org/wiki/Bytecode bytecode] is a file that contains the instructions to be executed in an SQF script. The bytecode is obtained after parsing the SQF script, which is written in a human-readable text-based file. Unlike an SQF script, an SQF bytecode is not human-readable.

Lou Montana: Add category

2022-07-12T12:52:27Z

Add category

← Older revision		Revision as of 14:52, 12 July 2022
Line 18:		Line 18:

	To compile an SQF script into SQF Bytecode using Arma Script Compiler:		To compile an SQF script into SQF Bytecode using Arma Script Compiler:
	~~<ol>~~		# Mount the [[P drive]]
	~~<li>~~Mount the [[~~P_drive\|~~P drive]]~~</li>~~		# Copy the script files into a folder on the P drive. They can be organized into sub-folders if needed.
	~~<li>~~Copy the script files into a folder on the P drive. They can be organized into sub-folders if needed.~~</li>~~		# Download [https://github.com/dedmen/ArmaScriptCompiler/releases Arma Script Compiler] and extract the files into a folder.
	~~<li>~~Download [https://github.com/dedmen/ArmaScriptCompiler/releases Arma Script Compiler] and extract the files into a folder.~~</li>~~		# Create a '''sqfc.json''' file in the same folder as where the script compiler's executable file is located.
	~~<li>~~Create a '''sqfc.json''' file in the same folder as where the script compiler's executable file is located.~~</li>~~		# Edit the '''sqfc.json''' file according to the following template:<syntaxhighlight lang="json">
	~~<li>~~Edit the '''sqfc.json''' file according to the following template:
	<syntaxhighlight lang="json">
	{		{
	"inputDirs": [		"inputDirs": [
Line 42:		Line 40:
	}		}
	</syntaxhighlight>		</syntaxhighlight>
	* inputDirs: List of folders that should be searched for .sqf scripts. Search is performed recursively (sub-folders are searched as well)		#* inputDirs: List of folders that should be searched for .sqf scripts. Search is performed recursively (sub-folders are searched as well)
	* includePaths: list of paths that that contain the [[PreProcessor_Commands#.23include\|#include]]d files into the scripts. This should be set the same as the P drive path {{ic\|P:\}} to work correctly. If an external file is being [[PreProcessor_Commands#.23include\|#include]]d by the .sqf script, such as ~~{{ic\|~~#include "\a3\ui_f\hpp\definedikcodes.inc"}}, you need to create that file on the P drive, such as: {{ic\|P:\a3\ui_f\hpp\definedikcodes.inc}}		#* includePaths: list of paths that that contain the [[PreProcessor_Commands#.23include\|#include]]d files into the scripts. This should be set the same as the P drive path {{hl\|P:\}} to work correctly. If an external file is being [[PreProcessor_Commands#.23include\|#include]]d by the .sqf script, such as <syntaxhighlight lang="cpp" inline>#include "\a3\ui_f\hpp\definedikcodes.inc"</syntaxhighlight>, you need to create that file on the P drive, such as: {{hl\|P:\a3\ui_f\hpp\definedikcodes.inc}}
	* outputDir: Set this the same as P drive if you want the .sqfc files to be created next to each .sqf file.		#* outputDir: Set this the same as P drive if you want the .sqfc files to be created next to each .sqf file.
	* excludeList: List of folders to be excluded from searching.		#* excludeList: List of folders to be excluded from searching.
	* workerThreads: How many threads will compile the scripts. Each thread will compile one file at a time		#* workerThreads: How many threads will compile the scripts. Each thread will compile one file at a time
	~~</li>~~		# Execute '''ArmaScriptCompiler.exe'''. It will compile the scripts and create an '''.sqfc''' file next to each '''.sqf''' file.
	~~<li>~~Execute '''ArmaScriptCompiler.exe'''. It will compile the scripts and create an '''.sqfc''' file next to each '''.sqf''' file.~~</li>~~		# In order to use the bytecode as compilation source in the game, use the [[compileScript]] command, or the [[Arma_3:_Functions_Library\|Functions Library]].
	~~<li>~~In order to use the bytecode as compilation source in the game, use the [[compileScript]] command, or the [[Arma_3:_Functions_Library\|Functions Library]].~~</li>~~
	~~</ol>~~
			{{GameCategory\|arma3\|Editing}}

Leopard20 at 23:01, 6 April 2022

2022-04-06T23:01:12Z

← Older revision		Revision as of 01:01, 7 April 2022
Line 3:		Line 3:
	An SQF [https://en.wikipedia.org/wiki/Bytecode bytecode] is a file that contains the instructions to be executed in an SQF script. The bytecode is obtained after parsing the SQF script, which is written in a human-readable text-based file. Unlike an SQF script, an SQF bytecode is not human-readable.		An SQF [https://en.wikipedia.org/wiki/Bytecode bytecode] is a file that contains the instructions to be executed in an SQF script. The bytecode is obtained after parsing the SQF script, which is written in a human-readable text-based file. Unlike an SQF script, an SQF bytecode is not human-readable.

	As of {{arma}} 3 v2.04, it is possible to use SQF bytecode files (with .sqfc format) as compilation sources of in-game scripts instead of normal .sqf scripts, using the [[compileScript]] command. The [[Arma_3:_Functions_Library\|Functions Library]] has been modified to ~~also~~ use this command ~~internally~~.		As of {{arma}} 3 v2.04, it is possible to use SQF bytecode files (with .sqfc format) as compilation sources of in-game scripts instead of normal .sqf scripts, using the [[compileScript]] command. The [[Arma_3:_Functions_Library\|Functions Library]] has also been modified to use this command.

	== Bytecode Advantages ==		== Bytecode Advantages ==