Introduction to modding - Revision history

Iritscen: moved Engine terminology link to more logical place; linked to Oni (folder)/GameDataFolder instead of Oni (folder)

2026-04-06T00:50:25Z

moved Engine terminology link to more logical place; linked to Oni (folder)/GameDataFolder instead of Oni (folder)

Iritscen: added Engine terminology link; removed some unneeded WP links that are found on that page now; removed two links to OCF tutorials – one is found on Importing character models, which is already linked here, and the other link has been added to an "integrate" note on Importing character models

2025-12-03T23:58:43Z

added Engine terminology link; removed some unneeded WP links that are found on that page now; removed two links to OCF tutorials – one is found on Importing character models, which is already linked here, and the other link has been added to an "integrate" note on Importing character models

← Older revision		Revision as of 23:58, 3 December 2025
Line 1:		Line 1:
	{{integrate\|The tutorials are called "Creating the Lair" and "Adding character classes".}}		{{integrate\|The tutorials are called "Creating the Lair" and "Adding character classes".\|plural=yes}}
	This page provides an introduction to modding that does not assume that you have prior modding experience or knowledge of the Oni engine. Links to more technical parts of the wiki are interspersed below or can be accessed directly from the wiki's Main Page.		This page provides an introduction to modding that does not assume that you have prior modding experience or knowledge of the Oni engine. Links to more technical parts of the wiki are interspersed below or can be accessed directly from the wiki's Main Page.
	{{TOClimit}}		{{TOClimit}}

	==What is modding?==		==What is modding?==
	[[Image:No easy button.png\|150px\|right]]		[[Image:No easy button.png\|150px\|right]]
Line 14:		Line 13:

	==What engine does Oni run on?==		==What engine does Oni run on?==
	Oni runs on a custom engine that could be built for Windows, the Macintosh and the PlayStation 2 (console games are not easily modded, so we don't work with the PS2 version of Oni). The engine consists of various subsystems, some of which have colorful animé-related names like ~~[[wp:~~Akira~~\|Akira]]~~ (environment), ~~[[wp:~~Motoko ~~Kusanagi\|Motoko]]~~ (graphics) and ~~[[wp:My Neighbor Totoro\|~~Totoro]] (animation).		Oni runs on a custom engine that could be built for Windows, the Macintosh and the PlayStation 2 (console games are not easily modded, so we don't work with the PS2 version of Oni). The engine consists of various subsystems, some of which have colorful animé-related names like Akira (environment), Motoko (graphics) and Totoro (animation).

	Unfortunately, the game was rushed to completion during a change of ownership, and it was not possible for the developers to release any tools or information to aid the fans in modding. Thus, fans had to explore the wild jungle of the raw game data and create modding tools through reverse-engineering. It took over seven years to unlock most of the game's secrets, but we can now mod almost all types of data effectively, allowing us to create entirely new levels and characters.		Unfortunately, the game was rushed to completion during a change of ownership, and it was not possible for the developers to release any tools or information to aid the fans in modding. Thus, fans had to explore the wild jungle of the raw game data and create modding tools through reverse-engineering. It took over seven years to unlock most of the game's secrets, but we can now mod almost all types of data effectively, allowing us to create entirely new levels and characters.
Line 30:		Line 29:

	* Go to [[Oni (folder)]] for information on each file, or;		* Go to [[Oni (folder)]] for information on each file, or;
	* Go to [[Game data terminology]] to learn the ~~precise~~ terms for Oni's data, or;		* Go to [[Engine terminology]] and [[Game data terminology]] to learn the community's terms for Oni's engine and data, or;
	* Continue reading to learn the general process of modding.		* Continue reading to learn the general process of modding.

