Custom Factions - Revision history

Elf: /* Installing the mod */

2023-09-09T10:26:00Z

Installing the mod

Elf: New update for custom factions

2023-09-09T10:22:20Z

New update for custom factions

Elf: /* Replacing Factions */

2023-09-09T09:38:06Z

Replacing Factions

Elf: /* Setting up the Mod */

2023-09-02T11:38:51Z

Setting up the Mod

Elf: /* Replacing Factions */

2023-07-25T15:04:33Z

Replacing Factions

Elf at 14:57, 25 July 2023

2023-07-25T14:57:25Z

Elf: For next update, will be adding to this.

2023-07-25T14:52:24Z

For next update, will be adding to this.

New page

This page refers to a community made workshop mod created by [[User:Elf]] . For support using the mod, you can request support on the [https://discord.com/invite/holdfastgame official holdfast discord] in #Server-Owners.

This mod allows for players to replace the in-game assets to create custom factions by overriding existing factions.

== Setting up the Mod ==

# Install the [[SDK User Guide|Holdfast SDK]]
# Install a code editor (eg [https://visualstudio.microsoft.com/ Visual Studio]) . This is required for the SDK to correctly build script-based mods.
# Make sure the SDK has your code editor linked. This can be found from edit -> Preferences -> External Tools and then selecting the correct External Script Editor.
# Create a new empty mod.
# Download and copy files from github into the mod folder. The scripts '''MUST''' be in the mods folder or they will not be included in the build.

== Replacing Factions ==

== Configuration Settings ==

By default the mod will assign one Custom faction to one existing factions. However sometimes you may need more faction replacements than factions which exist in the game. For example the naval gamemode only has two ingame factions. Therefore by the config you can define which faction to override based on the attacker and defender name.

This will use custom factions based on ID instead of faction.<pre>
mod_variable xmg_rating:UseCustomFactions:true
</pre>This will replace <code><faction ID></code> for the attacking or defending faction. <pre>
mod_variable xmg_rating:CustomAttackerFactionID:<faction ID>
mod_variable xmg_rating:CustomDefenderFactionID:<faction ID>
</pre>

=== Example ===
For the melee community, a mod allows different national teams to be selected. The mod has 10+ factions which would not be possible without custom ID's. The following will replace the attacking faction with the NA custom faction and the defending faction with the Scandinavia custom faction. <pre>
mod_variable_local xmg_rating:UseCustomFactions:true
mod_variable_local xmg_rating:CustomAttackerFactionID:NA
mod_variable_local xmg_rating:CustomDefenderFactionID:Scand
</pre>

@@ Line 1: / Line 1: @@
-FThis page refers to a community made workshop mod created by [[User:Elf]] . For support using the mod, you can request support on the [https://discord.com/invite/holdfastgame official holdfast discord] in #Server-Owners.
+This page refers to a community made workshop mod created by [[User:Elf]] . For support using the mod, you can request support on the [https://discord.com/invite/holdfastgame official holdfast discord] in #Server-Owners.
@@ Line 14: / Line 17: @@
 == Replacing Factions ==
 With a new mod created and files downloaded from the Github page, your folder should look like this:
@@ Line 21: / Line 25: @@
 * The official templates provided by Harper and AGS can be used as references to create custom faction images.
 * The scene file is what will be used to create the mod.
+[[File:Custom factions folder structure.png|none|thumb]]
 # Open up the scene file. In the scene is an object called "[Manager]" click this to open the inspector in the right hand side of Unity. Top right click the padlock to fix it in place.
 # Click the plus button to create your first custom faction. You can repeat this process to create multiple custom factions on the same mod.
+#
@@ Line 83: / Line 92: @@
 |[[File:Custom factions topflag.png|thumb|153x153px|Rhein Top Image]]
 |}
-By default the mod will assign one Custom faction to one existing factions. However sometimes you may need more faction replacements than factions which exist in the game. For example the naval gamemode only has two ingame factions. Therefore by the config you can define which faction to override based on the attacker and defender name.
+By default the mod will assign one Custom faction to one existing factions. However sometimes you may need more faction replacements than factions which exist in the game. For example the naval game mode only has two in game factions. Therefore by the config you can define which faction to override based on the attacker and defender name.
 This will use custom factions based on ID instead of faction.<pre>
-mod_variable xmg_rating:UseCustomFactions:true
+mod_variable custom_factions:UseCustomFactions:true
 </pre>This will replace <code><faction ID></code> for the attacking or defending faction. <pre>
-mod_variable xmg_rating:CustomAttackerFactionID:<faction ID>
+mod_variable custom_factions:CustomAttackerFactionID:<faction ID>
-mod_variable xmg_rating:CustomDefenderFactionID:<faction ID>
+mod_variable custom_factions:CustomDefenderFactionID:<faction ID>
 </pre>
 === Example ===
 For the melee community, a mod allows different national teams to be selected. The mod has 10+ factions which would not be possible without custom ID's. The following will replace the attacking faction with the NA custom faction and the defending faction with the Scandinavia custom faction. <pre>
-mod_variable_local xmg_rating:UseCustomFactions:true
+mod_variable_local custom_factions:UseCustomFactions:true
-mod_variable_local xmg_rating:CustomAttackerFactionID:NA
+mod_variable_local custom_factions:CustomAttackerFactionID:NA
-mod_variable_local xmg_rating:CustomDefenderFactionID:Scand
+mod_variable_local custom_factions:CustomDefenderFactionID:Scand
 </pre>

@@ Line 1: / Line 1: @@
-This page refers to a community made workshop mod created by [[User:Elf]] . For support using the mod, you can request support on the [https://discord.com/invite/holdfastgame official holdfast discord] in #Server-Owners.
+FThis page refers to a community made workshop mod created by [[User:Elf]] . For support using the mod, you can request support on the [https://discord.com/invite/holdfastgame official holdfast discord] in #Server-Owners.
@@ Line 13: / Line 13: @@
 == Replacing Factions ==
 {| class="wikitable"
 |+
-!Property Name
+!Property
 !Type
 !Description
@@ Line 32: / Line 45: @@
 |Custom Name to Use
 |string
-|The faction name used for the scoreboard or spawn menu.
+|The faction name used in the Spawn menu and end of round screen
+|
 |-
@@ Line 40: / Line 53: @@
+|
 |-
-|Top Bar Sprite
+|Faction Crest
-|sprite
+|Sprite
-|The flag icons used at the top of the screen showing faction score.
+|This is the crest image of the faction used in various menus.
+|[[File:Custom factions crest.png|thumb|Rhein Crest]]
 |-
-|Scoreboard Sprite
+|Faction Emblem
-|sprite
+|Sprite
-|Image used on the scoreboard for the faction
+|Emblem image used in the scoreboard and other menus.
+|[[File:Custom factions emlem.png|thumb|209x209px|Rhein Emblem]]
 |-
-|Faction Selection Sprite
+|Faction Background Selection
-|sprite
+|Sprite
-|Image used for the faction selection screen
+|Background flag used on the "Select faction" screen. This flag is only half of the image with a fade applied. Harper has provided a template for this, I recommend you use it.
+|[[File:Custom factions backgrouind.png|thumb|151x151px|Rhein background]]
 |-
-|Faction Selection Disabled Sprite
+|Faction Top Image
+|Sprite
-|Image used for the faction selection screen if spawning is not enabled for the faction (eg player limit reached)
+|Flag used for the Top bar panel where faction scores are contained.
+|[[File:Custom factions topflag.png|thumb|153x153px|Rhein Top image]]
 |-
-|Square Round End Board Sprite
+|Faction Map Voting Image
 |Sprite
-|Emblem used for the round end scoreboard
+|Icon used for the map voting screen when a faction is selectable
+|[[File:Custom factions mapvoting.png|thumb|178x178px|Rhein Map voting Icon]]
 |-
-|Map Voting Sprite
+|Flag replacement Image
-|sprite
+|Texture
-|Emblem used for the faction when map voting.
+|Texture used to replace in-game flags eg the flag shown in the spawn menu. I recommend using the Top Image for this.
+|[[File:Custom factions topflag.png|thumb|153x153px|Rhein Top Image]]
 |}

@@ Line 20: / Line 20: @@
 !Template
 |-
+|
+|
+|
+|
 |-
+|
+|
+|
+|
 |-
+|
+|
+|-
+|
 |}

← Older revision		Revision as of 14:57, 25 July 2023
Line 13:		Line 13:

	== Replacing Factions ==		== Replacing Factions ==
		+	{\| class="wikitable"
		+	\|+
		+	!Property Name
		+	!Type
		+	!Description
		+	!Template
		+	\|-
		+	\|
		+	\|
		+	\|
		+	\|
		+	\|-
		+	\|
		+	\|
		+	\|
		+	\|
		+	\|-
		+	\|
		+	\|
		+	\|
		+	\|
		+	\|}
		+

	== Configuration Settings ==		== Configuration Settings ==

@@ Line 13: / Line 13: @@
 # Make sure the SDK has your code editor linked. This can be found from edit -> Preferences -> External Tools and then selecting the correct External Script Editor.
 # Create a new empty mod.
-# Download and copy files from GitHub into the mod folder. The scripts '''MUST''' be in the mods folder or they will not be included in the build.
+# Download and copy files from [https://github.com/LoganBlinco/BaseCustomFactionMod GitHub] into the mod folder. The scripts '''MUST''' be in the mods folder or they will not be included in the build.
 == Replacing Factions ==

@@ Line 4: / Line 4: @@
 This mod allows for players to replace the in-game assets to create custom factions by overriding existing factions.
-== Setting up the Mod ==
+== Installing the mod ==
+Before you can start creating custom factions, you must get your SDK setup.
 # Install the [[SDK User Guide|Holdfast SDK]]
 # Install a code editor (eg [https://visualstudio.microsoft.com/ Visual Studio]) . This is required for the SDK to correctly build script-based mods.
 # Make sure the SDK has your code editor linked. This can be found from edit -> Preferences -> External Tools and then selecting the correct External Script Editor.
 # Create a new empty mod.
-# Download and copy files from github into the mod folder. The scripts '''MUST''' be in the mods folder or they will not be included in the build.
+# Download and copy files from GitHub into the mod folder. The scripts '''MUST''' be in the mods folder or they will not be included in the build.
 == Replacing Factions ==