BSL:BFW Scripting Language - Revision history

Iritscen: removed NOTOC directive

2025-12-26T18:59:48Z

removed __NOTOC__ directive

← Older revision		Revision as of 18:59, 26 December 2025
Line 2:		Line 2:

	Physically speaking, they are the .bsl files inside the [[IGMD\|Oni/GameDataFolder/IGMD/]] folder. Stored in plain-text format, scripts can be edited with any word-processing program, such as the built-in Notepad (Windows) or TextEdit (Mac); the only requirement is that you must use the suffix ".bsl" for scripts instead of ".txt" (in Windows, you may have to turn on the displaying of file extensions to see the suffix).		Physically speaking, they are the .bsl files inside the [[IGMD\|Oni/GameDataFolder/IGMD/]] folder. Stored in plain-text format, scripts can be edited with any word-processing program, such as the built-in Notepad (Windows) or TextEdit (Mac); the only requirement is that you must use the suffix ".bsl" for scripts instead of ".txt" (in Windows, you may have to turn on the displaying of file extensions to see the suffix).
	~~__NOTOC__~~
	==Getting started==		==Getting started==
	*You may wish to first read either the Introduction or the Manual page under {{SectionLink\|\|Knowledge base}}. The Introduction is a quick reference, whereas the Manual includes an introductory lesson on programming concepts. It also documents known bugs in BSL and fixes/workarounds when available.		*You may wish to first read either the Introduction or the Manual page under {{SectionLink\|\|Knowledge base}}. The Introduction is a quick reference, whereas the Manual includes an introductory lesson on programming concepts. It also documents known bugs in BSL and fixes/workarounds when available.

Iritscen: table-fied the kb and hid the incomplete pages; tweaked some wording in "Getting started"

2024-05-19T04:03:43Z

table-fied the kb and hid the incomplete pages; tweaked some wording in "Getting started"

← Older revision		Revision as of 04:03, 19 May 2024
Line 1:		Line 1:
	'''BungieFrameWork Scripting Language''' (simply called '''BSL''') is what Oni's level scripts are written in. Being a game scripting language, BSL is far more limited in scope and usage than a full programming language, as it was designed only to move events forward in the game, not to build complete programs. Specifically, BSL scripts are responsible for managing the player's objectives, directing AIs, creating environmental effects and choreographing cutscenes.		'''BungieFrameWork Scripting Language''' (simply called '''BSL''') is what Oni's level scripts are written in. Being a game scripting language, BSL is far more limited in scope and usage than a full programming language, as it was designed only to move events forward in the game, not to build complete programs. Specifically, BSL scripts are responsible for managing the player's objectives, directing AIs, creating environmental effects and choreographing cutscenes.

	Physically speaking, they are the .bsl files inside the [[IGMD\|Oni/GameDataFolder/IGMD/]] folder. ~~Being~~ in plain-text format, scripts can be edited with any word-processing program, such as the built-in Notepad (Windows) or TextEdit (Mac); the only requirement is that you must use the suffix ".bsl" for scripts instead of ".txt" (in Windows, you may have to turn on the displaying of file extensions to see the suffix).		Physically speaking, they are the .bsl files inside the [[IGMD\|Oni/GameDataFolder/IGMD/]] folder. Stored in plain-text format, scripts can be edited with any word-processing program, such as the built-in Notepad (Windows) or TextEdit (Mac); the only requirement is that you must use the suffix ".bsl" for scripts instead of ".txt" (in Windows, you may have to turn on the displaying of file extensions to see the suffix).
	__NOTOC__		__NOTOC__
	==Getting started==		==Getting started==
	*You may wish to first read either the Introduction or the Manual page under "Knowledge ~~database" below~~. The Introduction is a quick reference, whereas the Manual includes an introductory lesson on programming concepts. It also documents known bugs in BSL and fixes/workarounds when available.		*You may wish to first read either the Introduction or the Manual page under {{SectionLink\|\|Knowledge base}}. The Introduction is a quick reference, whereas the Manual includes an introductory lesson on programming concepts. It also documents known bugs in BSL and fixes/workarounds when available.
	*To learn BSL by example, you can read the .bsl files in the IGMD folder or look at some of the mods linked ~~below~~ and draw connections between the scripting commands and the resulting events in the game.		*For hands-on tutorials in writing BSL, see {{SectionLink\|\|Tutorials}}.
	*For a primer in writing BSL, see the "Tutorials" section below.		*To learn BSL by example, you can read the .bsl files in the IGMD folder or look at some of the mods linked from {{SectionLink\|\|Script mods}} and draw connections between the scripting commands and the resulting events in the game.

	==Script mods==		==Script mods==