Line 74:		Line 73:
	Levels are usually built in [[SketchUp tutorials and tips\|SketchUp]]. The open-source 3D modeler [[Blender]] can be used for levels, objects, characters and animations. Formerly we preferred to do that work in the discontinued [[Mod Tool]], but the community's support for Blender has continued to improve and it is now our modeler of choice.		Levels are usually built in [[SketchUp tutorials and tips\|SketchUp]]. The open-source 3D modeler [[Blender]] can be used for levels, objects, characters and animations. Formerly we preferred to do that work in the discontinued [[Mod Tool]], but the community's support for Blender has continued to improve and it is now our modeler of choice.

	* Tutorial: [~~http://oni.bungie.org/forum/viewtopic.php?id=2087~~ Creating ~~the Lair~~]		* Tutorial: [[Creating a level]]
	* Tutorial: [[Authoring custom camera animations]]		* Tutorial: [[Authoring custom camera animations]]

Line 92:		Line 91:
	A character's attributes are defined by their character class file which links also to the animation list that defines their moveset. The high modularity of character data allows Oni to share many resources between characters (especially animation collections and particles).		A character's attributes are defined by their character class file which links also to the animation list that defines their moveset. The high modularity of character data allows Oni to share many resources between characters (especially animation collections and particles).

	* Tutorial: [http://oni.bungie.org/forum/viewtopic.php?id=2423 Adding character classes]
	* Tutorial: [[Importing character models]]		* Tutorial: [[Importing character models]]
	* Tutorial: [[OBD talk:TRAM\|Tweaking an individual animation]]		* Tutorial: [[OBD talk:TRAM\|Tweaking an individual animation]]

Iritscen: changed Update template to new Integrate template

2025-11-26T19:08:15Z

changed Update template to new Integrate template

← Older revision		Revision as of 19:08, 26 November 2025
Line 1:		Line 1:
	{{~~update~~\|~~This article contains links to~~ the ~~now defunct Oni Central Forum~~. ~~Sections: Modding Resources -> Tutorial Lair, Tutorial Character Classes~~}}		{{integrate\|The tutorials are called "Creating the Lair" and "Adding character classes".}}
	This page provides an introduction to modding that does not assume that you have prior modding experience or knowledge of the Oni engine. Links to more technical parts of the wiki are interspersed below or can be accessed directly from the wiki's Main Page.		This page provides an introduction to modding that does not assume that you have prior modding experience or knowledge of the Oni engine. Links to more technical parts of the wiki are interspersed below or can be accessed directly from the wiki's Main Page.
	{{TOClimit}}		{{TOClimit}}

Iritscen: added links to clarify that it's not vanilla Oni which supports these texture sizes

2025-11-25T16:38:01Z

added links to clarify that it's not vanilla Oni which supports these texture sizes

← Older revision		Revision as of 16:38, 25 November 2025
Line 80:		Line 80:
	Modders have their own preferred bitmap editors for changing/creating textures. On one end of the scale are expensive programs such as Photoshop, and on the other end are free editors like [https://www.gimp.org/ Gimp] and [https://www.getpaint.net/ Paint.NET].		Modders have their own preferred bitmap editors for changing/creating textures. On one end of the scale are expensive programs such as Photoshop, and on the other end are free editors like [https://www.gimp.org/ Gimp] and [https://www.getpaint.net/ Paint.NET].

	Textures always have dimensions of "power of 2": typically 32, 64, 128 or 256 pixels on a side. Mac Oni supports a maximum of 1024x1024 textures. Windows Oni supports textures up to 512x512.		Textures always have dimensions of "power of 2": typically 32, 64, 128 or 256 pixels on a side. [[FERAL\|Mac Oni]] supports a maximum of 1024x1024 textures. Windows Oni (with [[Daodan DLL\|fan patch]]) supports textures up to 512x512.

	These textures can be static, animated, transparent or have a reflection map (usually used for armor). Splashscreens (chapter start screens), win-level and lose-level screens are actually composite images made up of smaller textures due to Oni's limitation in texture size.		These textures can be static, animated, transparent or have a reflection map (usually used for armor). Splashscreens (chapter start screens), win-level and lose-level screens are actually composite images made up of smaller textures due to Oni's limitation in texture size.

Iritscen: link fix

2025-05-09T19:11:56Z

link fix

← Older revision		Revision as of 19:11, 9 May 2025
Line 95:		Line 95:
	* Tutorial: [[Importing character models]]		* Tutorial: [[Importing character models]]
	* Tutorial: [[OBD talk:TRAM\|Tweaking an individual animation]]		* Tutorial: [[OBD talk:TRAM\|Tweaking an individual animation]]
	* Tutorial: [[Adding spawnable characters\|Adding spawnable characters to a level]]		* Tutorial: [[XML:Adding spawnable characters\|Adding spawnable characters to a level]]

	====Weapons====		====Weapons====

Iritscen: minor wording, link tweak

2025-03-12T01:55:11Z

minor wording, link tweak

← Older revision		Revision as of 01:55, 12 March 2025
Line 72:		Line 72:

	====Environments====		====Environments====
	Levels are usually built in [[SketchUp tutorials and tips\|SketchUp]]. The open-source ~~tool~~ [[Blender]] can be used for levels, objects, characters and animations. Formerly we preferred to do that work in [[Mod Tool]], but the community's support for Blender has continued to improve and it is now our modeler of choice.		Levels are usually built in [[SketchUp tutorials and tips\|SketchUp]]. The open-source 3D modeler [[Blender]] can be used for levels, objects, characters and animations. Formerly we preferred to do that work in the discontinued [[Mod Tool]], but the community's support for Blender has continued to improve and it is now our modeler of choice.

	* Tutorial: [http://oni.bungie.org/forum/viewtopic.php?id=2087 Creating the Lair]		* Tutorial: [http://oni.bungie.org/forum/viewtopic.php?id=2087 Creating the Lair]
Line 101:		Line 101:

	====Text====		====Text====
	The text-based resource types are fairly easy to edit as long as you don't get confused by the IDs which they use to link to each other. The main textual resources are the pages you can view in the [[Data Comlink]] and the consoles you read in-game. The textual resource types are listed here: [[OBD:File types/Interface#List]].		The text-based resource types are fairly easy to edit as long as you don't get confused by the IDs which they use to link to each other. The main textual resources are the pages you can view in the [[Data Comlink]] and the consoles you read in-game. The textual resource types are listed here: {{SectionLink\|OBD:File types/Interface\|List}}.

	====Sound and music====		====Sound and music====

Vortice: Update notice w/ summary

2025-01-22T19:35:32Z

Update notice w/ summary

← Older revision		Revision as of 19:35, 22 January 2025
Line 1:		Line 1:
			{{update\|This article contains links to the now defunct Oni Central Forum. Sections: Modding Resources -> Tutorial Lair, Tutorial Character Classes}}
	This page provides an introduction to modding that does not assume that you have prior modding experience or knowledge of the Oni engine. Links to more technical parts of the wiki are interspersed below or can be accessed directly from the wiki's Main Page.		This page provides an introduction to modding that does not assume that you have prior modding experience or knowledge of the Oni engine. Links to more technical parts of the wiki are interspersed below or can be accessed directly from the wiki's Main Page.
	{{TOClimit}}		{{TOClimit}}

Iritscen: /* Text */ correction, it's not at the top anymore

2024-10-21T22:23:01Z

Text: correction, it's not at the top anymore

← Older revision		Revision as of 22:23, 21 October 2024
Line 100:		Line 100:

	====Text====		====Text====
	The text-based resource types are fairly easy to edit as long as you don't get confused by the IDs which they use to link to each other. The main textual resources are the pages you can view in the [[Data Comlink]] and the consoles you read in-game. The ~~specific~~ resource types are listed ~~at the top of the~~ [[OBD:File types/Interface]] ~~page~~.		The text-based resource types are fairly easy to edit as long as you don't get confused by the IDs which they use to link to each other. The main textual resources are the pages you can view in the [[Data Comlink]] and the consoles you read in-game. The textual resource types are listed here: [[OBD:File types/Interface#List]].

	====Sound and music====		====Sound and music====

Iritscen: wording

2024-05-15T03:38:50Z

wording

← Older revision		Revision as of 03:38, 15 May 2024
Line 79:		Line 79:
	Modders have their own preferred bitmap editors for changing/creating textures. On one end of the scale are expensive programs such as Photoshop, and on the other end are free editors like [https://www.gimp.org/ Gimp] and [https://www.getpaint.net/ Paint.NET].		Modders have their own preferred bitmap editors for changing/creating textures. On one end of the scale are expensive programs such as Photoshop, and on the other end are free editors like [https://www.gimp.org/ Gimp] and [https://www.getpaint.net/ Paint.NET].

	Textures have dimensions ~~always~~ of "power of 2": typically 32, 64, 128 or 256 pixels on a side. Mac Oni supports a maximum of 1024x1024 textures. Windows Oni supports textures up to 512x512.		Textures always have dimensions of "power of 2": typically 32, 64, 128 or 256 pixels on a side. Mac Oni supports a maximum of 1024x1024 textures. Windows Oni supports textures up to 512x512.

	These textures can be static, animated, transparent or have a reflection map (usually used for armor). ~~Splash screens~~ (chapter start screens), win-level and lose-level screens are actually composite images made up of smaller textures due to Oni's limitation in texture size.		These textures can be static, animated, transparent or have a reflection map (usually used for armor). Splashscreens (chapter start screens), win-level and lose-level screens are actually composite images made up of smaller textures due to Oni's limitation in texture size.

	* Tutorial: [[Modifying textures]]		* Tutorial: [[Modifying textures]]

Iritscen: /* Text */ specific tag codes be gone

2023-12-06T16:09:21Z

Text: specific tag codes be gone

← Older revision		Revision as of 16:09, 6 December 2023
Line 100:		Line 100:

	====Text====		====Text====
	The text-based resource types are fairly easy to edit as long as you don't get confused by the IDs which they use to link to each other.		The text-based resource types are fairly easy to edit as long as you don't get confused by the IDs which they use to link to each other. The main textual resources are the pages you can view in the [[Data Comlink]] and the consoles you read in-game. The specific resource types are listed at the top of the [[OBD:File types/Interface]] page.

	The ~~text-related resource types~~ are:
	* [[~~XML:DPge~~]] ~~(Diary page)~~
	* [[~~XML~~:~~HPge~~]] ~~(Help~~ page)
	* [[XML:IPge]] (Item page)
	* [[XML:OPge]] (Objective page)
	* [[XML:WPge]] (Weapon page)
	* [[XML:TxtC]] (Text console)

	====Sound and music====		====Sound and music====

← Older revision		Revision as of 00:50, 6 April 2026
Line 13:		Line 13:

	==What engine does Oni run on?==		==What engine does Oni run on?==
	Oni runs on a custom engine that could be built for Windows, the Macintosh and the PlayStation 2 (console games are not easily modded, so we don't ~~work with~~ the PS2 version of Oni). The engine consists of various subsystems, some of which have colorful animé-related names like Akira (environment), Motoko (graphics) and Totoro (animation).		Oni runs on a custom engine that could be built for Windows, the Macintosh and the PlayStation 2 (disc-based console games are not easily modded, so we don't support modding for the PS2 version of Oni). The engine consists of various subsystems, some of which have colorful animé-related names like Akira (environment), Motoko (graphics) and Totoro (animation).

	Unfortunately, the game was rushed to completion during a change of ownership, and it was not possible for the developers to release any tools or information to aid the fans in modding. Thus, fans had to explore the wild jungle of the raw game data and create modding tools through reverse-engineering. It took over seven years to unlock most of the game's secrets, but we can now mod almost all types of data effectively, allowing us to create entirely new levels and characters.		Unfortunately, the game was rushed to completion during a change of ownership, and it was not possible for the developers to release any tools or information to aid the fans in modding. Thus, fans had to explore the wild jungle of the raw game data and create modding tools through reverse-engineering. It took over seven years to unlock most of the game's secrets, but we can now mod almost all types of data effectively, allowing us to create entirely new levels and characters.

	Altogether, we have identified over 100 types of resources (often called "file types" on this wiki, and "tags" in many other game modding communities) in the ~~game~~ data, however we only directly edit about half of these. It may sound intimidating at first, but depending on the kind of modding you want to do, you might be able to start working with only a little knowledge of the engine.		Altogether, we have identified over 100 types of resources (often called "file types" on this wiki and "tags" in many other game modding communities) in the data, however we only directly edit about half of these. It may sound intimidating at first, but depending on the kind of modding you want to do, you might be able to start working with only a little knowledge of the engine.

	* Go to [[Oni]] for the full story on Oni's development, or;		* Go to [[Oni]] for the full story on Oni's development, or;
	* Go to [[History of Oni modding]] to read about the community's accomplishments up until now, or;		* Go to [[History of Oni modding]] to read about the community's accomplishments up until now, or;
			* Go to [[Engine terminology]] to learn about versions of the engine and its subsystems, or;
	* Continue reading to learn about the game data files.		* Continue reading to learn about the game data files.

Line 26:		Line 27:
	A game can be compared to a theater play: in both cases, you have <u>stages</u>, <u>scripts</u>, <u>actors</u>, and <u>music</u>. A level is built so that when the player performs certain actions or reaches certain locations on the '''stage''', further events are set in motion according to the '''script'''. The player interacts with [[wp:Artificial intelligence in video games\|AI]] '''actors''' along the way. '''Music''' will often play dynamically behind all this, changing along with the flow of events.		A game can be compared to a theater play: in both cases, you have <u>stages</u>, <u>scripts</u>, <u>actors</u>, and <u>music</u>. A level is built so that when the player performs certain actions or reaches certain locations on the '''stage''', further events are set in motion according to the '''script'''. The player interacts with [[wp:Artificial intelligence in video games\|AI]] '''actors''' along the way. '''Music''' will often play dynamically behind all this, changing along with the flow of events.

	In Oni's case, the stages, actors and music (and other sounds) are all packed together into files inside GameDataFolder/ that end in ".dat", ".raw", and, on Macs, ".sep". The level0_Final files provide resources for all levels, and when you load a Chapter, an additional set of data files provide the level-specific resources for that Chapter (e.g. level12_Final for Chapter 10). The scripts are stored in separate plain-text files ending in ".bsl" inside GameDataFolder/IGMD/. The player's progress is stored in persist.dat next to the Oni application.		In Oni's case, the stages, actors and music (and other sounds) are all packed together into files inside GameDataFolder/ that end in ".dat", ".raw", and, on Macs, ".sep". The level0_Final files provide global resources for all levels, and when you load a Chapter, an additional set of data files provide the level-specific resources for that Chapter (e.g. level12_Final for Chapter 10). The scripts are stored in separate plain-text files ending in ".bsl" inside GameDataFolder/IGMD/. The player's progress is stored in persist.dat next to the Oni application.

	* Go to [[Oni (folder)]] ~~for information on each file~~, or;		* Go to [[Oni (folder)/GameDataFolder]] to see how the data files correspond to the game's levels, or;
	* Go to ~~[[Engine terminology]] and~~ [[Game data terminology]] to learn the community's terms for ~~Oni's engine and~~ data, or;		* Go to [[Game data terminology]] to learn the community's terms for the game data, or;
	* Continue reading to learn the general process of modding.		* Continue reading to learn the general process of modding.

Line 39:		Line 40:

	===Third-party tools===		===Third-party tools===
	If you are scripting, ~~then~~ you might need nothing more than a text editor. For editing textures, you might only need a free bitmap editor. For creating levels or characters, you'll need a full 3D modeling package. Since Oni doesn't have modern 3D graphics, you won't need to know as much about modeling/texturing as you would with a modern game, and there are free modelers available. Our recommendations for tools will be found under the subsections of "Modding resources" below.		If you are scripting, you might need nothing more than a text editor. For editing textures, you might only need a free bitmap editor. For creating levels or characters, you'll need a full 3D modeling package. Since Oni doesn't have modern 3D graphics, you won't need to know as much about modeling/texturing as you would with a modern game, and there are free modelers available. Our recommendations for tools will be found under the subsections of "Modding resources" below.

	===Community tools===		===Community tools===