Character Swapping Framework Documentation - Revision history

Starlight: /* Major Changes: */

2025-01-08T19:32:13Z

Major Changes:

← Older revision		Revision as of 19:32, 8 January 2025
Line 575:		Line 575:

	==== Major Changes: ====		==== Major Changes: ====
	~~Removed the ability to change characters in EggmanLand as to retain consistency, due to the system not working for the Werehog in this region.~~

	Removed the ability to change super characters due to the system not functioning fully at that point in time.		* Removed the ability to change characters in EggmanLand as to retain consistency, due to the system not working for the Werehog in this region.
			* Removed the ability to change super characters due to the system not functioning fully at that point in time.
	Added two extra flag modifier scripts for the main '''CSF''' mod to increase the number of characters for day and night from 8 to 24.		* Added two extra flag modifier scripts for the main '''CSF''' mod to increase the number of characters for day and night from 8 to 24.

	== Mods Using Iterations. ==		== Mods Using Iterations. ==

Starlight at 19:31, 8 January 2025

2025-01-08T19:31:58Z

← Older revision		Revision as of 19:31, 8 January 2025
Line 303:		Line 303:

	==== Addtional Info: ====		==== Addtional Info: ====
	In theory version 1.0 could allow you to switch night characters but that still has to respect the 1-7 limit between day and night overall and so this was never implimated.
			* In theory version 1.0 could allow you to switch night characters but that still has to respect the 1-7 limit between day and night overall and so this was never implimated.

	=== Version 2.0. ===		=== Version 2.0. ===
Line 565:		Line 566:
	After: <Case flag="iFlag_DayCharacter" operation="E" value="{modifiable number}">		After: <Case flag="iFlag_DayCharacter" operation="E" value="{modifiable number}">
	</syntaxhighlight>		</syntaxhighlight>

			==== Addtional Info: ====

			* EggmanLand region does not function for "iFlag_NightCharacter" & "iFlag_SuperCharacter".

	=== Version 3.0. ===		=== Version 3.0. ===
			Version 3.0 didn't change to much but it did streamline many aspects for use in the '''CSF''' and for use by other modders when forking the mod for their own projects.

			==== Major Changes: ====
			Removed the ability to change characters in EggmanLand as to retain consistency, due to the system not working for the Werehog in this region.

			Removed the ability to change super characters due to the system not functioning fully at that point in time.

			Added two extra flag modifier scripts for the main '''CSF''' mod to increase the number of characters for day and night from 8 to 24.

	== Mods Using Iterations. ==		== Mods Using Iterations. ==

Starlight at 19:14, 8 January 2025

2025-01-08T19:14:57Z

Show changes

Starlight at 18:23, 8 January 2025

2025-01-08T18:23:05Z

Show changes

Starlight at 17:13, 8 January 2025

2025-01-08T17:13:46Z

@@ Line 4: / Line 4: @@
 === Glossery: ===
-'''CSF''' : Character Swapping Framework
+'''CSF''': Character Swapping Framework
 '''Data Archive''': The archive containing character model, sound and ui data, such as "'''ActD_Char_Custom.ar'''"
@@ Line 32: / Line 32: @@
 == Major Iterations. ==
-'''Version 1.0.'''

Starlight: Created page with "The "'''Character Swapping Framework'''" is a mod for '''Sonic Unleashed''' that adds in the ability for a user to install one or more model mods to their game and then toggle between each model mod in game. The mod has a few major iterations that a modder could fork for their own work. === Glossery: === '''CSF''' : Character Swapping Framework '''Data Archive''': The archive containing character model, sound and ui data, such as "'''ActD_Char_Custom.ar'''" '''Data B..."

2025-01-08T16:46:50Z

Created page with "The "'''Character Swapping Framework'''" is a mod for '''Sonic Unleashed''' that adds in the ability for a user to install one or more model mods to their game and then toggle between each model mod in game. The mod has a few major iterations that a modder could fork for their own work. === Glossery: === '''CSF''' : Character Swapping Framework '''Data Archive''': The archive containing character model, sound and ui data, such as "'''ActD_Char_Custom.ar'''" '''Data B..."

New page

The "'''Character Swapping Framework'''" is a mod for '''Sonic Unleashed''' that adds in the ability for a user to install one or more model mods to their game and then toggle between each model mod in game.

The mod has a few major iterations that a modder could fork for their own work.

=== Glossery: ===
'''CSF''' : Character Swapping Framework

'''Data Archive''': The archive containing character model, sound and ui data, such as "'''ActD_Char_Custom.ar'''"

'''Data Bridge''': The archive used to bridge between the '''Data Archive''' and the stage instance, such as "'''#Custom_Africa.ar'''"

'''SR_Enter Scripts''': The stage entry scripts primarily modified to facilitate this mods functions.

== How The Core System Works In All Iterations. ==
All iterations use the same fundamental system where you require:

An archive containing your "characters" data, this for example would be similar to "'''Sonic.ar'''", but labled something like "'''ActD_Char_Custom.ar'''".

Archives to hook the '''Data Archive''' to the stage, such as "'''#Custom_Africa.ar'''" or "'''#Sub_Custom_Africa1.ar'''".

A custom archive tree, referenced as additional in the main archive trees.

Entries for '''Data Archives''' and '''Data Bridge''' archives in the "'''swa.arcinfo'''".

Entires for your flag type [integer or bool] in the "'''Flaglist.xml'''".

Flag modifier scripts for your characters, these dictate what region within the script sets the bool or integer flag.

Relevent per version cases in the "'''SR_Enter'''" scripts.

Stagelist entries directing to the flag modifer scripts.

== Major Iterations. ==
'''Version 1.0.'''