Line 25:		Line 25:
	:A commentary explaining how an existing level's logic is scripted.		:A commentary explaining how an existing level's logic is scripted.

	==Knowledge ~~database~~==		==Knowledge base==
	*[[BSL:Introduction\|Introduction]]: A quick language reference, ideal for those with programming experience.		{\| class="wikitable"
	*[[BSL:Manual\|Manual]]: The complete language reference on BSL, with more explanations for newbies and details for power users.		\|-
	*[[BSL:Functions]] & [[BSL:Variables]]: All built-in functions and variables.		\|[[BSL:Introduction\|Introduction]]
	*[[BSL:Defunct]]: Apparently-obsolete commands.		\|A quick language reference, ideal for those with programming experience.
	*In-~~game IDs of~~ [http://ssg.oni2.net/subfold/charas/charas.htm ~~characters~~], [http://ssg.oni2.net/subfold/consoles/consoles.htm ~~consoles~~] ~~and~~ [http://ssg.oni2.net/subfold/doors/doors.htm ~~doors~~] (for ~~use in~~ scripts).		\|-
	*[[IGMD\|IGMD/]]: The directory structure of the game scripts.		\|[[BSL:Manual\|Manual]]
	*[[BSL:Snippets]]: Useful snippets of code.		\|The complete language reference on BSL, with more explanations for newbies and details for power users.
	*[[IGMD/global\|IGMD/global/]]: A global scripting folder which can be used for patching.		\|-
	*[[:Category:Scripting tasks]]: Scripting commands grouped by subject (unfinished).		\|[[BSL:Functions\|Functions]] & [[BSL:Variables\|Variables]]
	*[[BSL:List]]: List of all scripting commands (unfinished).		\|All of the engine's built-in functions and variables.
			\|-
			\|[[BSL:Defunct\|Defunct commands]]
			\|Apparently-obsolete commands.
			\|-
			\|[http://ssg.oni2.net/subfold/charas/charas.htm Characters], [http://ssg.oni2.net/subfold/consoles/consoles.htm Consoles] & [http://ssg.oni2.net/subfold/doors/doors.htm Doors]
			\|In-game IDs for each level of the game, useful when writing new scripts for those levels.
			\|-
			\|[[IGMD\|IGMD/]]
			\|The directory structure of the game scripts.
			\|-
			\|[[IGMD/global\|IGMD/global/]]
			\|A global scripting folder which can be used for patching.
			\|-
			\|[[BSL:Snippets\|Snippets]]
			\|Useful snippets of code.
			<!--\|-
			\|[[:Category:Scripting tasks\|Scripting tasks]]
			\|Scripting commands grouped by subject (unfinished).
			\|-
			\|[[BSL:List\|List of built-in commands]]
			\|List of all scripting commands (unfinished).-->
			\|}

	[[Category:BSL docs]]		[[Category:BSL docs]]

Iritscen: consistently noted which pages are unfinished

2024-05-18T20:42:51Z

consistently noted which pages are unfinished

← Older revision		Revision as of 20:42, 18 May 2024
Line 22:		Line 22:
	:Create completely new level logic from scratch.		:Create completely new level logic from scratch.

	;[[BSL:Tutorial/airport1_level_logic.bsl\|Commented level script from Ch. 4 Airport]]		;[[BSL:Tutorial/airport1_level_logic.bsl\|Commented level script from Ch. 4 Airport]] (unfinished)
	:A commentary explaining how an existing level's logic is scripted		:A commentary explaining how an existing level's logic is scripted.

	==Knowledge database==		==Knowledge database==
Line 34:		Line 34:
	*[[BSL:Snippets]]: Useful snippets of code.		*[[BSL:Snippets]]: Useful snippets of code.
	*[[IGMD/global\|IGMD/global/]]: A global scripting folder which can be used for patching.		*[[IGMD/global\|IGMD/global/]]: A global scripting folder which can be used for patching.
	*[[:Category:Scripting tasks]]: Scripting commands grouped by subject (~~work in progress~~).		*[[:Category:Scripting tasks]]: Scripting commands grouped by subject (unfinished).
	*[[BSL:List]]: List of all scripting commands (~~work in progress~~).		*[[BSL:List]]: List of all scripting commands (unfinished).

	[[Category:BSL docs]]		[[Category:BSL docs]]

Iritscen: it seems that we've never linked to the commented Airport BSL here, which is a bit surprising, but then again it is unfinished

2024-05-18T16:07:09Z

it seems that we've never linked to the commented Airport BSL here, which is a bit surprising, but then again it is unfinished

← Older revision		Revision as of 16:07, 18 May 2024
Line 21:		Line 21:
	;[[BSL:Tutorial/Scratch\|New logic from scratch]]		;[[BSL:Tutorial/Scratch\|New logic from scratch]]
	:Create completely new level logic from scratch.		:Create completely new level logic from scratch.

			;[[BSL:Tutorial/airport1_level_logic.bsl\|Commented level script from Ch. 4 Airport]]
			:A commentary explaining how an existing level's logic is scripted

	==Knowledge database==		==Knowledge database==

Iritscen: wording; removed deleted Modification page and moved IGMD/global to knowledge database as it isn't really a useful tutorial, just documentation of a niche feature

2023-05-06T02:38:55Z

wording; removed deleted Modification page and moved IGMD/global to knowledge database as it isn't really a useful tutorial, just documentation of a niche feature

← Older revision		Revision as of 02:38, 6 May 2023
Line 1:		Line 1:
	'''BungieFrameWork Scripting Language''' (simply called '''BSL''') is what Oni's level scripts are written in. Being a game scripting language, it is far more limited in scope and usage than a full programming language, as it was designed only to move events forward in the game, not to build complete programs. Specifically, BSL scripts are responsible for managing the player's objectives, directing AIs, creating environmental effects and choreographing cutscenes.		'''BungieFrameWork Scripting Language''' (simply called '''BSL''') is what Oni's level scripts are written in. Being a game scripting language, BSL is far more limited in scope and usage than a full programming language, as it was designed only to move events forward in the game, not to build complete programs. Specifically, BSL scripts are responsible for managing the player's objectives, directing AIs, creating environmental effects and choreographing cutscenes.

	Physically speaking, they are the .bsl files inside the [[IGMD\|Oni/GameDataFolder/IGMD/]] folder. Being in plain-text, scripts can be edited with any word-processing program, such as the built-in Notepad (Windows) or TextEdit (Mac); the only requirement is that you must use the suffix ".bsl" for scripts instead of ".txt" (in Windows, you may have to turn on the displaying of file extensions to see the suffix).		Physically speaking, they are the .bsl files inside the [[IGMD\|Oni/GameDataFolder/IGMD/]] folder. Being in plain-text format, scripts can be edited with any word-processing program, such as the built-in Notepad (Windows) or TextEdit (Mac); the only requirement is that you must use the suffix ".bsl" for scripts instead of ".txt" (in Windows, you may have to turn on the displaying of file extensions to see the suffix).
	__NOTOC__		__NOTOC__
	==Getting started==		==Getting started==
	*You may wish to first read either the Introduction or the Manual page under "Knowledge database" below. The Manual ~~page contains a broader introduction to~~ programming concepts. It also documents known bugs in BSL and fixes/workarounds when available.		*You may wish to first read either the Introduction or the Manual page under "Knowledge database" below. The Introduction is a quick reference, whereas the Manual includes an introductory lesson on programming concepts. It also documents known bugs in BSL and fixes/workarounds when available.
	*To learn BSL by example, you can read the .bsl files in the IGMD folder or look at some of the mods linked below and draw connections between the scripting commands and the resulting events in the game.		*To learn BSL by example, you can read the .bsl files in the IGMD folder or look at some of the mods linked below and draw connections between the scripting commands and the resulting events in the game.
	*For a primer in writing BSL, see the "Tutorials" section below.		*For a primer in writing BSL, see the "Tutorials" section below.

	==Script mods==		==Script mods==
	Script mods are great examples of what can be achieved simply by editing text files. They replace or add to Oni's .bsl files to spice up the gameplay and provide a more exciting experience to those who have finished the game. However, they can only change the way that game data is used; adding new characters or changing the layout of a level, for instance, would require editing the actual [[OBD\|game data]]. When new levels are created, these naturally require new scripts to be written from scratch to work with the assets and drive ~~the~~ events in them.		Script mods are great examples of what can be achieved simply by editing text files. They replace or add to Oni's .bsl files to spice up the gameplay and provide a more exciting experience to those who have finished the game. However, they can only change the way that game data is used; adding new characters or changing the layout of a level, for instance, would require editing the actual [[OBD\|game data]]. When new levels are created, these naturally require new scripts to be written from scratch to work with the assets and drive events in them.

	One ambitious example of a script mod is [[AE:OTA\|Oni Team Arena]]. Based on the desire for a [[multiplayer]] mode in Oni, and inspired by Unreal Tournament, OTA ~~augments Oni's combat with~~ a scoring system. Other script mods range from free-for-all arenas to objective-based missions and enhancements of the original levels. ~~Older scripts, which need to be placed manually in IGMD, can be found [http://your-mom.oni2.net/Downloads.htm here] and [[User:Script_10k#Incomplete_.2F_ancient_scripts\|here]].~~ Script mods packaged for use with the [[Anniversary Edition]] are [http://mods.oni2.net/mods/Script here], and totally new levels with their own BSL files can be ~~found~~ [http://mods.oni2.net/mods/New%20Level here] (these mods are meant to be installed through the AE Installer).		One ambitious example of a script mod is [[AE:OTA\|Oni Team Arena]]. Based on the desire for a [[multiplayer]] mode in Oni and inspired by Unreal Tournament, OTA creates a single-player "multiplayer experience" by adding bots and a scoring system. Other script mods range from free-for-all arenas to objective-based missions and enhancements of the original levels.

			Script mods packaged for use with the [[Anniversary Edition]] are [http://mods.oni2.net/mods/Script listed here], and totally new levels with their own BSL files can be [http://mods.oni2.net/mods/New%20Level found here] (these mods are meant to be installed through the AE Installer). Older scripts, which need to be placed manually in IGMD, can be found [http://your-mom.oni2.net/Downloads.htm here] and [[User:Script_10k#Incomplete_.2F_ancient_scripts\|here]].

	==Tutorials==		==Tutorials==
	;[[BSL:Tutorial/Console\|Playing with the developer console]]		;[[BSL:Tutorial/Console\|Playing with the developer console]]
	:The fastest way to start learning BSL is to ~~just~~ load the first level and open the dev console.		:The fastest way to start learning BSL is to load the first level and open the dev console.

	~~;[[BSL:Tutorial/Modification\|Original logic modification]]~~
	~~:There are lots of cool things to do by merely looking at the original scripts and changing a few parameters.~~

	~~;[[IGMD/global\|Global patching]]~~
	~~:Want to script a "patch" that's effective in every level?~~

	;[[BSL:Tutorial/Scratch\|New logic from scratch]]		;[[BSL:Tutorial/Scratch\|New logic from scratch]]
Line 27:		Line 23:

	==Knowledge database==		==Knowledge database==
	*[[BSL:Introduction\|Introduction]] (a quick reference, ideal for those with programming experience)		*[[BSL:Introduction\|Introduction]]: A quick language reference, ideal for those with programming experience.
	*[[BSL:Manual\|Manual]] ~~(the~~ complete reference on BSL, with more ~~details and~~ explanations for newbies)		*[[BSL:Manual\|Manual]]: The complete language reference on BSL, with more explanations for newbies and details for power users.
	*[[BSL:Functions]] & [[BSL:Variables]] ~~(all BSL~~ functions and variables)		*[[BSL:Functions]] & [[BSL:Variables]]: All built-in functions and variables.
	*[[BSL:Defunct]] ~~(seemingly~~-obsolete ~~BSL~~ commands)		*[[BSL:Defunct]]: Apparently-obsolete commands.
	*In-game IDs of [http://ssg.oni2.net/subfold/charas/charas.htm characters], [http://ssg.oni2.net/subfold/consoles/consoles.htm consoles] and [http://ssg.oni2.net/subfold/doors/doors.htm doors] (for use in scripts)		*In-game IDs of [http://ssg.oni2.net/subfold/charas/charas.htm characters], [http://ssg.oni2.net/subfold/consoles/consoles.htm consoles] and [http://ssg.oni2.net/subfold/doors/doors.htm doors] (for use in scripts).
	*[[IGMD\|~~Directory~~ structure of game scripts]]		*[[IGMD\|IGMD/]]: The directory structure of the game scripts.
	*[[BSL:Snippets\|Useful snippets of ~~BSL~~]]		*[[BSL:Snippets]]: Useful snippets of code.
	*[[:Category:Scripting tasks\|Scripting commands grouped by subject]] (work in progress)		*[[IGMD/global\|IGMD/global/]]: A global scripting folder which can be used for patching.
	*[[BSL:List\|List of all scripting commands]] (work in progress)		*[[:Category:Scripting tasks]]: Scripting commands grouped by subject (work in progress).
			*[[BSL:List]]: List of all scripting commands (work in progress).

	[[Category:BSL docs]]		[[Category:BSL docs]]

Iritscen: wording

2023-04-14T21:29:02Z

wording

← Older revision		Revision as of 21:29, 14 April 2023
Line 1:		Line 1:
	'''BungieFrameWork Scripting Language''' (simply called '''BSL''') is what Oni scripts are written in. Being a scripting language, it is far more limited in scope and usage than a ~~"real"~~ programming language, as it was designed only to move events forward in the game, not to build programs. ~~More specifically~~, BSL scripts are responsible for managing the player's objectives, directing AIs, creating environmental effects, and ~~driving~~ cutscenes.		'''BungieFrameWork Scripting Language''' (simply called '''BSL''') is what Oni's level scripts are written in. Being a game scripting language, it is far more limited in scope and usage than a full programming language, as it was designed only to move events forward in the game, not to build complete programs. Specifically, BSL scripts are responsible for managing the player's objectives, directing AIs, creating environmental effects and choreographing cutscenes.

	Physically speaking, they are the .bsl files inside the [[IGMD\|Oni/GameDataFolder/IGMD/]] folder. Being in plain-text, scripts can be edited with any word-processing program, such as the built-in Notepad (Windows) or TextEdit (Mac); the only requirement is that you must use the suffix ".bsl" for scripts instead of ".txt" (in Windows, you may have to turn on the displaying of file extensions to see the suffix).		Physically speaking, they are the .bsl files inside the [[IGMD\|Oni/GameDataFolder/IGMD/]] folder. Being in plain-text, scripts can be edited with any word-processing program, such as the built-in Notepad (Windows) or TextEdit (Mac); the only requirement is that you must use the suffix ".bsl" for scripts instead of ".txt" (in Windows, you may have to turn on the displaying of file extensions to see the suffix).
	__NOTOC__		__NOTOC__
	==Getting started==		==Getting started==
	*You may wish to first read either the "Introduction" or the "Manual" page under "Knowledge database" below. The ~~full~~ Manual page also documents known bugs in BSL, and fixes/workarounds when available.		*You may wish to first read either the Introduction or the Manual page under "Knowledge database" below. The Manual page contains a broader introduction to programming concepts. It also documents known bugs in BSL and fixes/workarounds when available.
	*To learn BSL by example, you can read the .bsl files in ~~Oni's~~ IGMD folder or look at the ~~"Scripted~~ mods~~" section~~ below, and draw connections between the scripting commands and the resulting events in the game.		*To learn BSL by example, you can read the .bsl files in the IGMD folder or look at some of the mods linked below and draw connections between the scripting commands and the resulting events in the game.
	*For a primer in writing BSL, see the "Tutorials" section below.		*For a primer in writing BSL, see the "Tutorials" section below.

	==~~Scripted~~ mods==		==Script mods==
	~~Scripted~~ mods are great examples of what can be achieved simply by editing text files. They replace or add to Oni's .bsl files to spice up the gameplay and provide a more exciting experience to those who have finished the game. However, they can only change the way that game data is used; adding new characters or changing the layout of a level, for instance, would require editing the actual [[OBD\|game data]]. When new levels are created ~~for Oni~~, these naturally require new scripts to be written from scratch to ~~take advantage of~~ the ~~new game~~ assets.		Script mods are great examples of what can be achieved simply by editing text files. They replace or add to Oni's .bsl files to spice up the gameplay and provide a more exciting experience to those who have finished the game. However, they can only change the way that game data is used; adding new characters or changing the layout of a level, for instance, would require editing the actual [[OBD\|game data]]. When new levels are created, these naturally require new scripts to be written from scratch to work with the assets and drive the events in them.

	One ambitious example of a ~~scripted~~ mod is [[AE:OTA\|Oni Team Arena]]. Based on the desire for a [[multiplayer]] mode in Oni, and inspired by Unreal Tournament, OTA augments Oni's ~~hand-to-hand~~ combat ~~and gunplay~~ with a scoring system ~~much like Unreal Tournament's Deathmatch mode~~. Other ~~scripted~~ mods range from free-for-all arenas to objective-based missions and enhancements of the original levels. ~~Scripted mods~~ can be found ~~[http://mods.oni2.net/mods/Script here],~~ [http://your-mom.oni2.net/Downloads.htm here] and [[User:Script_10k#Incomplete_.2F_ancient_scripts\|here]]. ~~New~~ levels, with their own BSL files, can be found [http://mods.oni2.net/mods/New%20Level here] (~~mod packages found on the Mod Depot~~ are meant to be installed through the [[AE]]).		One ambitious example of a script mod is [[AE:OTA\|Oni Team Arena]]. Based on the desire for a [[multiplayer]] mode in Oni, and inspired by Unreal Tournament, OTA augments Oni's combat with a scoring system. Other script mods range from free-for-all arenas to objective-based missions and enhancements of the original levels. Older scripts, which need to be placed manually in IGMD, can be found [http://your-mom.oni2.net/Downloads.htm here] and [[User:Script_10k#Incomplete_.2F_ancient_scripts\|here]]. Script mods packaged for use with the [[Anniversary Edition]] are [http://mods.oni2.net/mods/Script here], and totally new levels with their own BSL files can be found [http://mods.oni2.net/mods/New%20Level here] (these mods are meant to be installed through the AE Installer).

	==Tutorials==		==Tutorials==
Line 20:		Line 20:
	:There are lots of cool things to do by merely looking at the original scripts and changing a few parameters.		:There are lots of cool things to do by merely looking at the original scripts and changing a few parameters.

	;[[IGMD/global\|~~Patching~~]]		;[[IGMD/global\|Global patching]]
	:Want to script a "patch" that's effective in every level?		:Want to script a "patch" that's effective in every level?

Line 29:		Line 29:
	*[[BSL:Introduction\|Introduction]] (a quick reference, ideal for those with programming experience)		*[[BSL:Introduction\|Introduction]] (a quick reference, ideal for those with programming experience)
	*[[BSL:Manual\|Manual]] (the complete reference on BSL, with more details and explanations for newbies)		*[[BSL:Manual\|Manual]] (the complete reference on BSL, with more details and explanations for newbies)
	*[[BSL:Functions]], [[BSL:Variables]] (all BSL functions and variables)		*[[BSL:Functions]] & [[BSL:Variables]] (all BSL functions and variables)
	*[[BSL:Defunct]] (seemingly obsolete BSL commands)		*[[BSL:Defunct]] (seemingly-obsolete BSL commands)
	*~~References of in~~-game IDs of [http://ssg.oni2.net/subfold/charas/charas.htm ~~Characters~~], [http://ssg.oni2.net/subfold/consoles/consoles.htm ~~Consoles~~], and [http://ssg.oni2.net/subfold/doors/doors.htm ~~Doors~~] (~~which can be manipulated by~~ scripts)		*In-game IDs of [http://ssg.oni2.net/subfold/charas/charas.htm characters], [http://ssg.oni2.net/subfold/consoles/consoles.htm consoles] and [http://ssg.oni2.net/subfold/doors/doors.htm doors] (for use in scripts)
	*[[IGMD\|~~File documentation for~~ game scripts]]		*[[IGMD\|Directory structure of game scripts]]
	*[[BSL:Snippets\|Useful snippets of BSL]]		*[[BSL:Snippets\|Useful snippets of BSL]]
	*[[:Category:Scripting tasks\|Scripting commands grouped by subject]] (work in progress)		*[[:Category:Scripting tasks\|Scripting commands grouped by subject]] (work in progress)

Iritscen: /* Knowledge database */ adding BSL:Defunct, orphaned till now

2022-01-03T00:04:05Z

Knowledge database: adding BSL:Defunct, orphaned till now

← Older revision		Revision as of 00:04, 3 January 2022
Line 30:		Line 30:
	*[[BSL:Manual\|Manual]] (the complete reference on BSL, with more details and explanations for newbies)		*[[BSL:Manual\|Manual]] (the complete reference on BSL, with more details and explanations for newbies)
	*[[BSL:Functions]], [[BSL:Variables]] (all BSL functions and variables)		*[[BSL:Functions]], [[BSL:Variables]] (all BSL functions and variables)
			*[[BSL:Defunct]] (seemingly obsolete BSL commands)
	*References of in-game IDs of [http://ssg.oni2.net/subfold/charas/charas.htm Characters], [http://ssg.oni2.net/subfold/consoles/consoles.htm Consoles], and [http://ssg.oni2.net/subfold/doors/doors.htm Doors] (which can be manipulated by scripts)		*References of in-game IDs of [http://ssg.oni2.net/subfold/charas/charas.htm Characters], [http://ssg.oni2.net/subfold/consoles/consoles.htm Consoles], and [http://ssg.oni2.net/subfold/doors/doors.htm Doors] (which can be manipulated by scripts)
	*[[IGMD\|File documentation for game scripts]]		*[[IGMD\|File documentation for game scripts]]

Iritscen: link fixes

2021-04-05T01:31:40Z

link fixes

← Older revision		Revision as of 01:31, 5 April 2021
Line 1:		Line 1:
	'''~~[[Modding_Oni#Introduction_to_the_Oni_engine\|BFW]]~~ Scripting Language''' (simply called '''BSL''') is what Oni scripts are written in. Being a scripting language, it is far more limited in scope and usage than a "real" programming language, as it was designed only to move events forward in the game, not to build programs. More specifically, BSL scripts are responsible for managing the player's objectives, directing AIs, creating environmental effects, and driving cutscenes.		'''BungieFrameWork Scripting Language''' (simply called '''BSL''') is what Oni scripts are written in. Being a scripting language, it is far more limited in scope and usage than a "real" programming language, as it was designed only to move events forward in the game, not to build programs. More specifically, BSL scripts are responsible for managing the player's objectives, directing AIs, creating environmental effects, and driving cutscenes.

	Physically speaking, they are the .bsl files inside the [[IGMD\|Oni/GameDataFolder/IGMD/]] folder. Being in plain-text, scripts can be edited with any word-processing program, such as the built-in Notepad (Windows) or TextEdit (Mac); the only requirement is that you must use the suffix ".bsl" for scripts instead of ".txt" (in Windows, you may have to turn on the displaying of file extensions to see the suffix).		Physically speaking, they are the .bsl files inside the [[IGMD\|Oni/GameDataFolder/IGMD/]] folder. Being in plain-text, scripts can be edited with any word-processing program, such as the built-in Notepad (Windows) or TextEdit (Mac); the only requirement is that you must use the suffix ".bsl" for scripts instead of ".txt" (in Windows, you may have to turn on the displaying of file extensions to see the suffix).
Line 11:		Line 11:
	Scripted mods are great examples of what can be achieved simply by editing text files. They replace or add to Oni's .bsl files to spice up the gameplay and provide a more exciting experience to those who have finished the game. However, they can only change the way that game data is used; adding new characters or changing the layout of a level, for instance, would require editing the actual [[OBD\|game data]]. When new levels are created for Oni, these naturally require new scripts to be written from scratch to take advantage of the new game assets.		Scripted mods are great examples of what can be achieved simply by editing text files. They replace or add to Oni's .bsl files to spice up the gameplay and provide a more exciting experience to those who have finished the game. However, they can only change the way that game data is used; adding new characters or changing the layout of a level, for instance, would require editing the actual [[OBD\|game data]]. When new levels are created for Oni, these naturally require new scripts to be written from scratch to take advantage of the new game assets.

	One ambitious example of a scripted mod is [[AE:OTA\|Oni Team Arena]]. Based on the desire for a [[multiplayer]] mode in Oni, and inspired by Unreal Tournament, OTA augments Oni's hand-to-hand combat and gunplay with a scoring system much like Unreal Tournament's Deathmatch mode. Other scripted mods range from free-for-all arenas to objective-based missions and enhancements of the original levels. Scripted mods can be found [http://mods.oni2.net/mods/Script here], [http://your-mom.oni2.net/Downloads.htm here] and [[User:Script_10k#~~Minor_Scripts~~\|here]]. New levels, with their own BSL files, can be found [http://mods.oni2.net/mods/New%20Level here] (mod packages found on the Mod Depot are meant to be installed through the [[AE]]).		One ambitious example of a scripted mod is [[AE:OTA\|Oni Team Arena]]. Based on the desire for a [[multiplayer]] mode in Oni, and inspired by Unreal Tournament, OTA augments Oni's hand-to-hand combat and gunplay with a scoring system much like Unreal Tournament's Deathmatch mode. Other scripted mods range from free-for-all arenas to objective-based missions and enhancements of the original levels. Scripted mods can be found [http://mods.oni2.net/mods/Script here], [http://your-mom.oni2.net/Downloads.htm here] and [[User:Script_10k#Incomplete_.2F_ancient_scripts\|here]]. New levels, with their own BSL files, can be found [http://mods.oni2.net/mods/New%20Level here] (mod packages found on the Mod Depot are meant to be installed through the [[AE]]).

	==Tutorials==		==Tutorials==

Iritscen: no need for a separate Bugs page

2021-03-26T15:24:57Z

no need for a separate Bugs page

← Older revision		Revision as of 15:24, 26 March 2021
Line 4:		Line 4:
	__NOTOC__		__NOTOC__
	==Getting started==		==Getting started==
	*You may wish to first read either the "Introduction" or the "Manual" page under "Knowledge database" below.		*You may wish to first read either the "Introduction" or the "Manual" page under "Knowledge database" below. The full Manual page also documents known bugs in BSL, and fixes/workarounds when available.
	*To learn BSL by example, you can read the .bsl files in Oni's IGMD folder or look at the "Scripted mods" section below, and draw connections between the scripting commands and the resulting events in the game.		*To learn BSL by example, you can read the .bsl files in Oni's IGMD folder or look at the "Scripted mods" section below, and draw connections between the scripting commands and the resulting events in the game.
	*For a primer in writing BSL, see the "Tutorials" section below.		*For a primer in writing BSL, see the "Tutorials" section below.
	*For a list of known bugs (and fixes/workarounds when available), see [[BSL:Bugs\|HERE]].

	==Scripted mods==		==Scripted mods==

Iritscen: reorganizing items to put WIP stuff at bottom

2020-06-28T11:47:43Z

reorganizing items to put WIP stuff at bottom

← Older revision		Revision as of 11:47, 28 June 2020
Line 30:		Line 30:
	*[[BSL:Introduction\|Introduction]] (a quick reference, ideal for those with programming experience)		*[[BSL:Introduction\|Introduction]] (a quick reference, ideal for those with programming experience)
	*[[BSL:Manual\|Manual]] (the complete reference on BSL, with more details and explanations for newbies)		*[[BSL:Manual\|Manual]] (the complete reference on BSL, with more details and explanations for newbies)
			*[[BSL:Functions]], [[BSL:Variables]] (all BSL functions and variables)
			*References of in-game IDs of [http://ssg.oni2.net/subfold/charas/charas.htm Characters], [http://ssg.oni2.net/subfold/consoles/consoles.htm Consoles], and [http://ssg.oni2.net/subfold/doors/doors.htm Doors] (which can be manipulated by scripts)
			*[[IGMD\|File documentation for game scripts]]
			*[[BSL:Snippets\|Useful snippets of BSL]]
	*[[:Category:Scripting tasks\|Scripting commands grouped by subject]] (work in progress)		*[[:Category:Scripting tasks\|Scripting commands grouped by subject]] (work in progress)
	*[[BSL:List\|List of all scripting commands]] (work in progress)		*[[BSL:List\|List of all scripting commands]] (work in progress)
	*[[IGMD\|File documentation for game scripts]]
	*[[BSL:Snippets\|Useful snippets of BSL]]
	*[[BSL:Functions]], [[BSL: Variables]] Lists of all BSL functions and variables and what they do.
	* References of in-game IDs of [http://ssg.oni2.net/subfold/charas/charas.htm Characters], [http://ssg.oni2.net/subfold/consoles/consoles.htm Consoles], and [http://ssg.oni2.net/subfold/doors/doors.htm Doors], which can be manipulated by scripts.

	[[Category:BSL docs]]		[[Category:BSL docs]]

← Older revision		Revision as of 11:47, 28 June 2020
Line 30:		Line 30:
	*[[BSL:Introduction\|Introduction]] (a quick reference, ideal for those with programming experience)		*[[BSL:Introduction\|Introduction]] (a quick reference, ideal for those with programming experience)
	*[[BSL:Manual\|Manual]] (the complete reference on BSL, with more details and explanations for newbies)		*[[BSL:Manual\|Manual]] (the complete reference on BSL, with more details and explanations for newbies)
			*[[BSL:Functions]], [[BSL:Variables]] (all BSL functions and variables)
			*References of in-game IDs of [http://ssg.oni2.net/subfold/charas/charas.htm Characters], [http://ssg.oni2.net/subfold/consoles/consoles.htm Consoles], and [http://ssg.oni2.net/subfold/doors/doors.htm Doors] (which can be manipulated by scripts)
			*[[IGMD\|File documentation for game scripts]]
			*[[BSL:Snippets\|Useful snippets of BSL]]
	*[[:Category:Scripting tasks\|Scripting commands grouped by subject]] (work in progress)		*[[:Category:Scripting tasks\|Scripting commands grouped by subject]] (work in progress)
	*[[BSL:List\|List of all scripting commands]] (work in progress)		*[[BSL:List\|List of all scripting commands]] (work in progress)
	*[[IGMD\|File documentation for game scripts]]
	*[[BSL:Snippets\|Useful snippets of BSL]]
	*[[BSL:Functions]], [[BSL: Variables]] Lists of all BSL functions and variables and what they do.
	* References of in-game IDs of [http://ssg.oni2.net/subfold/charas/charas.htm Characters], [http://ssg.oni2.net/subfold/consoles/consoles.htm Consoles], and [http://ssg.oni2.net/subfold/doors/doors.htm Doors], which can be manipulated by scripts.

	[[Category:BSL docs]]		[[Category:BSL docs]]