https://www.redfactionwiki.com/w/api.php?action=feedcontributions&feedformat=atom&user=CamoRed Faction Wiki - User contributions [en]2026-04-29T21:02:13ZUser contributionsMediaWiki 1.39.1https://www.redfactionwiki.com/w/index.php?title=Nanoforge_basics&diff=14896Nanoforge basics2025-07-04T09:05:46Z<p>Camo: Added limit for multi_object_markers</p>
<hr />
<div>{{RFGEditing}}<br />
{{Under construction}}<br />
<br />
This page goes over how to install Nanoforge and it's basic features. This article only goes over the basics of each feature. See the other guides for more detailed explanations.<br />
<br />
===IMPORTANT NOTE===<br />
Nanoforge was rewritten starting with version v1.0.0. At the time of writing that version only has a map editor for multiplayer and wrecking crew maps. The other editors will return in future releases. If you're editing MP/WC maps it recommended that you use the latest version of Nanoforge. It has many improvements to the map editor. If you want to use features that are still missing in the rewrite such as the texture and mesh exporters, you should use v0.21.1<br />
<br />
==Installation==<br />
===Download===<br />
Nanoforge releases are posted on [https://github.com/Moneyl/Nanoforge/releases github]. Multiple releases will be listed. You should always download the most recent release. To download it, look for the <code>▸Assets</code> button(1), click it, and download the first zip file listed under it(2).<br />
<br />
[[File:NanoforgeDownloadStepsAnnotated.png|frameless|768px]]<br />
<br />
===Install===<br />
*Unpack the zip file you downloaded anywhere and run Nanoforge.exe<br />
*You should now see the start screen. On the left side it has the data path and the recent projects list. On the right it has the changelog. Nanoforge with attempt to auto detect your RFG install. If it says that your data path is invalid click the <code>Browse...</code> button and select your RFG data folder.<br />
<br />
==Features==<br />
This section gives a quick rundown of each of Nanoforge's features.<br />
<br />
===Projects===<br />
Nanoforge uses projects to track edits made to game files. The idea is to use a single project per mod. You only need to create a project if you're editing files. You don't need one to view and export files. To create a new project click <code>New project</code> in the start page or <code>File > New project...</code> on the main menu bar. Fill out all the info on the popup and click <code>Create</code>. Below are each of the fields to fill in:<br />
*Name: The name of the project. Used to name the project file and as the name in any modinfo.xml files it generates.<br />
*Path: Path to the folder that the project should be created in.<br />
*Description: (Optional) Description of what the mod is. Used in the description field of modinfo.xml.<br />
*Author: (Optional) Author(s) of the mod. Used in the author filed of modinfo.xml.<br />
*Create project folder: If unchecked then the project files are placed directly in the folder chosen for path. If checked a folder with the entered name will be created in that folder.<br />
<br />
===File explorer===<br />
The file explorer lets you view the contents of vpp_pc and str2_pc files without extracting them manually. You can double click supported file formats like textures to open them. If you single click a vpp_pc or str2_pc file it will expand to show it's contents. Extra info about the file will be shown in the properties panel for some files when single clicking them.<br />
<br />
[[File:Nanoforge ProjectCreationExample3.png|frameless|256px]]<br />
<br />
====Search====<br />
You can use the search bar to limit which files are shown in the file explorer. By default it will only show files with names that contain the search term. You can also use some special characters to specialize your search behavior:<br />
*Start your search with *: Will only show files with names that end with whatever comes after *<br />
*End your search with *: Will only show files with names that start with whatever comes before *<br />
<br />
If you prefer regex you can check the regex search option. Note that the regex search option is much slower than the default one.<br />
<br />
===Properties panel===<br />
The properties panel sometimes will show additional info about files selected in the file explorer. It also may be used by other UI panels to show additional info. For example, it can list object properties when viewing territories (see map viewing section below).<br />
<br />
[[File:Nanoforge_PropertiesPanel2.png|frameless|256px]]<br />
<br />
===Textures===<br />
You can open texture files by double clicking them in the file explorer. Textures are split into two files. Either a cpeg_pc and gpeg_pc file pair or a cvbm_pc and gvbm_pc file pair. You can double click any of these to open a texture. A single RFG texture file can contain multiple textures, which we'll refer to as subtextures. Info about the selected subtexture will be shown below the subtexture list.<br />
<br />
[[File:Nanoforge_TextureDocument.png|frameless|768px]]<br />
<br />
Above is an example of what you might see if you open a texture file. On the sidebar to the left there a few things, in order:<br />
*The subtexture list. Click on one to see more info about it below.<br />
*Texture info. This is info about the selected subtexture.<br />
*Header info. This is general info about the cpeg/cvbm file.<br />
<br />
====Exporting textures====<br />
Textures can be exported to files you can edit with common image editors like Paint.NET, GIMP, or Photoshop. Currently textures can only be exported as .dds files. You can export single subtextures by right clicking one of them and clicking <code>Export...</code>. You can export all subtextures at once with the <code>Export all...</code> button.<br />
<br />
====Editing textures====<br />
Textures can be edited by imported textures you've edited externally. Currently it can only import .dds files. You do this by right clicking a subtexture, clicking <code>Replace...</code> and selecting the file you want to replace the subtexture with. Once you do this it's critical that you press the <code>Save</code> button above the subtexture list to save your edit. This edit will be automatically saved to your current project when you click <code>Save</code>. See [[Nanoforge Texture Editing]] for more info.<br />
<br />
===Meshes===<br />
Nanoforge supports viewing and exporting .csmesh_pc (static mesh) and .ccmesh_pc (character mesh) files. Just like textures, meshes consist of two files. Every csmesh_pc file is paired with a gsmesh_pc file, and every ccmesh_pc file is paired with a gcmesh_pc file. You can click any of them to open a mesh. When you open a mesh you'll first see a blank space. Meshes are loaded on a background thread so it may take a few seconds for the mesh to be loaded and for it's textures to show up. Before its textures are found or if the textures cant be found you might see textures from previously loaded meshes applied to the mesh.<br />
<br />
[[File:Nanoforge_MeshDocument.png|frameless|512px]]<br />
<br />
Above is what you might see if you open a mesh file. There's a few parts of the UI to note, in order:<br />
* The camera button. This lets you control camera settings like speed and location. You can move the camera by holding down the right mouse button and using WASD to move around. If this doesn't work try left clicking on the mesh 3D view. Only the most recently selected mesh reacts to camera controls so if you have several open it'll only move one camera.<br />
* The scene button. This has some rendering settings for the mesh such as scale and lighting color/intensity.<br />
* The info button. This shows some additional info about the mesh such as vertex format, and the LOD slider for meshes with multiple levels of detail.<br />
* The export button. This lets you export the mesh and it's textures to a .obj file, which can be imported into tools like blender.<br />
* The status bar. This shows the loading status and percentage. It will show <code>Done! ✓</code> once loading is complete.<br />
<br />
====Exporting meshes====<br />
To export a mesh:<br />
* Wait for it to finish loading. The status bar will show <code>Done! ✓</code> and 100%.<br />
* Click the export button. Top left of the document, button furthest to the right.<br />
* Select a folder to export the mesh and it's textures to and click <code>Export</code>.<br />
<br />
A single gltf file and the meshes textures will be exported. Each lod level is labelled in the gltf under their own subnode. Currently these gltf files don't look right as is when imported into Blender. This is because GLTF uses a different rendering model than RFG. Typically meshes have a diffuse, specular, and normal texture. Their names end with _d, _s, and _n respectively. You'll need to make the following changes to the textures in the Blender shading tab:<br />
* Diffuse -> Set color space to linear, attach texture color to "Base Color" on the BSDF<br />
* Specular -> Set color space to linear, attach texture color to "Specular" on the BSDF<br />
* Normal -> Set color space to SRGB, attach texture color to "Normal" on the BSDF<br />
<br />
In the near future an extension will be made to automatically patch the shader graph.<br />
<br />
====Camera movement====<br />
To move the camera hold down the right mouse button over the 3D view and use WASD to move around. Holding down shift while moving will cause the camera to move faster. Pressing Q and E will move the camera directly up and directly down respectively.<br />
<br />
===Mod packaging===<br />
Once you're done editing textures you can use Nanoforge to repack the editing files and generate a modinfo.xml for you. To do this, simply click <code>File > Package mod</code> on the main menu bar. Once it's done go to the "Output" folder inside your project folder to see the modinfo.xml and any files that it relies on. These are ready for use with the re-mars-tered mod manager.<br />
<br />
===Map view===<br />
Nanoforge has partial support for viewing maps like the main campaign map. We'll be referring to them as territories as that's how RFG groups together many zones. See [[RF:G Map organization]] for more details on how RFG maps are structured. To open a territory via <code>Tools > Open territory</code> on the main menu bar. Terr01 is the main campaign map territory. A new document should appear when you open a new territory. Camera movement is the same as the mesh viewer. See [[#Camera_movement|camera movement]]. Terrain is loaded in the background so you'll see separate blocks of terrain pop into view as they load. Bounding boxes are drawn for zone objects. With a territory open you should see new information on the zone panel and the zone objects panel. You can dock panels by clicking and dragging on their titles. It's recommended that you dock the zone object list below the zone list so you can see both at once.<br />
<br />
Below is an annotated image of information you can view about territories plus descriptions for each annotation.<br />
<br />
[[File:Nanoforge_W3p0erDiTj.jpg|frameless|1024px]]<br />
<br />
* First, in the top left is the zone list. Territories are made up of one or more zones which in turn have many zone objects. Click a zone to see its object in the zone objects panel (bottom left). By default the zone with the most objects is selected. In this case that's <code>04_06</code>. Note that each zone corresponds to a rfgzone_pc file. So, for example, <code>04_06</code> is really terr01_04_06.rfgzone_pc.<br />
* Next, bottom left is the zone objects list. This lists the objects inside the selected zone. Click an object to see its properties in the properties panel. Some objects have child objects, denoted by having a triangle in front of their name which you can click to expand them. You can filter objects by type inside the filters header. By default some very common objects like navpoints are hidden.<br />
* Finally, in the top right is the properties panel. This shows the properties of the selected zone object.<br />
<br />
==Core concepts==<br />
* The total limit of <code>multi_object_markers</code> you can have on a single map is 25, if you exceed this spawn backpack / backpack racks, CTF, damage control & siege will all stop working.<br />
<br />
==Object Flags==<br />
* Flag 0 (Persistent): Unknown, any objects with this flag have a separate copy stored in a second <code>rfgzone_pc</code> file with its name prefixed with <code>p__.</code> So, for example, Crescent has two <code>rfgzone_pc</code> files. <code>mp_crescent.rfgzone_pc</code> and <code>p_mp_crescent.rfgzone_pc</code>. The objects with the persistent flag are stored in both zone files, while objects without that flag are only stored in <code>mp_crescent.rfgzone_pc</code>. It's consistently used on player spawns, on most siege objectives and on most <code>rfg_movers</code> on Siege maps. It's recommended you don't enable or disable this flag on maps if you're using the Terraform Patch as it contains fixes for missing objects that incorrectly used this flag or were missing it; doing so will cause objects to vanish.<br />
* Flag 1: Unknown<br />
* Flag 2: Unknown <br />
* Flag 3: Unknown; might be related to how the game saves/loads map data from save files (requires more investigation)<br />
* Flag 4: Unknown; seems to always get converted to the runtime flag <code>streaming_fixed</code>, most <code>rfg_movers</code> and <code>general_movers</code> have this flag. If you're using the Terraform Patch it's recommended you don't disable this flag as it applies it to all objects since it was used most of the time and objects missing it were assumed to be an error by Volition. (They also made mistakes with the gamemode and persistent flags)<br />
* Flag 5: Unknown; seems to get converted to the runtime flag <code>force_full_save</code><br />
* Flag 6: Unknown<br />
* Flag 7: Unknown<br />
* Flag 8: Spawns in Anarchy<br />
* Flag 9: Spawns in Team Anarchy<br />
* Flag 10: Spawns in CTF<br />
* Flag 11: Spawns in Siege<br />
* Flag 12: Spawns in Damage Control<br />
* Flag 13: Spawns in Bagman<br />
* Flag 14: Spawns in Team Bagman<br />
* Flag 15: Spawns in Demolition<br />
<br />
==Chunk Flags==<br />
* Applies to <code>rfg_movers</code> & <code>general_movers</code>.<br />
* When editing their properties in the inspector it's possible to change the <code>chunk_flags</code>.<br />
* You can also use <code>gameplay_properties.xtbl</code> to apply these flags and change <code>gameplay_props</code>. If you're using the Terraform Patch a new <code>gameplay_prop</code> named <code>Invulnerable</code> is added which also can be used to make objects indestructible.<br />
* Eg: <code>dynamic_link invulnerable</code> will make the object indestructible. Full list of flags below:<br />
* child_gives_control: Unknown.<br />
* building: Unknown.<br />
* dynamic_link: Unknown.<br />
* world_anchor: Unknown.<br />
* no_cover: Might be where EDF can't take cover behind objects.<br />
* propaganda: EDF propaganda billboards you destroy for the achievement in singleplayer have this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows to track the players progress and reduce EDF control of the sector.<br />
* kiosk: <code>tech_kiosk_EDF_A</code> has this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows its a special object that plays propaganda videos.<br />
* touch_terrain: Unknown, no <code>gameplay_properties.xtbl</code> entries use this flag and it's missing from the table description.<br />
* supply_crate: EDF crates you destroy for the achievement in singleplayer have this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows to track the players progress.<br />
* mining: Ores you mine for salvage and the achievement in singleplayer have this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows to track the players progress.<br />
* one_of_many: Unknown, <code>windmill_0708</code>, <code>0102smokestack_86</code> & <code>0102smokestack_86_child</code> have this flag in <code>gameplay_properties.xtbl</code>. Might be related to one of the side activities where you have to destroy multiple targets.<br />
* plume_on_death: Unknown.<br />
* invulnerable: Makes an object indestructible.<br />
* inherit_damaga_pct: Unknown.<br />
* regrow_on_stream: Unknown.<br />
* casts_drop_shadow: Object will cast drop shadows.<br />
* disable_collapse_effect: Unknown.<br />
* force_dynamic: Unknown.<br />
* show_on_map: Most objects in <code>gameplay_properties.xtbl</code>. Most likely means the object will show on the minimap in singleplayer.<br />
* regenerate: Unknown.<br />
* casts_shadow: Object will cast a shadow map.<br />
<br />
==Object Info==<br />
* <code>obj_zone</code> = Defines the wind speed, terrain file name & <code>spawn_resource_data</code>. If you move its location the terrain will no longer have collision.<br />
* <code>MPST</code> = Multiplayer siege target.<br />
* <code>MPDCT</code> = Multiplayer damage control target.<br />
* <code>shape_cutter</code> = Causes object to start off with initial damage, used on damage control targets or maps like crash site, ruins & remnant where they put a hole in the wall.<br />
* <code>spawn_node</code> = Camera view at start of match and end of game. If a map doesn't have a least one of these it will crash.<br />
* <code>spectator_camera</code> = Camera view exclusively for players using the spectator mode, recommended to just ignore adding them and use <code>spawn_nodes</code> instead.<br />
* <code>trigger_region</code> = Killbox that can be set to a mine or cliff.<br />
* <code>rfg_mover</code> = Buildings, backpack racks & more.<br />
* <code>general_mover</code> = Explosive barrels and the <code>backpack_effect_attach.cchk_pc</code> objects for example.<br />
* <code>player_start</code> = Spawn point, can be set to Neutral, EDF or Guerilla.<br />
* <code>item</code> = In multiplayer the bag for bagman is set to <code>item_type</code> "multi_object_bagman_flag" and references <code>items_3d.xtbl</code>.<br />
* <code>weapon</code> = Weapon spawn, <code>weapon_type</code> determines which weapon will spawn and references <code>weapons.xtbl</code>.<br />
* <code>object_effect</code> = Visual effect, eg the fire on Nordic Bonus.<br />
* <code>multi_object_marker</code> = Multiple uses, in multiplayer the <code>marker_type</code> can be set to <code>Backpack rack</code>, <code>Spawn node</code>, <code>Flag capture zone</code>, <code>King of the Hill target</code>, <code>Siege target</code> & <code>Spectator camera</code>.<br />
* <code>cover_node</code> =<br />
* <code>navpoint</code> = Probably where NPCs can navigate, similar to navmeshes in other games.<br />
* <code>object_action_node</code> = <br />
* <code>object_squad_spawn_node</code> = Probably where squads spawn and references various <code>squads.xtbl</code> files.<br />
* <code>object_path_road</code> = Probably where NPCs can drive vehicles.<br />
* <code>object_guard_node</code> =<br />
* <code>object_vehicle_spawn_node</code> = Probably where vehicles can spawn like walkers found around the SP map.<br />
* <code>object_bounding_box</code> = Seems to be only be used in singleplayer, unknown why.<br />
* <code>object_activity_spawn</code> = Probably where you can start a side activity like demolition master for example.<br />
* <code>object_house_arrest_node</code> = Related to the house arrest side activity.<br />
* <code>object_patrol</code> = Probably where EDF patrol.<br />
* <code>object_dummy</code> =<br />
* <code>object_mission_start_node</code> = Probably where you can start a main mission.<br />
* <code>object_restricted_area</code> = Probably where the EDF will attack on sight and you will get an alert level in SP.<br />
* <code>backpack_effect_attach.cchk_pc</code> = Seems to be for attaching the backpack to the player when they spawn, DO NOT TOUCH IT ALL OR THE MAP WILL CRASH WHEN SPAWNING.<br />
<br />
==Object Properties==<br />
* <code>gameplay_props</code> references <code>gameplay_properties.xtbl</code>.<br />
* <code>backpack_type</code> references <code>mp_backpacks.xtbl</code>.<br />
* <code>weapon_type</code> references <code>weapons.xtbl</code>.<br />
* <code>item_type</code> references <code>items_3d.xtbl</code>.<br />
* <code>spawn_resource_data</code> references <code>spawn_resource.xtbl</code>.<br />
* <code>ambient_spawn</code> references <code>ambient_spawn_info.xtbl</code> or <code>dlc01_ambient_spawn_info.xtbl</code>.<br />
* <code>visual</code> references <code>effects.xtbl</code>.<br />
* <code>sound</code> references <code>foley.xtbl</code> (not included in the game for some reason) however there is <code>dlc01_foley.xtbl</code>.<br />
<br />
==Spawn Points==<br />
* <code>mp_team</code> can be set to <code>Neutral</code>, <code>EDF</code> or <code>Guerilla</code>.<br />
* When making a CTF map and you don't want players spawning at the opposing base ensure you disable the Flag <code>Spawn in CTF</code> for any Neutral spawn points.<br />
* Unknown if the <code>respawn</code> and <code>initial_spawn</code> booleans do anything in multiplayer.<br />
* <code>indoor</code> boolean is probably left over from Saints Row since all of RF:G is technically outdoors and no spawn points use this boolean.<br />
* <code>checkpoint_respawn</code> & <code>activity_respawn</code> are only used in singleplayer.<br />
* Foward X axis (blue line) determines player spawn direction.<br />
<br />
==Spawn Nodes==<br />
* Camera views at the start of match or when a player dies and is spectating.<br />
* Foward X axis (blue line) determines player camera direction & view.<br />
* If a map doesn't have at least one <code>Spawn node</code> it will crash when loading.<br />
<br />
==Spectator Cameras==<br />
* Believed to be similar to a <code>Spawn node</code> but used exclusively by players using the spectator option in matchmaking. Recommended to just ignore adding these since the community only plays custom games and adding <code>Spawn nodes</code> to your map will serve the same purpose.<br />
* Foward X axis (blue line) determines player camera direction & view.<br />
<br />
==Mover Types==<br />
* Applies to <code>rfg_movers</code><br />
* When editing their properties it's possible to change the <code>mtype</code> field to the corresponding numbers<br />
* Fixed = 0 (default)<br />
* Normal = 1 (unknown)<br />
* Lite = 2 (unknown)<br />
* Ultra Lite = 3 (unknown)<br />
* World Only = 4 (no collision but you can still destroy it with a hammer for example)<br />
* No Collision = 5 (no collision)<br />
<br />
==Damage Control Targets==<br />
# Deep clone <code>MPDCT_MAPNAME_XXX</code>.<br />
# Move </code>MPDCT_MAPNAME_XXX</code> to the location of your choosing.<br />
# In object properties for the parent change <code>display_name</code> to whatever you want your new damage control objective to be called.<br />
# If you're making a map that doesn't already have a damage control target you can open it in another tab and use the deep clone feature. If you're using the Terraform Patch the majority of Wrecking Crew maps will already have the asset along with all Siege maps.<br />
# It's also possible to have only <code>1</code> target & more than <code>3</code>. The limit before the game will crash is a total of <code>6</code> targets when tested solo. The limit might be lower when played with other people but needs to be tested more.<br />
# It's also possible that using the same <code>display_name</code> name for each target can introduce instability.<br />
# The only valid value for the <code>mp_team</code> property is <code>Neutral</code>. If you change the team to <code>EDF</code> or <code>Guerilla</code> and disable the <code>shape_cutter</code> child so the target starts off intact it will belong to that team but not score any points until it's destroyed and repaired.<br />
# You can disable the <code>shape_cutter</code> child so the target starts off intact instead of destroyed like it is by default.<br />
# Any object can be used for a target if you add the <code>multi_object_marker</code>, <code>shape_cutter</code> and offset them correctly from the parent. See Stratosphere if using the Terraform Patch for how to do this; shipping containers are the targets added on that map in the patch.<br />
<br />
==Siege Targets==<br />
# Open a siege map in one tab, open a regular map with the same objects in another tab.<br />
# Deep clone the siege target to the regular map.<br />
# Move the added siege target to the exact same location as the existing matching object on the regular map.<br />
# Disable all the gamemode flags for the added siege target except for "Spawn in Siege" including its children.<br />
# Delete all the children of the siege targets (usually spawns that will be outside the map since they were deep cloned from the siege map), after they are all deleted make sure to "orphan children" of the child to ensure it doesn't have ghost children. <br />
# Disable the <code>Spawn in siege</code> flag on the matching original map object.<br />
# You need to update <code>mp_levels.xtbl</code> so the map is selectable in siege.<br />
# Ensure the siege target and its child have the persistent flag.<br />
# The <code>priority</code> property for the <code>Siege target</code> child determines which siege objects are unlocked to destroy, eg if you set it to <code>1</code> it would be the first target the attackers can destroy, you can have multiple targets unlocked by using the same number and if you wanted to have targets unlocked one at a time you would use <code>1</code>, <code>2</code>, <code>3</code> and so on. If you use a value of <code>4294967295</code> they are also unlocked at the same time.<br />
# You must use an existing string in the game for the <code>display_name</code> property on the child or the map will crash.<br />
# If you mess up the offset of the child the map will crash.<br />
<br />
==Backpack Racks==<br />
* Make sure you deep clone them when adding new racks, the child <code>Backpack rack</code> is required for it to work properly.<br />
* Ensure that when moving the rack to a new location you only move the parent (the child will follow and be offset correctly), they will be named <code>Jetpack</code> for example if you're using the Terraform Patch.<br />
* When editing the child <code>backpack_type</code> determines which backpack will spawn, most are the same as their in game names with the exception of Firepower <code>Commando</code> & Concussion <code>Shockwave</code>. These names are from <code>mp_backpacks.xtbl</code>.<br />
* When editing the child you can change the number of backpacks on a rack, edit <code>num_backpacks</code> and change it from a value ranging from <code>0-3</code>, although <code>0</code> would mean the rack is empty and useless.<br />
* When editing the child it's possible to make it team exclusive, this means only the EDF or Red Faction can pickup backpacks from that rack during team game modes. Edit <code>mp_team</code> and enter either <code>EDF</code> or <code>Guerilla</code>. In game that rack will have a green glow around it if your team can use it.<br />
* The <code>random_backpacks</code> boolean in the object properties for the <code>Backpack rack</code> child doesn't seem to do anything.<br />
* It's possible to make Backpack Racks destructable by changing <code>gameplay_props</code> to <code>Default</code>. During team game modes teams can fight for control by destroying racks and repairing them so only their team can use them. Racks you're able to use will glow green and racks you can't will glow red if you're using the Terraform Patch.<br />
* The maximum number of Backpack Racks you can have on a map before it causes issues is <code>25</code>.<br />
<br />
==Capture the Flag targets==<br />
* The EDF and Red Faction have their own unique flag stand placed near their team spawns on regular multiplayer maps.<br />
* Make sure you use deep cloning and only move the parent when placing or moving them so the child is offset correctly.<br />
* Objects are called <code>edf_flag_stand.cchk_pc</code> & <code>guerrilla_flag_stand.cchk_pc</code>.<br />
* If you attempt to add more than two stands to a map, the extras will not work as capture points and only the asset will appear.<br />
* <code>Neutral</code> is not a valid value for <code>mp_team</code>.<br />
<br />
==Bagman Objective Spawn==<br />
* Object is an <code>item</code> type referencing <code>items.3d_xtbl</code>.<br />
* Ignore the varying bounding box sizes when positioning the bag spawn, the XYZ axis position is what matters (the red, blue & green lines).<br />
* The <code>respawn</code> boolean doesn't do what you expect, the bag will still return to the original spawn point regardless if it's enabled or not.<br />
* You can't place more than one bag on a map normally, only one will spawn. However you can have different bag locations in Bagman and Team Bagman by using the gamemode flags.<br />
<br />
==Weapon Spawns==<br />
* You should clone other weapons to add new ones, if you make them from scratch and don't get the bounding box correct for certain weapons it can cause duplicate weapon spawns in some cases.<br />
* <code>weapon_type</code> determines which weapon will spawn and references <code>weapons.xtbl</code>.<br />
* The <code>preplaced</code> boolean needs more testing but you can disable weapons in certain game modes by disabling the game mode flags anyway.<br />
* The <code>respawns</code> boolean will cause the weapon to not re-spawn again during a match after it has been picked up for the first time.<br />
* Ensure the bounding box is slightly above the ground/floor when positioning weapons.<br />
<br />
==Trigger Regions==<br />
* In multiplayer & singleplayer these are used to prevent the player from going out of bounds.<br />
* <code>region_kill_type</code> can be set to a <code>cliff</code> or a <code>mine</code>. A cliff will cause the player to fall to their death, while a mine will explode and kill the player; this is also reflected in the killfeed message in multiplayer.<br />
* In singleplayer the <code>trigger_flags</code> can be changed so the trigger isn't enabled during missions and/or activities. Eg. <code>not_in_mission</code> will disable it during a main mission, <code>not_in_activity</code> would disable it during a side activity and <code>not_in_mission not_in_activity</code> would disable it during both.<br />
* The <code>enabled</code> boolean allows mappers to enable/disable the region.<br />
* The <code>trigger_shape</code> can be set to a <code>box</code> or <code>sphere</code>. However Nanoforge cannot render spherical bounding boxes yet.<br />
* <code>outer_radius</code> might control the size of the region, but this is untested.<br />
<br />
==Object Effects==<br />
* Plays an effect such as smoke, fire, explosion, sparks, etc. Also can play sounds if the effect has one in <code>effects.xtbl</code> and the sound string is used.<br />
* <code>sound_alr</code> = Unknown. <br />
* <code>sound</code> = The name of the sound in <code>effects.xtbl</code><br />
* <code>visual</code> = The name of the effect in <code>effects.xtbl</code><br />
* <code>looping</code> = Controls if the effect will play once or continuously.<br />
<br />
==Shape Cutters==<br />
* Used to damage or cut holes into destructible objects ahead of time.<br />
* <code>outer_radius</code> might control the size of the cutter, but this is untested.<br />
<br />
==Maps with names different from their in-game names==<br />
* wc1 - Complex<br />
* wc2 - Watchtower<br />
* wc3 - Scrapheap<br />
* wc4 - Vista<br />
* wc5 - Fortress<br />
* wc6 - Factory<br />
* wc7 - Gulch<br />
* wc8 - Cascade<br />
* wc9 - Transmission<br />
* wc10 - Pipeline<br />
* wcdlc1 - Ruins<br />
* wcdlc2 - Repercussion<br />
* wcdlc3 - Imperial<br />
* wcdlc4 - Expansion<br />
* wcdlc5 - Frost<br />
* wcdlc6 - Abandoned<br />
* wcdlc7 - Stratosphere <br />
* wcdlc8 - Invasion<br />
* wcdlc9 - Nordic Bonus<br />
* mpcx_crossover - Doubletime<br />
* mpcx_assembly - Outpost <br />
* mpdlc_landbridge - Equilibrium<br />
* mpdlc_islands - Haven<br />
* mpdlc_minibase - Complex<br />
* mpdlc_overhang - Gradient<br />
* mpdlc_ruins - Remnant<br />
<br />
==Maps with similar terrain==<br />
* Crash Site/Complex/Nordic Bonus<br />
* Rift/Factory<br />
* Remnant/Ruins<br />
* Broadside/Invasion<br />
* Wasteland/Gulch<br />
* Outpost/Framework<br />
* Radial/Transmission<br />
* Sand Pit/Division/Watchtower<br />
* Tutorial Area/Pipeline<br />
* Pinnacle/Fortress<br />
<br />
==Misc Notes==<br />
* Deep clone objects if you want to keep the children of an object and use regular clone if you just want to clone the parent. Only move the parent when deep cloning and the children will follow and be offset correctly.<br />
* If you see anything that looks like XML inside <code>layer_pc</code> or <code>rfgzone_pc</code> files you can ignore that as we're 99% sure it's junk from their file packer reusing memory without zeroing it out.<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail.<br />
<br />
===Localization strings===<br />
While Nanoforge is only in English at the moment it can view localized strings used by RFG. RFG uses placeholder strings in many xtbls which are replaced with their localization at runtime. These are shown automatically in the xtbl editor. You can also view a list of all localized strings via <code>Tools > Localization > View localized strings</code>. You can search by placeholder by checking "Search by identifier". You must fully enter the identifier without typos for this to work since it's comparing it to a hash of the identifier stored in the games localization files.<br />
<br />
[[File:Nanoforge_LocalizedStringList0.png|frameless|768px]]<br />
<br />
===Scriptx viewer===<br />
RFG uses an xml based scripting system called scriptx for some mission logic. The viewer is an attempt at making it easier to read scriptx files which can be difficult to understand. It's a low priority feature so it likely won't see changes for a while but was enabled in case it's useful to people editing scriptx files. You still need to edit them by hand but it can help make it clearer what a script is doing. You can access it via <code>View > Scriptx Viewer (WIP)</code>.<br />
<br />
[[File:Nanoforge_ScriptxViewer0.png|frameless|768px]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Editing_Main_Page&diff=14895RF:G Editing Main Page2025-07-03T22:06:36Z<p>Camo: Added recently released tools and fixed some tool descriptions</p>
<hr />
<div>{{BubbleNav|RFG|no|no}}This will serve as a landing page for all resources related to [[Red Faction: Guerrilla]] editing for the '''Re-Mars-tered Edition'''.<br />
<br />
==External Links==<br />
===Community===<br />
*[https://discord.gg/factionfiles Faction Files Community Discord] - Active Red Faction series community Discord with #map-mod-development channel for community development discussion<br />
*[https://rfg-modding.github.io/SyncFaction/#/modding/intro SyncFaction Modding Intro] - Extensive writeup of all available mod formats and distribution methods. Includes mod examples!<br />
===Downloads===<br />
*[https://www.factionfiles.com/ff.php?action=files FactionFiles.com] - Custom mods, tools, patches, and reference material<br />
*[https://www.nexusmods.com/redfactionguerilla/mods/ Nexus Mods] - Custom mods<br />
*[https://www.nexusmods.com/redfactionguerrillaremarstered/mods/ Nexus Mods Re-Mars-tered] - Custom mods<br />
<br />
==Documentation==<br />
*[[RF:G Map organization]]<br />
*[[Nanoforge basics]]<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail<br />
===Core Concepts===<br />
*[[Red Faction: Guerrilla]]'s level editor is [[CLOE]], which is not publicly available.<br />
<br />
===Red Faction: Guerrilla File Formats===<br />
* <code>.xtbl</code> - XML table files are used to store properties or attributes in Red Faction: Guerrilla. Overall, their function is similar to the <code>.tbl</code> files of Red Faction and Red Faction II.<br />
* <code>.scriptx</code> - Internal XML scripting language file, commonly used for missions and activities<br />
* <code>.dtodx</code> - Weather/lighting file for maps that controls things like fog, tint, ambient colour, eye adaption, bloom, cloud color and speed<br />
* <code>.gtodx</code> - Skybox file for maps that controls things like the sun texture, moon positions and if the horizon mountain texture is enabled<br />
* <code>.vpp_pc</code> - Packfile<br />
* <code>.rigx</code> - Rig<br />
* <code>.str2_pc</code> - Texture Packfile<br />
* <code>.rfgzone_pc</code> - Map zone<br />
* <code>.layer_pc</code> - Map zone<br />
* <code>.cpeg_pc, cvbm_pc</code> - Texture cpu file<br />
* <code>.gpeg_pc, gvbm_pc</code> - Texture gpu file<br />
* <code>.asm_pc</code> - Asset assembler file<br />
* <code>.csmesh_pc</code> - Static mesh cpu file<br />
* <code>.gsmesh_pc</code> - Static mesh gpu file<br />
* <code>.ccmesh_pc</code> - Character mesh cpu file<br />
* <code>.gcmesh_pc</code> - Character mesh gpu file<br />
* <code>.ccar_pc</code> - Vehicle mesh cpu file<br />
* <code>.gcar_pc</code> - Vehicle mesh gpu file<br />
* <code>.anim_pc</code> - Animation<br />
* <code>.cchk_pc</code> - Destructible object cpu file<br />
* <code>.gchk_pc</code> - Destructible object gpu file<br />
* <code>.cefct_pc</code> - Visual effect cpu file<br />
* <code>.gefct_pc</code> - Visual effect gpu file<br />
* <code>.cfmesh_pc</code> - Foliage mesh<br />
* <code>.cstch</code> - Terrain clutter mesh cpu file<br />
* <code>.gstch</code> - Terrain clutter mesh gpu file<br />
* <code>.cterrain_pc</code> - Terrain zone cpu file<br />
* <code>.gterrain_pc</code> - Terrain zone gpu file<br />
* <code>.ctmesh_pc</code> - Terrain subzone cpu file<br />
* <code>.gtmesh_pc</code> - Terrain subzone gpu file<br />
* <code>.fsmib</code> - Fullscreen map data<br />
* <code>.fxo_kg</code> - Shader<br />
* <code>.le_strings</code> - Steam localization strings<br />
* <code>.rfglocatext</code> - Localization strings<br />
* <code>.mat_pc</code> - Render material<br />
* <code>.morph_pc</code> - Animation Morph<br />
* <code>.vint_doc</code> - UI<br />
* <code>.sim_pc</code> - Cloth sim<br />
* <code>.xgs_pc</code> - Sound config<br />
* <code>.xsb_pc</code> - Soundbank<br />
* <code>.xwb_pc</code> - Wavebank<br />
* <code>.aud_pc</code> - Audio categories<br />
* <code>.vf3_pc</code> - Font<br />
* <code>.vfdvp_pc</code> - ?<br />
* <code>.rfgvp_pc</code> - ?<br />
<br />
===Red Faction: Guerrilla File Structure===<br />
<br />
\Red Faction Guerrilla Re-MARS-tered\data\<br />
<br />
The two most important files for modding most of RF:G are <code>misc.vpp_pc</code> & <code>table.vpp_pc</code><br />
<br />
* <code>activities.vpp_pc</code> - contains textures for singleplayer activities<br />
* <code>anims.vpp_pc</code> - contains animation files<br />
* <code>chunks.vpp_pc</code> - contains <code>.rfgchunkx</code> files and seems to be related to the <code>preload_chunks.xtbl</code> file, it's possible to add them to a map using the correct <code>dest_checksum</code> & <code>uid</code> numbers. Game might also spawn <code>missing_chunk</code> or <code>missing_destroyable</code> if a mesh fails to load.<br />
* <code>cloth_sim.vpp_pc</code> - contains cloth simulation files<br />
* <code>decals.vpp_pc</code> - contains decal textures<br />
* <code>dlc01_l0.vpp_pc</code> - singleplayer DLC map<br />
* <code>dlc01_l1.vpp_pc</code> - only contains a blank <code>asm_pc</code> file<br />
* <code>dlc01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer DLC map<br />
* <code>dlcp01_activities.vpp_pc</code> - contains textures for singleplayer DLC activities<br />
* <code>dlcp01_anims.vpp_pc</code> - contains animation files for singleplayer DLC<br />
* <code>dlcp01_cloth_sim.vpp_pc</code> - contains cloth simulation files for singleplayer DLC<br />
* <code>dlcp01_effects.vpp_pc</code> - contains visual effect files for singleplayer DLC, some are <code>.str2</code><br />
* <code>dlcp01_humans.vpp_pc</code> - contains textures and meshes for characters in singleplayer DLC<br />
* <code>dlcp01_interface.vpp_pc</code> - contains textures for loading screens & thumbnails in singleplayer DLC<br />
* <code>dlcp01_items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in singleplayer DLC<br />
* <code>dlc01_misc.vpp_pc</code> - contains <code>.rig_pc</code> files, the <code>.fsmib</code> file and two <code>.xtbl</code> files for singleplayer DLC<br />
* <code>dlc01_missions.vpp_pc</code> - contains textures related to singleplayer DLC missions<br />
* <code>dlcp01_personas_en_us.vpp_pc</code> - <br />
* <code>dlcp01_vehicles.vpp_pc</code> - contains textures and meshes for singleplayer DLC vehicles<br />
* <code>dlcp01_voices_en_us.vpp_pc</code> -<br />
* <code>dlcp02_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for multiplayer DLC<br />
* <code>dlcp02_misc.vpp_pc</code> - <br />
* <code>dlcp03_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for wrecking crew DLC<br />
* <code>dlcp03_misc.vpp_pc</code> -<br />
* <code>effects.vpp_pc</code> - contains visual effect files, some are <code>.str2</code><br />
* <code>effects_mp.vpp_pc</code> - contains multiplayer only visual effect files, some are <code>.str2</code><br />
* <code>humans.vpp_pc</code> - contains textures and meshes for characters in both singleplayer and multiplayer<br />
* <code>interface.vpp_pc</code> - contains textures for loading screens & thumbnails in both SP and MP and character portraits in multiplayer<br />
* <code>items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in both singleplayer & multiplayer<br />
* <code>items_mp.vpp_pc</code> - contains multiplayer only textures and meshes<br />
* <code>misc.vpp_pc</code> contains <code>.xtbl</code> files and most other file types<br />
* <code>missions.vpp_pc</code> - contains textures for singleplayer missions<br />
* <code>mp_common.vpp_pc</code> - contains textures shared between multiplayer maps<br />
* <code>mp_xxx.vpp_pc</code> - multiplayer maps, excluding <code>mp_common.vpp_pc</code><br />
* <code>mpdlc_xxx.vpp_pc</code> - DLC multiplayer maps<br />
* <code>personas_de_de.vpp_pc</code> -<br />
* <code>personas_en_us.vpp_pc</code> - <br />
* <code>personas_es_es.vpp_pc</code> - <br />
* <code>personas_fr_fr.vpp_pc</code> -<br />
* <code>personas_it_it.vpp_pc</code> -<br />
* <code>personas_ru_ru.vpp_pc</code> -<br />
* <code>rfg_cine_00a.bik_xbox2</code> -<br />
* <code>rfg_cine_01a.bik_xbox2</code> -<br />
* <code>rfg_cine_02a.bik_xbox2</code> -<br />
* <code>rfg_cine_03a.bik_xbox2</code> - <br />
* <code>rfg_cine_03b.bik_xbox2</code> - <br />
* <code>rfg_cine_04a.bik_xbox2</code> - <br />
* <code>rfg_cine_05a.bik_xbox2</code> - <br />
* <code>rfg_cine_06a.bik_xbox2</code> - <br />
* <code>skybox.vpp_pc</code> - contains textures for the skybox like the clouds<br />
* <code>sounds_r.vpp_pc</code> - contains <code>.xmb_pc</code> sound files<br />
* <code>steam.vpp_pc</code> -<br />
* <code>table.vpp_pc</code> - contains only <code>.xtbl</code> files and will overwrite <code>.xtbl</code> files in <code>misc.vpp_pc</code><br />
* <code>terr01_l0.vpp_pc</code> - singleplayer map<br />
* <code>terr01_l1.vpp_pc</code> - singleplayer map<br />
* <code>terr01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer map<br />
* <code>vehicles_r.vpp_pc</code> - contains textures and meshes for singleplayer vehicles<br />
* <code>voices_de_de.vpp_pc</code> - <br />
* <code>voices_en_us.vpp_pc</code> - <br />
* <code>voices_es_es.vpp_pc</code> - <br />
* <code>voices_fr_fr.vpp_pc</code> - <br />
* <code>voices_it_it.vpp_pc</code> - <br />
* <code>voices_ru_ru.vpp_pc</code> -<br />
* <code>wcxxx.vpp_c</code> - wrecking crew maps<br />
* <code>zonescript_dlc01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer DLC map<br />
* <code>zonescript_terr01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer map<br />
* <code>xxx.bik</code> - pre-rendered custscenes<br />
<br />
===Scriptx Functions===<br />
<br />
* [https://www.factionfiles.com/ff.php?action=scriptxfuncs .scriptx functions]<br />
<br />
===Primitive data types & limits===<br />
<br />
* Floats (floating decimal points): Max value <code>3.4028237</code> and move the decimal place right 38 times. Examples: <code>1.0, 0.0</code><br />
* Integer (whole number that could hold a zero, positive or negative value): Max value <code>2147483647</code><br />
* Boolean (truth value with two constants objects True and False , basically a toggle to enable or disable something using "true" or "false"): Examples: <code><Unlocks_Cheat>True</Unlocks_Cheat>, <Unlocks_Cheat>False</Unlocks_Cheat></code><br />
* String (represents a sequence or characters/text): Example: <code><string>OldCoot</string></code><br />
<br />
===sounds_r.vpp_pc Info===<br />
<br />
* S16 = Signed 16 bit<br />
* LE = Little endian<br />
* 2CH = 2 channels (stereo)<br />
<br />
* destruction.xwb_pc - unknown<br />
* dlc01_voc_d01offcam.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01dan.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm02.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm03.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm04.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm05.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm06.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01rfc.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01sam_pcm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01vasha_safe.xwb_pc.en_us.xwb_pc - unknown <br />
* mov_foley.xwb_pc - unknown <br />
* mov_jet_pack.xwb_pc - unknown <br />
* mov_male.xwb_pc - unknown <br />
* mov_npc_male.xwb_pc - unknown <br />
* mp_backpacks.xwb_pc - S16, LE, 2CH. Intermittent static starting ~28sec <br />
* mp_wep.xwb_pc - S16, LE, 2CH. Static at start and end <br />
* mus_briefings.xwb_pc - S16, LE, 2CH. <br />
* mus_demomaster.xwb_pc - S16, LE, 2CH. <br />
* mus_frontend.xwb_pc - S16, LE, 2CH. <br />
* mus_multiplayer.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_01.xwb_pc - S16, LE, 2CH. Static at start, may be header <br />
* mus_progression_02.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_03.xwb_pc - S16, LE, 2CH. <br />
* mus_sting.xwb_pc - S16, LE, 2CH. <br />
* obj_shared_ambient.xwb_pc - unknown<br />
* obj_shared_dth.xwb_pc - unknown <br />
* obj_shared_exp.xwb_pc - unknown<br />
* obj_shared_impact.xwb_pc - unknown <br />
* scripted_raids.xwb_pc - unknown <br />
* system.xwb_pc - S16, LE, 2CH. Mostly static, valid sound in middle <br />
* system_mp.xwb_pc - unknown <br />
* veh_civ_bus.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car1.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car2.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car3.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_flat.xwb_pc - unknown <br />
* veh_civ_flat2.xwb_pc - unknown<br />
* veh_civ_fuel.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_hauler.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_taxi.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_trash.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_walker.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_aax.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_abx.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_apc.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_atank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_htank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_mtank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_scout.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staff.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staffh2h.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_raider.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_atv.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_bull.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_dtruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_etruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_pickup.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_rover.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_roverwk.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supplyrt.xwb_pc - unknown<br />
* veh_min_wlklg.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_wlkmd.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_shared.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* walla.xwb_pc - unknown<br />
* weather.xwb_pc - S16, LE, 2CH.<br />
* wep_rfg.xwb_pc - S16, LE, 2CH. Mostly valid, some static<br />
<br />
===Misc Notes===<br />
<br />
* When repacking <code>.vpp_pc</code> files don't compress and/or condense them if they weren't like that in the vanilla game, it will cause the game to crash. Eg: <code>items.vpp_pc</code>, <code>interface.vpp_pc</code>, map files etc. See the table below.<br />
* When repacking <code>.str2_pc</code> files ensure they are compressed and condensed.<br />
* <code>table.vpp_pc</code> overwrites changes to <code>.xtbl</code> files in <code>misc.vpp_pc</code>. The work around for this with the legacy mod manager is to rename the file however this breaks multiplayer and reduces the stability of the game. You should edit the same <code>.xtbl</code> files in both <code>misc.vpp_pc</code> & <code>table.vpp_pc</code>.<br />
<br />
{| class="wikitable"<br />
|+<br />
|-<br />
! Filename !! Alignment !! Compressed !! Condensed<br />
|-<br />
| ALL .str2 || 0 || Yes || Yes<br />
|-<br />
| MOST .vpp_pc || 2048 || No || No<br />
|-<br />
| dlc01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlcp01_misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| mp_common.vpp_pc || 2048 || Yes || No<br />
|-<br />
| steam.vpp_pc || 2048 || Yes || No<br />
|-<br />
| terr01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_dlc01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_terr01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlc01_l1.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp01_voices_en_us.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp02_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| dlcp03_misc.vpp_pc || 0? || Yes || No<br />
|-<br />
| dlcp01_anims.vpp_pc || 16? || Yes || Yes<br />
|-<br />
| anims.vpp_pc || 16 || Yes || Yes<br />
|-<br />
| table.vpp_pc || 64 || Yes || Yes<br />
|-<br />
| skybox.vpp_pc || 4096 || No || No<br />
|-<br />
| dlcp01_personas_en_us.vpp_pc || 4096 || No || No<br />
<br />
|}<br />
<br />
===Red Faction: Guerrilla Tools===<br />
<br />
* [https://github.com/Moneyl/RfgUtil/releases RfgUtil] - Used for unpacking most file formats and updating <code>.asm_pc</code> files.<br />
* [https://github.com/rfg-modding/Nanoforge/releases Nanoforge Beef] - Multiplayer & wrecking crew map editor, highly recommended to use this version for map editing instead of the C++ versions map editor, however you cannot import & view the singleplayer maps or edit them yet.<br />
* [https://github.com/rfg-modding/Nanoforge/releases/download/v0.21.1/Nanoforge_v0_21_1.zip Nanoforge C++] - Map editor, Mesh viewer, Texture editor, <code>.xtbl</code> editor and much more.<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_tools/mTools.zip mTools] - Drag and drop tool to convert <code>.asm_pc</code> files to XML and vice versa.<br />
* [https://github.com/rsl-dev/RSL/releases RSL] - Script Loader.<br />
* [https://github.com/Moneyl/AsmTool/releases AsmTool]- WIP Tool for modifying <code>.asm_pc</code> files used by Red Faction Guerrilla. This is meant to replace hand editing them, which is very error prone and tedious.<br />
* [https://github.com/rfg-modding/SyncFaction/releases SyncFaction] - Tool for automatically installing the Terraform Patch replaces the legacy mod manager with bug fixes and new features.<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5686 xdelta UI] - GUI for generating <code>.xdelta</code> (binary) patches<br />
* [http://www.ximple.cz/download.php XiMpLe XML Editor] - Lightweight GUI XML Editor that displays XML type files in table grid views.<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_tools/Volition_Table_File_Editor.zip Volition Table File Editor] - GUI for editing <code>.xtbl</code> files.<br />
* [https://jsonformatter.org/xml-formatter XML Formatter] - Use this to format <code>.xtbl</code> files so they are easier to read.<br />
* [https://www.w3schools.com/xml/xml_validator.asp XML Validator] - Use this to validate <code>.xtbl</code> edits, any mistakes you make will crash the game.<br />
* [https://onecompiler.com/lua/3ykpyrhhb LUA Validator] - Useful for validating RSL scripts for errors, note it's safe to ignore <code>attempt to index a nil value (global 'rfg')</code>.<br />
* [https://github.com/rfg-modding/RfgToolsPlusPlus/releases/tag/ExperimentalChunkExtractor_v0.2.0 Building extractor] - Experimental building extractor (.cchk_pc & .gchk_pc files). It isn't able to extract all buildings and it doesn't extract the textures.<br />
* [https://github.com/rfg-modding/RfgToolsPlusPlus/releases/tag/MiscMeshExtractor_V1.1.0 Misc mesh extractor] - Extract miscellaneous mesh formats. For .cfmesh_pc, .cstch_pc, .cefct_pc, and .ccar_pc files. Requires the .NET 7 runtime to run. It doesn't extract the textures.<br />
* [https://www.factionfiles.com/ff.php?action=file&id=8144 RFGR.SaveEditor] - A save editor for Red Faction: Guerrilla Re-Mars-tered. Compatible with GOG and Steam.<br />
* [https://www.factionfiles.com/ff.php?action=file&id=8095 RFGM.Archiver] - Archiver tool for RFG Re-MARS-tered that supports the following formats: VPP, PEG, STR2 & rfglocatext.<br />
* [https://www.factionfiles.com/ff.php?action=file&id=8043 Localization Tool] - A tool made to decode, edit, and encode localization string files (.rfglocatext) for Red Faction: Guerrilla Re-Mars-tered.<br />
<br />
===Useful Software===<br />
<br />
* [https://www.voidtools.com/ Voidtools Everything] - Locate files and folders by name instantly<br />
* [https://www.mythicsoft.com/agentransack/ Agent Ransack] - Bulk search for keywords within unpacked files<br />
* [https://notepad-plus-plus.org/downloads/ Notepad++] - Good text editor for manually editing <code>.xtbl</code> files, set language as XML<br />
<br />
==Tutorials==<br />
*[[Nanoforge xtbl editing]] - How to edit [[.xtbl]] files in Nanoforge.<br />
*[[Nanoforge Texture Editing]] - How to edit textures using Nanoforge.<br />
* XTBL Editing Guide [Placeholder]<br />
* RFGM.Archiver Texture Editing Guide [Placeholder] [Include updating .asm_pc and adding new textures]<br />
<br />
<br />
[[Category: Red Faction: Guerrilla]]<br />
[[Category: RF:G Editing]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Editing_Main_Page&diff=14374RF:G Editing Main Page2024-03-08T17:46:01Z<p>Camo: /* Red Faction: Guerrilla Tools */</p>
<hr />
<div>{{BubbleNav|RFG|no|no}}This will serve as a landing page for all resources related to [[Red Faction: Guerrilla]] editing for the '''Re-Mars-tered Edition'''.<br />
<br />
==External Links==<br />
===Community===<br />
*[https://discord.gg/factionfiles Faction Files Community Discord] - Active Red Faction series community Discord with #map-mod-development channel for community development discussion<br />
*[https://rfg-modding.github.io/SyncFaction/#/modding/intro SyncFaction Modding Intro] - Extensive writeup of all available mod formats and distribution methods. Includes mod examples!<br />
===Downloads===<br />
*[https://www.factionfiles.com/ff.php?action=files FactionFiles.com] - Custom mods, tools, patches, and reference material<br />
*[https://www.nexusmods.com/redfactionguerilla/mods/ Nexus Mods] - Custom mods<br />
*[https://www.nexusmods.com/redfactionguerrillaremarstered/mods/ Nexus Mods Re-Mars-tered] - Custom mods<br />
<br />
==Documentation==<br />
*[[RF:G Map organization]]<br />
*[[Nanoforge basics]]<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail<br />
===Core Concepts===<br />
*[[Red Faction: Guerrilla]]'s level editor is [[CLOE]], which is not publicly available.<br />
<br />
===Red Faction: Guerrilla File Formats===<br />
* <code>.xtbl</code> - XML table files are used to store properties or attributes in Red Faction: Guerrilla. Overall, their function is similar to the <code>.tbl</code> files of Red Faction and Red Faction II.<br />
* <code>.scriptx</code> - Internal XML scripting language file, commonly used for missions and activities<br />
* <code>.dtodx</code> - Weather/lighting file for maps that controls things like fog, tint, ambient colour, eye adaption, bloom, cloud color and speed<br />
* <code>.gtodx</code> - Skybox file for maps that controls things like the sun texture, moon positions and if the horizon mountain texture is enabled<br />
* <code>.vpp_pc</code> - Packfile<br />
* <code>.rigx</code> - Rig<br />
* <code>.str2_pc</code> - Texture Packfile<br />
* <code>.rfgzone_pc</code> - Map zone<br />
* <code>.layer_pc</code> - Map zone<br />
* <code>.cpeg_pc, cvbm_pc</code> - Texture cpu file<br />
* <code>.gpeg_pc, gvbm_pc</code> - Texture gpu file<br />
* <code>.asm_pc</code> - Asset assembler file<br />
* <code>.csmesh_pc</code> - Static mesh cpu file<br />
* <code>.gsmesh_pc</code> - Static mesh gpu file<br />
* <code>.ccmesh_pc</code> - Character mesh cpu file<br />
* <code>.gcmesh_pc</code> - Character mesh gpu file<br />
* <code>.ccar_pc</code> - Vehicle mesh cpu file<br />
* <code>.gcar_pc</code> - Vehicle mesh gpu file<br />
* <code>.anim_pc</code> - Animation<br />
* <code>.cchk_pc</code> - Destructible object cpu file<br />
* <code>.gchk_pc</code> - Destructible object gpu file<br />
* <code>.cefct_pc</code> - Visual effect cpu file<br />
* <code>.gefct_pc</code> - Visual effect gpu file<br />
* <code>.cfmesh_pc</code> - Foliage mesh<br />
* <code>.cstch</code> - Terrain clutter mesh cpu file<br />
* <code>.gstch</code> - Terrain clutter mesh gpu file<br />
* <code>.cterrain_pc</code> - Terrain zone cpu file<br />
* <code>.gterrain_pc</code> - Terrain zone gpu file<br />
* <code>.ctmesh_pc</code> - Terrain subzone cpu file<br />
* <code>.gtmesh_pc</code> - Terrain subzone gpu file<br />
* <code>.fsmib</code> - Fullscreen map data<br />
* <code>.fxo_kg</code> - Shader<br />
* <code>.le_strings</code> - Steam localization strings<br />
* <code>.rfglocatext</code> - Localization strings<br />
* <code>.mat_pc</code> - Render material<br />
* <code>.morph_pc</code> - Animation Morph<br />
* <code>.vint_doc</code> - UI<br />
* <code>.sim_pc</code> - Cloth sim<br />
* <code>.xgs_pc</code> - Sound config<br />
* <code>.xsb_pc</code> - Soundbank<br />
* <code>.xwb_pc</code> - Wavebank<br />
* <code>.aud_pc</code> - Audio categories<br />
* <code>.vf3_pc</code> - Font<br />
* <code>.vfdvp_pc</code> - ?<br />
* <code>.rfgvp_pc</code> - ?<br />
<br />
===Red Faction: Guerrilla File Structure===<br />
<br />
\Red Faction Guerrilla Re-MARS-tered\data\<br />
<br />
The two most important files for modding most of RF:G are <code>misc.vpp_pc</code> & <code>table.vpp_pc</code><br />
<br />
* <code>activities.vpp_pc</code> - contains textures for singleplayer activities<br />
* <code>anims.vpp_pc</code> - contains animation files<br />
* <code>chunks.vpp_pc</code> - contains <code>.rfgchunkx</code> files and seems to be related to the <code>preload_chunks.xtbl</code> file, it's possible to add them to a map using the correct <code>dest_checksum</code> & <code>uid</code> numbers. Game might also spawn <code>missing_chunk</code> or <code>missing_destroyable</code> if a mesh fails to load.<br />
* <code>cloth_sim.vpp_pc</code> - contains cloth simulation files<br />
* <code>decals.vpp_pc</code> - contains decal textures<br />
* <code>dlc01_l0.vpp_pc</code> - singleplayer DLC map<br />
* <code>dlc01_l1.vpp_pc</code> - only contains a blank <code>asm_pc</code> file<br />
* <code>dlc01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer DLC map<br />
* <code>dlcp01_activities.vpp_pc</code> - contains textures for singleplayer DLC activities<br />
* <code>dlcp01_anims.vpp_pc</code> - contains animation files for singleplayer DLC<br />
* <code>dlcp01_cloth_sim.vpp_pc</code> - contains cloth simulation files for singleplayer DLC<br />
* <code>dlcp01_effects.vpp_pc</code> - contains visual effect files for singleplayer DLC, some are <code>.str2</code><br />
* <code>dlcp01_humans.vpp_pc</code> - contains textures and meshes for characters in singleplayer DLC<br />
* <code>dlcp01_interface.vpp_pc</code> - contains textures for loading screens & thumbnails in singleplayer DLC<br />
* <code>dlcp01_items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in singleplayer DLC<br />
* <code>dlc01_misc.vpp_pc</code> - contains <code>.rig_pc</code> files, the <code>.fsmib</code> file and two <code>.xtbl</code> files for singleplayer DLC<br />
* <code>dlc01_missions.vpp_pc</code> - contains textures related to singleplayer DLC missions<br />
* <code>dlcp01_personas_en_us.vpp_pc</code> - <br />
* <code>dlcp01_vehicles.vpp_pc</code> - contains textures and meshes for singleplayer DLC vehicles<br />
* <code>dlcp01_voices_en_us.vpp_pc</code> -<br />
* <code>dlcp02_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for multiplayer DLC<br />
* <code>dlcp02_misc.vpp_pc</code> - <br />
* <code>dlcp03_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for wrecking crew DLC<br />
* <code>dlcp03_misc.vpp_pc</code> -<br />
* <code>effects.vpp_pc</code> - contains visual effect files, some are <code>.str2</code><br />
* <code>effects_mp.vpp_pc</code> - contains multiplayer only visual effect files, some are <code>.str2</code><br />
* <code>humans.vpp_pc</code> - contains textures and meshes for characters in both singleplayer and multiplayer<br />
* <code>interface.vpp_pc</code> - contains textures for loading screens & thumbnails in both SP and MP and character portraits in multiplayer<br />
* <code>items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in both singleplayer & multiplayer<br />
* <code>items_mp.vpp_pc</code> - contains multiplayer only textures and meshes<br />
* <code>misc.vpp_pc</code> contains <code>.xtbl</code> files and most other file types<br />
* <code>missions.vpp_pc</code> - contains textures for singleplayer missions<br />
* <code>mp_common.vpp_pc</code> - contains textures shared between multiplayer maps<br />
* <code>mp_xxx.vpp_pc</code> - multiplayer maps, excluding <code>mp_common.vpp_pc</code><br />
* <code>mpdlc_xxx.vpp_pc</code> - DLC multiplayer maps<br />
* <code>personas_de_de.vpp_pc</code> -<br />
* <code>personas_en_us.vpp_pc</code> - <br />
* <code>personas_es_es.vpp_pc</code> - <br />
* <code>personas_fr_fr.vpp_pc</code> -<br />
* <code>personas_it_it.vpp_pc</code> -<br />
* <code>personas_ru_ru.vpp_pc</code> -<br />
* <code>rfg_cine_00a.bik_xbox2</code> -<br />
* <code>rfg_cine_01a.bik_xbox2</code> -<br />
* <code>rfg_cine_02a.bik_xbox2</code> -<br />
* <code>rfg_cine_03a.bik_xbox2</code> - <br />
* <code>rfg_cine_03b.bik_xbox2</code> - <br />
* <code>rfg_cine_04a.bik_xbox2</code> - <br />
* <code>rfg_cine_05a.bik_xbox2</code> - <br />
* <code>rfg_cine_06a.bik_xbox2</code> - <br />
* <code>skybox.vpp_pc</code> - contains textures for the skybox like the clouds<br />
* <code>sounds_r.vpp_pc</code> - contains <code>.xmb_pc</code> sound files<br />
* <code>steam.vpp_pc</code> -<br />
* <code>table.vpp_pc</code> - contains only <code>.xtbl</code> files and will overwrite <code>.xtbl</code> files in <code>misc.vpp_pc</code><br />
* <code>terr01_l0.vpp_pc</code> - singleplayer map<br />
* <code>terr01_l1.vpp_pc</code> - singleplayer map<br />
* <code>terr01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer map<br />
* <code>vehicles_r.vpp_pc</code> - contains textures and meshes for singleplayer vehicles<br />
* <code>voices_de_de.vpp_pc</code> - <br />
* <code>voices_en_us.vpp_pc</code> - <br />
* <code>voices_es_es.vpp_pc</code> - <br />
* <code>voices_fr_fr.vpp_pc</code> - <br />
* <code>voices_it_it.vpp_pc</code> - <br />
* <code>voices_ru_ru.vpp_pc</code> -<br />
* <code>wcxxx.vpp_c</code> - wrecking crew maps<br />
* <code>zonescript_dlc01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer DLC map<br />
* <code>zonescript_terr01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer map<br />
* <code>xxx.bik</code> - pre-rendered custscenes<br />
<br />
===Scriptx Functions===<br />
<br />
* [https://www.factionfiles.com/ff.php?action=scriptxfuncs .scriptx functions]<br />
<br />
===Primitive data types & limits===<br />
<br />
* Floats (floating decimal points): Max value <code>3.4028237</code> and move the decimal place right 38 times. Examples: <code>1.0, 0.0</code><br />
* Integer (whole number that could hold a zero, positive or negative value): Max value <code>2147483647</code><br />
* Boolean (truth value with two constants objects True and False , basically a toggle to enable or disable something using "true" or "false"): Examples: <code><Unlocks_Cheat>True</Unlocks_Cheat>, <Unlocks_Cheat>False</Unlocks_Cheat></code><br />
* String (represents a sequence or characters/text): Example: <code><string>OldCoot</string></code><br />
<br />
===sounds_r.vpp_pc Info===<br />
<br />
* S16 = Signed 16 bit<br />
* LE = Little endian<br />
* 2CH = 2 channels (stereo)<br />
<br />
* destruction.xwb_pc - unknown<br />
* dlc01_voc_d01offcam.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01dan.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm02.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm03.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm04.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm05.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm06.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01rfc.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01sam_pcm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01vasha_safe.xwb_pc.en_us.xwb_pc - unknown <br />
* mov_foley.xwb_pc - unknown <br />
* mov_jet_pack.xwb_pc - unknown <br />
* mov_male.xwb_pc - unknown <br />
* mov_npc_male.xwb_pc - unknown <br />
* mp_backpacks.xwb_pc - S16, LE, 2CH. Intermittent static starting ~28sec <br />
* mp_wep.xwb_pc - S16, LE, 2CH. Static at start and end <br />
* mus_briefings.xwb_pc - S16, LE, 2CH. <br />
* mus_demomaster.xwb_pc - S16, LE, 2CH. <br />
* mus_frontend.xwb_pc - S16, LE, 2CH. <br />
* mus_multiplayer.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_01.xwb_pc - S16, LE, 2CH. Static at start, may be header <br />
* mus_progression_02.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_03.xwb_pc - S16, LE, 2CH. <br />
* mus_sting.xwb_pc - S16, LE, 2CH. <br />
* obj_shared_ambient.xwb_pc - unknown<br />
* obj_shared_dth.xwb_pc - unknown <br />
* obj_shared_exp.xwb_pc - unknown<br />
* obj_shared_impact.xwb_pc - unknown <br />
* scripted_raids.xwb_pc - unknown <br />
* system.xwb_pc - S16, LE, 2CH. Mostly static, valid sound in middle <br />
* system_mp.xwb_pc - unknown <br />
* veh_civ_bus.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car1.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car2.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car3.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_flat.xwb_pc - unknown <br />
* veh_civ_flat2.xwb_pc - unknown<br />
* veh_civ_fuel.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_hauler.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_taxi.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_trash.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_walker.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_aax.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_abx.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_apc.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_atank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_htank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_mtank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_scout.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staff.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staffh2h.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_raider.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_atv.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_bull.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_dtruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_etruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_pickup.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_rover.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_roverwk.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supplyrt.xwb_pc - unknown<br />
* veh_min_wlklg.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_wlkmd.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_shared.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* walla.xwb_pc - unknown<br />
* weather.xwb_pc - S16, LE, 2CH.<br />
* wep_rfg.xwb_pc - S16, LE, 2CH. Mostly valid, some static<br />
<br />
===RfgUtil Guide===<br />
<br />
* Unpacking [Placeholder]<br />
* Repacking [Placeholder]<br />
* Command arguments [Placeholder]<br />
* Scripts [Placeholder]<br />
* Updating <code>.asm_pc</code> files [Placeholder]<br />
<br />
===Misc Notes===<br />
<br />
* When repacking <code>.vpp_pc</code> files don't compress and/or condense them if they weren't like that in the vanilla game, it will cause the game to crash. Eg: <code>items.vpp_pc</code>, <code>interface.vpp_pc</code>, map files etc. See the table below.<br />
* When repacking <code>.str2_pc</code> files ensure they are compressed and condensed.<br />
* <code>table.vpp_pc</code> overwrites changes to <code>.xtbl</code> files in <code>misc.vpp_pc</code>. The work around for this with the legacy mod manager is to rename the file however this breaks multiplayer and reduces the stability of the game. You should edit the same <code>.xtbl</code> files in both <code>misc.vpp_pc</code> & <code>table.vpp_pc</code>.<br />
<br />
{| class="wikitable"<br />
|+<br />
|-<br />
! Filename !! Alignment !! Compressed !! Condensed<br />
|-<br />
| ALL .str2 || 0 || Yes || Yes<br />
|-<br />
| MOST .vpp_pc || 2048 || No || No<br />
|-<br />
| dlc01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlcp01_misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| mp_common.vpp_pc || 2048 || Yes || No<br />
|-<br />
| steam.vpp_pc || 2048 || Yes || No<br />
|-<br />
| terr01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_dlc01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_terr01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlc01_l1.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp01_voices_en_us.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp02_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| dlcp03_misc.vpp_pc || 0? || Yes || No<br />
|-<br />
| dlcp01_anims.vpp_pc || 16? || Yes || Yes<br />
|-<br />
| anims.vpp_pc || 16 || Yes || Yes<br />
|-<br />
| table.vpp_pc || 64 || Yes || Yes<br />
|-<br />
| skybox.vpp_pc || 4096 || No || No<br />
|-<br />
| dlcp01_personas_en_us.vpp_pc || 4096 || No || No<br />
<br />
|}<br />
<br />
===Red Faction: Guerrilla Tools===<br />
<br />
* [https://github.com/Moneyl/RfgUtil/releases RfgUtil] - Used for unpacking most file formats and updating <code>.asm_pc</code> files<br />
* [https://github.com/rfg-modding/Nanoforge/releases Nanoforge] - Map editor, texture editor, <code>.xtbl</code> editor and more<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_tools/mTools.zip mTools] - Drag and drop tool to convert <code>.asm_pc</code> files to XML and vice versa<br />
* [https://github.com/rsl-dev/RSL/releases RSL] - Script Loader<br />
* [https://github.com/Moneyl/AsmTool/releases AsmTool]- WIP Tool for modifying <code>.asm_pc</code> files used by Red Faction Guerrilla. This is meant to replace hand editing them, which is very error prone and tedious<br />
* [https://github.com/rfg-modding/SyncFaction/releases SyncFaction] - Tool for automatically installing the Terraform Patch replaces the legacy mod manager with bug fixes and new features<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5686 xdelta UI] - GUI for generating <code>.xdelta</code> (binary) patches<br />
* [http://www.ximple.cz/download.php XiMpLe XML Editor] - Lightweight GUI XML Editor that displays XML type files in a table grid views and shows what other <code>.xtbls</code> it is referencing. Very useful for understanding and editing <code>.xtbl</code> files.<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_tools/Volition_Table_File_Editor.zip Volition Table File Editor] - GUI for editing <code>.xtbl</code> files<br />
* [https://jsonformatter.org/xml-formatter XML Formatter] - Use this to format <code>.xtbl</code> files so they are easier to read<br />
* [https://www.w3schools.com/xml/xml_validator.asp XML Validator] - Use this to validate <code>.xtbl</code> edits, any mistakes you make will crash the game<br />
* [https://onecompiler.com/lua/3ykpyrhhb LUA Validator] - Useful for validating RSL scripts for errors, note it's safe to ignore <code>attempt to index a nil value (global 'rfg')</code><br />
* [https://github.com/rfg-modding/RfgToolsPlusPlus/releases/tag/ExperimentalChunkExtractor_v0.2.0 Building extractor] - Experimental building extractor (.cchk_pc & .gchk_pc files). It isn't able to extract all buildings and it doesn't extract the textures.<br />
* [https://github.com/rfg-modding/RfgToolsPlusPlus/releases/tag/MiscMeshExtractor_V1.1.0 Misc mesh extractor] - Extractor miscellaneous mesh formats. For .cfmesh_pc, .cstch_pc, .cefct_pc, and .ccar_pc files. Requires the .NET 7 runtime to run. It doesn't extract the textures.<br />
<br />
===Useful Software===<br />
<br />
* [https://www.voidtools.com/ Voidtools Everything] - Locate files and folders by name instantly<br />
* [https://www.mythicsoft.com/agentransack/ Agent Ransack] - Bulk search for keywords within unpacked files<br />
* [https://notepad-plus-plus.org/downloads/ Notepad++] - Good text editor for manually editing <code>.xtbl</code> files, set language as XML<br />
<br />
==Tutorials==<br />
*[[Nanoforge xtbl editing]] - How to edit [[.xtbl]] files in Nanoforge.<br />
*[[Nanoforge Texture Editing]] - How to edit textures using Nanoforge.<br />
* XTBL Editing Guides [Placeholder]<br />
<br />
<br />
[[Category: Red Faction: Guerrilla]]<br />
[[Category: RF:G Editing]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Editing_Main_Page&diff=14373RF:G Editing Main Page2024-03-08T17:44:51Z<p>Camo: /* Red Faction: Guerrilla Tools */</p>
<hr />
<div>{{BubbleNav|RFG|no|no}}This will serve as a landing page for all resources related to [[Red Faction: Guerrilla]] editing for the '''Re-Mars-tered Edition'''.<br />
<br />
==External Links==<br />
===Community===<br />
*[https://discord.gg/factionfiles Faction Files Community Discord] - Active Red Faction series community Discord with #map-mod-development channel for community development discussion<br />
*[https://rfg-modding.github.io/SyncFaction/#/modding/intro SyncFaction Modding Intro] - Extensive writeup of all available mod formats and distribution methods. Includes mod examples!<br />
===Downloads===<br />
*[https://www.factionfiles.com/ff.php?action=files FactionFiles.com] - Custom mods, tools, patches, and reference material<br />
*[https://www.nexusmods.com/redfactionguerilla/mods/ Nexus Mods] - Custom mods<br />
*[https://www.nexusmods.com/redfactionguerrillaremarstered/mods/ Nexus Mods Re-Mars-tered] - Custom mods<br />
<br />
==Documentation==<br />
*[[RF:G Map organization]]<br />
*[[Nanoforge basics]]<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail<br />
===Core Concepts===<br />
*[[Red Faction: Guerrilla]]'s level editor is [[CLOE]], which is not publicly available.<br />
<br />
===Red Faction: Guerrilla File Formats===<br />
* <code>.xtbl</code> - XML table files are used to store properties or attributes in Red Faction: Guerrilla. Overall, their function is similar to the <code>.tbl</code> files of Red Faction and Red Faction II.<br />
* <code>.scriptx</code> - Internal XML scripting language file, commonly used for missions and activities<br />
* <code>.dtodx</code> - Weather/lighting file for maps that controls things like fog, tint, ambient colour, eye adaption, bloom, cloud color and speed<br />
* <code>.gtodx</code> - Skybox file for maps that controls things like the sun texture, moon positions and if the horizon mountain texture is enabled<br />
* <code>.vpp_pc</code> - Packfile<br />
* <code>.rigx</code> - Rig<br />
* <code>.str2_pc</code> - Texture Packfile<br />
* <code>.rfgzone_pc</code> - Map zone<br />
* <code>.layer_pc</code> - Map zone<br />
* <code>.cpeg_pc, cvbm_pc</code> - Texture cpu file<br />
* <code>.gpeg_pc, gvbm_pc</code> - Texture gpu file<br />
* <code>.asm_pc</code> - Asset assembler file<br />
* <code>.csmesh_pc</code> - Static mesh cpu file<br />
* <code>.gsmesh_pc</code> - Static mesh gpu file<br />
* <code>.ccmesh_pc</code> - Character mesh cpu file<br />
* <code>.gcmesh_pc</code> - Character mesh gpu file<br />
* <code>.ccar_pc</code> - Vehicle mesh cpu file<br />
* <code>.gcar_pc</code> - Vehicle mesh gpu file<br />
* <code>.anim_pc</code> - Animation<br />
* <code>.cchk_pc</code> - Destructible object cpu file<br />
* <code>.gchk_pc</code> - Destructible object gpu file<br />
* <code>.cefct_pc</code> - Visual effect cpu file<br />
* <code>.gefct_pc</code> - Visual effect gpu file<br />
* <code>.cfmesh_pc</code> - Foliage mesh<br />
* <code>.cstch</code> - Terrain clutter mesh cpu file<br />
* <code>.gstch</code> - Terrain clutter mesh gpu file<br />
* <code>.cterrain_pc</code> - Terrain zone cpu file<br />
* <code>.gterrain_pc</code> - Terrain zone gpu file<br />
* <code>.ctmesh_pc</code> - Terrain subzone cpu file<br />
* <code>.gtmesh_pc</code> - Terrain subzone gpu file<br />
* <code>.fsmib</code> - Fullscreen map data<br />
* <code>.fxo_kg</code> - Shader<br />
* <code>.le_strings</code> - Steam localization strings<br />
* <code>.rfglocatext</code> - Localization strings<br />
* <code>.mat_pc</code> - Render material<br />
* <code>.morph_pc</code> - Animation Morph<br />
* <code>.vint_doc</code> - UI<br />
* <code>.sim_pc</code> - Cloth sim<br />
* <code>.xgs_pc</code> - Sound config<br />
* <code>.xsb_pc</code> - Soundbank<br />
* <code>.xwb_pc</code> - Wavebank<br />
* <code>.aud_pc</code> - Audio categories<br />
* <code>.vf3_pc</code> - Font<br />
* <code>.vfdvp_pc</code> - ?<br />
* <code>.rfgvp_pc</code> - ?<br />
<br />
===Red Faction: Guerrilla File Structure===<br />
<br />
\Red Faction Guerrilla Re-MARS-tered\data\<br />
<br />
The two most important files for modding most of RF:G are <code>misc.vpp_pc</code> & <code>table.vpp_pc</code><br />
<br />
* <code>activities.vpp_pc</code> - contains textures for singleplayer activities<br />
* <code>anims.vpp_pc</code> - contains animation files<br />
* <code>chunks.vpp_pc</code> - contains <code>.rfgchunkx</code> files and seems to be related to the <code>preload_chunks.xtbl</code> file, it's possible to add them to a map using the correct <code>dest_checksum</code> & <code>uid</code> numbers. Game might also spawn <code>missing_chunk</code> or <code>missing_destroyable</code> if a mesh fails to load.<br />
* <code>cloth_sim.vpp_pc</code> - contains cloth simulation files<br />
* <code>decals.vpp_pc</code> - contains decal textures<br />
* <code>dlc01_l0.vpp_pc</code> - singleplayer DLC map<br />
* <code>dlc01_l1.vpp_pc</code> - only contains a blank <code>asm_pc</code> file<br />
* <code>dlc01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer DLC map<br />
* <code>dlcp01_activities.vpp_pc</code> - contains textures for singleplayer DLC activities<br />
* <code>dlcp01_anims.vpp_pc</code> - contains animation files for singleplayer DLC<br />
* <code>dlcp01_cloth_sim.vpp_pc</code> - contains cloth simulation files for singleplayer DLC<br />
* <code>dlcp01_effects.vpp_pc</code> - contains visual effect files for singleplayer DLC, some are <code>.str2</code><br />
* <code>dlcp01_humans.vpp_pc</code> - contains textures and meshes for characters in singleplayer DLC<br />
* <code>dlcp01_interface.vpp_pc</code> - contains textures for loading screens & thumbnails in singleplayer DLC<br />
* <code>dlcp01_items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in singleplayer DLC<br />
* <code>dlc01_misc.vpp_pc</code> - contains <code>.rig_pc</code> files, the <code>.fsmib</code> file and two <code>.xtbl</code> files for singleplayer DLC<br />
* <code>dlc01_missions.vpp_pc</code> - contains textures related to singleplayer DLC missions<br />
* <code>dlcp01_personas_en_us.vpp_pc</code> - <br />
* <code>dlcp01_vehicles.vpp_pc</code> - contains textures and meshes for singleplayer DLC vehicles<br />
* <code>dlcp01_voices_en_us.vpp_pc</code> -<br />
* <code>dlcp02_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for multiplayer DLC<br />
* <code>dlcp02_misc.vpp_pc</code> - <br />
* <code>dlcp03_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for wrecking crew DLC<br />
* <code>dlcp03_misc.vpp_pc</code> -<br />
* <code>effects.vpp_pc</code> - contains visual effect files, some are <code>.str2</code><br />
* <code>effects_mp.vpp_pc</code> - contains multiplayer only visual effect files, some are <code>.str2</code><br />
* <code>humans.vpp_pc</code> - contains textures and meshes for characters in both singleplayer and multiplayer<br />
* <code>interface.vpp_pc</code> - contains textures for loading screens & thumbnails in both SP and MP and character portraits in multiplayer<br />
* <code>items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in both singleplayer & multiplayer<br />
* <code>items_mp.vpp_pc</code> - contains multiplayer only textures and meshes<br />
* <code>misc.vpp_pc</code> contains <code>.xtbl</code> files and most other file types<br />
* <code>missions.vpp_pc</code> - contains textures for singleplayer missions<br />
* <code>mp_common.vpp_pc</code> - contains textures shared between multiplayer maps<br />
* <code>mp_xxx.vpp_pc</code> - multiplayer maps, excluding <code>mp_common.vpp_pc</code><br />
* <code>mpdlc_xxx.vpp_pc</code> - DLC multiplayer maps<br />
* <code>personas_de_de.vpp_pc</code> -<br />
* <code>personas_en_us.vpp_pc</code> - <br />
* <code>personas_es_es.vpp_pc</code> - <br />
* <code>personas_fr_fr.vpp_pc</code> -<br />
* <code>personas_it_it.vpp_pc</code> -<br />
* <code>personas_ru_ru.vpp_pc</code> -<br />
* <code>rfg_cine_00a.bik_xbox2</code> -<br />
* <code>rfg_cine_01a.bik_xbox2</code> -<br />
* <code>rfg_cine_02a.bik_xbox2</code> -<br />
* <code>rfg_cine_03a.bik_xbox2</code> - <br />
* <code>rfg_cine_03b.bik_xbox2</code> - <br />
* <code>rfg_cine_04a.bik_xbox2</code> - <br />
* <code>rfg_cine_05a.bik_xbox2</code> - <br />
* <code>rfg_cine_06a.bik_xbox2</code> - <br />
* <code>skybox.vpp_pc</code> - contains textures for the skybox like the clouds<br />
* <code>sounds_r.vpp_pc</code> - contains <code>.xmb_pc</code> sound files<br />
* <code>steam.vpp_pc</code> -<br />
* <code>table.vpp_pc</code> - contains only <code>.xtbl</code> files and will overwrite <code>.xtbl</code> files in <code>misc.vpp_pc</code><br />
* <code>terr01_l0.vpp_pc</code> - singleplayer map<br />
* <code>terr01_l1.vpp_pc</code> - singleplayer map<br />
* <code>terr01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer map<br />
* <code>vehicles_r.vpp_pc</code> - contains textures and meshes for singleplayer vehicles<br />
* <code>voices_de_de.vpp_pc</code> - <br />
* <code>voices_en_us.vpp_pc</code> - <br />
* <code>voices_es_es.vpp_pc</code> - <br />
* <code>voices_fr_fr.vpp_pc</code> - <br />
* <code>voices_it_it.vpp_pc</code> - <br />
* <code>voices_ru_ru.vpp_pc</code> -<br />
* <code>wcxxx.vpp_c</code> - wrecking crew maps<br />
* <code>zonescript_dlc01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer DLC map<br />
* <code>zonescript_terr01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer map<br />
* <code>xxx.bik</code> - pre-rendered custscenes<br />
<br />
===Scriptx Functions===<br />
<br />
* [https://www.factionfiles.com/ff.php?action=scriptxfuncs .scriptx functions]<br />
<br />
===Primitive data types & limits===<br />
<br />
* Floats (floating decimal points): Max value <code>3.4028237</code> and move the decimal place right 38 times. Examples: <code>1.0, 0.0</code><br />
* Integer (whole number that could hold a zero, positive or negative value): Max value <code>2147483647</code><br />
* Boolean (truth value with two constants objects True and False , basically a toggle to enable or disable something using "true" or "false"): Examples: <code><Unlocks_Cheat>True</Unlocks_Cheat>, <Unlocks_Cheat>False</Unlocks_Cheat></code><br />
* String (represents a sequence or characters/text): Example: <code><string>OldCoot</string></code><br />
<br />
===sounds_r.vpp_pc Info===<br />
<br />
* S16 = Signed 16 bit<br />
* LE = Little endian<br />
* 2CH = 2 channels (stereo)<br />
<br />
* destruction.xwb_pc - unknown<br />
* dlc01_voc_d01offcam.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01dan.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm02.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm03.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm04.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm05.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm06.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01rfc.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01sam_pcm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01vasha_safe.xwb_pc.en_us.xwb_pc - unknown <br />
* mov_foley.xwb_pc - unknown <br />
* mov_jet_pack.xwb_pc - unknown <br />
* mov_male.xwb_pc - unknown <br />
* mov_npc_male.xwb_pc - unknown <br />
* mp_backpacks.xwb_pc - S16, LE, 2CH. Intermittent static starting ~28sec <br />
* mp_wep.xwb_pc - S16, LE, 2CH. Static at start and end <br />
* mus_briefings.xwb_pc - S16, LE, 2CH. <br />
* mus_demomaster.xwb_pc - S16, LE, 2CH. <br />
* mus_frontend.xwb_pc - S16, LE, 2CH. <br />
* mus_multiplayer.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_01.xwb_pc - S16, LE, 2CH. Static at start, may be header <br />
* mus_progression_02.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_03.xwb_pc - S16, LE, 2CH. <br />
* mus_sting.xwb_pc - S16, LE, 2CH. <br />
* obj_shared_ambient.xwb_pc - unknown<br />
* obj_shared_dth.xwb_pc - unknown <br />
* obj_shared_exp.xwb_pc - unknown<br />
* obj_shared_impact.xwb_pc - unknown <br />
* scripted_raids.xwb_pc - unknown <br />
* system.xwb_pc - S16, LE, 2CH. Mostly static, valid sound in middle <br />
* system_mp.xwb_pc - unknown <br />
* veh_civ_bus.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car1.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car2.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car3.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_flat.xwb_pc - unknown <br />
* veh_civ_flat2.xwb_pc - unknown<br />
* veh_civ_fuel.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_hauler.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_taxi.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_trash.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_walker.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_aax.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_abx.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_apc.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_atank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_htank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_mtank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_scout.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staff.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staffh2h.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_raider.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_atv.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_bull.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_dtruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_etruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_pickup.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_rover.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_roverwk.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supplyrt.xwb_pc - unknown<br />
* veh_min_wlklg.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_wlkmd.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_shared.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* walla.xwb_pc - unknown<br />
* weather.xwb_pc - S16, LE, 2CH.<br />
* wep_rfg.xwb_pc - S16, LE, 2CH. Mostly valid, some static<br />
<br />
===RfgUtil Guide===<br />
<br />
* Unpacking [Placeholder]<br />
* Repacking [Placeholder]<br />
* Command arguments [Placeholder]<br />
* Scripts [Placeholder]<br />
* Updating <code>.asm_pc</code> files [Placeholder]<br />
<br />
===Misc Notes===<br />
<br />
* When repacking <code>.vpp_pc</code> files don't compress and/or condense them if they weren't like that in the vanilla game, it will cause the game to crash. Eg: <code>items.vpp_pc</code>, <code>interface.vpp_pc</code>, map files etc. See the table below.<br />
* When repacking <code>.str2_pc</code> files ensure they are compressed and condensed.<br />
* <code>table.vpp_pc</code> overwrites changes to <code>.xtbl</code> files in <code>misc.vpp_pc</code>. The work around for this with the legacy mod manager is to rename the file however this breaks multiplayer and reduces the stability of the game. You should edit the same <code>.xtbl</code> files in both <code>misc.vpp_pc</code> & <code>table.vpp_pc</code>.<br />
<br />
{| class="wikitable"<br />
|+<br />
|-<br />
! Filename !! Alignment !! Compressed !! Condensed<br />
|-<br />
| ALL .str2 || 0 || Yes || Yes<br />
|-<br />
| MOST .vpp_pc || 2048 || No || No<br />
|-<br />
| dlc01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlcp01_misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| mp_common.vpp_pc || 2048 || Yes || No<br />
|-<br />
| steam.vpp_pc || 2048 || Yes || No<br />
|-<br />
| terr01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_dlc01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_terr01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlc01_l1.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp01_voices_en_us.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp02_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| dlcp03_misc.vpp_pc || 0? || Yes || No<br />
|-<br />
| dlcp01_anims.vpp_pc || 16? || Yes || Yes<br />
|-<br />
| anims.vpp_pc || 16 || Yes || Yes<br />
|-<br />
| table.vpp_pc || 64 || Yes || Yes<br />
|-<br />
| skybox.vpp_pc || 4096 || No || No<br />
|-<br />
| dlcp01_personas_en_us.vpp_pc || 4096 || No || No<br />
<br />
|}<br />
<br />
===Red Faction: Guerrilla Tools===<br />
<br />
* [https://github.com/Moneyl/RfgUtil/releases RfgUtil] - Used for unpacking most file formats and updating <code>.asm_pc</code> files<br />
* [https://github.com/rfg-modding/Nanoforge/releases Nanoforge] - Map editor, texture editor, <code>.xtbl</code> editor and more<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_tools/mTools.zip mTools] - Drag and drop tool to convert <code>.asm_pc</code> files to XML and vice versa<br />
* [https://github.com/rsl-dev/RSL/releases RSL] - Script Loader<br />
* [https://github.com/Moneyl/AsmTool AsmTool]- WIP Tool for modifying <code>.asm_pc</code> files used by Red Faction Guerrilla. This is meant to replace hand editing them, which is very error prone and tedious<br />
* [https://github.com/rfg-modding/SyncFaction/releases SyncFaction] - Tool for automatically installing the Terraform Patch replaces the legacy mod manager with bug fixes and new features<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5686 xdelta UI] - GUI for generating <code>.xdelta</code> (binary) patches<br />
* [http://www.ximple.cz/download.php XiMpLe XML Editor] - Lightweight GUI XML Editor that displays XML type files in a table grid views and shows what other <code>.xtbls</code> it is referencing. Very useful for understanding and editing <code>.xtbl</code> files.<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_tools/Volition_Table_File_Editor.zip Volition Table File Editor] - GUI for editing <code>.xtbl</code> files<br />
* [https://jsonformatter.org/xml-formatter XML Formatter] - Use this to format <code>.xtbl</code> files so they are easier to read<br />
* [https://www.w3schools.com/xml/xml_validator.asp XML Validator] - Use this to validate <code>.xtbl</code> edits, any mistakes you make will crash the game<br />
* [https://onecompiler.com/lua/3ykpyrhhb LUA Validator] - Useful for validating RSL scripts for errors, note it's safe to ignore <code>attempt to index a nil value (global 'rfg')</code><br />
* [https://github.com/rfg-modding/RfgToolsPlusPlus/releases/tag/ExperimentalChunkExtractor_v0.2.0 Building extractor] - Experimental building extractor (.cchk_pc & .gchk_pc files). It isn't able to extract all buildings and it doesn't extract the textures.<br />
* [https://github.com/rfg-modding/RfgToolsPlusPlus/releases/tag/MiscMeshExtractor_V1.1.0 Misc mesh extractor] - Extractor miscellaneous mesh formats. For .cfmesh_pc, .cstch_pc, .cefct_pc, and .ccar_pc files. Requires the .NET 7 runtime to run. It doesn't extract the textures.<br />
<br />
===Useful Software===<br />
<br />
* [https://www.voidtools.com/ Voidtools Everything] - Locate files and folders by name instantly<br />
* [https://www.mythicsoft.com/agentransack/ Agent Ransack] - Bulk search for keywords within unpacked files<br />
* [https://notepad-plus-plus.org/downloads/ Notepad++] - Good text editor for manually editing <code>.xtbl</code> files, set language as XML<br />
<br />
==Tutorials==<br />
*[[Nanoforge xtbl editing]] - How to edit [[.xtbl]] files in Nanoforge.<br />
*[[Nanoforge Texture Editing]] - How to edit textures using Nanoforge.<br />
* XTBL Editing Guides [Placeholder]<br />
<br />
<br />
[[Category: Red Faction: Guerrilla]]<br />
[[Category: RF:G Editing]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Editing_Main_Page&diff=14372RF:G Editing Main Page2024-03-08T17:42:20Z<p>Camo: /* Red Faction: Guerrilla Tools */</p>
<hr />
<div>{{BubbleNav|RFG|no|no}}This will serve as a landing page for all resources related to [[Red Faction: Guerrilla]] editing for the '''Re-Mars-tered Edition'''.<br />
<br />
==External Links==<br />
===Community===<br />
*[https://discord.gg/factionfiles Faction Files Community Discord] - Active Red Faction series community Discord with #map-mod-development channel for community development discussion<br />
*[https://rfg-modding.github.io/SyncFaction/#/modding/intro SyncFaction Modding Intro] - Extensive writeup of all available mod formats and distribution methods. Includes mod examples!<br />
===Downloads===<br />
*[https://www.factionfiles.com/ff.php?action=files FactionFiles.com] - Custom mods, tools, patches, and reference material<br />
*[https://www.nexusmods.com/redfactionguerilla/mods/ Nexus Mods] - Custom mods<br />
*[https://www.nexusmods.com/redfactionguerrillaremarstered/mods/ Nexus Mods Re-Mars-tered] - Custom mods<br />
<br />
==Documentation==<br />
*[[RF:G Map organization]]<br />
*[[Nanoforge basics]]<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail<br />
===Core Concepts===<br />
*[[Red Faction: Guerrilla]]'s level editor is [[CLOE]], which is not publicly available.<br />
<br />
===Red Faction: Guerrilla File Formats===<br />
* <code>.xtbl</code> - XML table files are used to store properties or attributes in Red Faction: Guerrilla. Overall, their function is similar to the <code>.tbl</code> files of Red Faction and Red Faction II.<br />
* <code>.scriptx</code> - Internal XML scripting language file, commonly used for missions and activities<br />
* <code>.dtodx</code> - Weather/lighting file for maps that controls things like fog, tint, ambient colour, eye adaption, bloom, cloud color and speed<br />
* <code>.gtodx</code> - Skybox file for maps that controls things like the sun texture, moon positions and if the horizon mountain texture is enabled<br />
* <code>.vpp_pc</code> - Packfile<br />
* <code>.rigx</code> - Rig<br />
* <code>.str2_pc</code> - Texture Packfile<br />
* <code>.rfgzone_pc</code> - Map zone<br />
* <code>.layer_pc</code> - Map zone<br />
* <code>.cpeg_pc, cvbm_pc</code> - Texture cpu file<br />
* <code>.gpeg_pc, gvbm_pc</code> - Texture gpu file<br />
* <code>.asm_pc</code> - Asset assembler file<br />
* <code>.csmesh_pc</code> - Static mesh cpu file<br />
* <code>.gsmesh_pc</code> - Static mesh gpu file<br />
* <code>.ccmesh_pc</code> - Character mesh cpu file<br />
* <code>.gcmesh_pc</code> - Character mesh gpu file<br />
* <code>.ccar_pc</code> - Vehicle mesh cpu file<br />
* <code>.gcar_pc</code> - Vehicle mesh gpu file<br />
* <code>.anim_pc</code> - Animation<br />
* <code>.cchk_pc</code> - Destructible object cpu file<br />
* <code>.gchk_pc</code> - Destructible object gpu file<br />
* <code>.cefct_pc</code> - Visual effect cpu file<br />
* <code>.gefct_pc</code> - Visual effect gpu file<br />
* <code>.cfmesh_pc</code> - Foliage mesh<br />
* <code>.cstch</code> - Terrain clutter mesh cpu file<br />
* <code>.gstch</code> - Terrain clutter mesh gpu file<br />
* <code>.cterrain_pc</code> - Terrain zone cpu file<br />
* <code>.gterrain_pc</code> - Terrain zone gpu file<br />
* <code>.ctmesh_pc</code> - Terrain subzone cpu file<br />
* <code>.gtmesh_pc</code> - Terrain subzone gpu file<br />
* <code>.fsmib</code> - Fullscreen map data<br />
* <code>.fxo_kg</code> - Shader<br />
* <code>.le_strings</code> - Steam localization strings<br />
* <code>.rfglocatext</code> - Localization strings<br />
* <code>.mat_pc</code> - Render material<br />
* <code>.morph_pc</code> - Animation Morph<br />
* <code>.vint_doc</code> - UI<br />
* <code>.sim_pc</code> - Cloth sim<br />
* <code>.xgs_pc</code> - Sound config<br />
* <code>.xsb_pc</code> - Soundbank<br />
* <code>.xwb_pc</code> - Wavebank<br />
* <code>.aud_pc</code> - Audio categories<br />
* <code>.vf3_pc</code> - Font<br />
* <code>.vfdvp_pc</code> - ?<br />
* <code>.rfgvp_pc</code> - ?<br />
<br />
===Red Faction: Guerrilla File Structure===<br />
<br />
\Red Faction Guerrilla Re-MARS-tered\data\<br />
<br />
The two most important files for modding most of RF:G are <code>misc.vpp_pc</code> & <code>table.vpp_pc</code><br />
<br />
* <code>activities.vpp_pc</code> - contains textures for singleplayer activities<br />
* <code>anims.vpp_pc</code> - contains animation files<br />
* <code>chunks.vpp_pc</code> - contains <code>.rfgchunkx</code> files and seems to be related to the <code>preload_chunks.xtbl</code> file, it's possible to add them to a map using the correct <code>dest_checksum</code> & <code>uid</code> numbers. Game might also spawn <code>missing_chunk</code> or <code>missing_destroyable</code> if a mesh fails to load.<br />
* <code>cloth_sim.vpp_pc</code> - contains cloth simulation files<br />
* <code>decals.vpp_pc</code> - contains decal textures<br />
* <code>dlc01_l0.vpp_pc</code> - singleplayer DLC map<br />
* <code>dlc01_l1.vpp_pc</code> - only contains a blank <code>asm_pc</code> file<br />
* <code>dlc01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer DLC map<br />
* <code>dlcp01_activities.vpp_pc</code> - contains textures for singleplayer DLC activities<br />
* <code>dlcp01_anims.vpp_pc</code> - contains animation files for singleplayer DLC<br />
* <code>dlcp01_cloth_sim.vpp_pc</code> - contains cloth simulation files for singleplayer DLC<br />
* <code>dlcp01_effects.vpp_pc</code> - contains visual effect files for singleplayer DLC, some are <code>.str2</code><br />
* <code>dlcp01_humans.vpp_pc</code> - contains textures and meshes for characters in singleplayer DLC<br />
* <code>dlcp01_interface.vpp_pc</code> - contains textures for loading screens & thumbnails in singleplayer DLC<br />
* <code>dlcp01_items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in singleplayer DLC<br />
* <code>dlc01_misc.vpp_pc</code> - contains <code>.rig_pc</code> files, the <code>.fsmib</code> file and two <code>.xtbl</code> files for singleplayer DLC<br />
* <code>dlc01_missions.vpp_pc</code> - contains textures related to singleplayer DLC missions<br />
* <code>dlcp01_personas_en_us.vpp_pc</code> - <br />
* <code>dlcp01_vehicles.vpp_pc</code> - contains textures and meshes for singleplayer DLC vehicles<br />
* <code>dlcp01_voices_en_us.vpp_pc</code> -<br />
* <code>dlcp02_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for multiplayer DLC<br />
* <code>dlcp02_misc.vpp_pc</code> - <br />
* <code>dlcp03_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for wrecking crew DLC<br />
* <code>dlcp03_misc.vpp_pc</code> -<br />
* <code>effects.vpp_pc</code> - contains visual effect files, some are <code>.str2</code><br />
* <code>effects_mp.vpp_pc</code> - contains multiplayer only visual effect files, some are <code>.str2</code><br />
* <code>humans.vpp_pc</code> - contains textures and meshes for characters in both singleplayer and multiplayer<br />
* <code>interface.vpp_pc</code> - contains textures for loading screens & thumbnails in both SP and MP and character portraits in multiplayer<br />
* <code>items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in both singleplayer & multiplayer<br />
* <code>items_mp.vpp_pc</code> - contains multiplayer only textures and meshes<br />
* <code>misc.vpp_pc</code> contains <code>.xtbl</code> files and most other file types<br />
* <code>missions.vpp_pc</code> - contains textures for singleplayer missions<br />
* <code>mp_common.vpp_pc</code> - contains textures shared between multiplayer maps<br />
* <code>mp_xxx.vpp_pc</code> - multiplayer maps, excluding <code>mp_common.vpp_pc</code><br />
* <code>mpdlc_xxx.vpp_pc</code> - DLC multiplayer maps<br />
* <code>personas_de_de.vpp_pc</code> -<br />
* <code>personas_en_us.vpp_pc</code> - <br />
* <code>personas_es_es.vpp_pc</code> - <br />
* <code>personas_fr_fr.vpp_pc</code> -<br />
* <code>personas_it_it.vpp_pc</code> -<br />
* <code>personas_ru_ru.vpp_pc</code> -<br />
* <code>rfg_cine_00a.bik_xbox2</code> -<br />
* <code>rfg_cine_01a.bik_xbox2</code> -<br />
* <code>rfg_cine_02a.bik_xbox2</code> -<br />
* <code>rfg_cine_03a.bik_xbox2</code> - <br />
* <code>rfg_cine_03b.bik_xbox2</code> - <br />
* <code>rfg_cine_04a.bik_xbox2</code> - <br />
* <code>rfg_cine_05a.bik_xbox2</code> - <br />
* <code>rfg_cine_06a.bik_xbox2</code> - <br />
* <code>skybox.vpp_pc</code> - contains textures for the skybox like the clouds<br />
* <code>sounds_r.vpp_pc</code> - contains <code>.xmb_pc</code> sound files<br />
* <code>steam.vpp_pc</code> -<br />
* <code>table.vpp_pc</code> - contains only <code>.xtbl</code> files and will overwrite <code>.xtbl</code> files in <code>misc.vpp_pc</code><br />
* <code>terr01_l0.vpp_pc</code> - singleplayer map<br />
* <code>terr01_l1.vpp_pc</code> - singleplayer map<br />
* <code>terr01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer map<br />
* <code>vehicles_r.vpp_pc</code> - contains textures and meshes for singleplayer vehicles<br />
* <code>voices_de_de.vpp_pc</code> - <br />
* <code>voices_en_us.vpp_pc</code> - <br />
* <code>voices_es_es.vpp_pc</code> - <br />
* <code>voices_fr_fr.vpp_pc</code> - <br />
* <code>voices_it_it.vpp_pc</code> - <br />
* <code>voices_ru_ru.vpp_pc</code> -<br />
* <code>wcxxx.vpp_c</code> - wrecking crew maps<br />
* <code>zonescript_dlc01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer DLC map<br />
* <code>zonescript_terr01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer map<br />
* <code>xxx.bik</code> - pre-rendered custscenes<br />
<br />
===Scriptx Functions===<br />
<br />
* [https://www.factionfiles.com/ff.php?action=scriptxfuncs .scriptx functions]<br />
<br />
===Primitive data types & limits===<br />
<br />
* Floats (floating decimal points): Max value <code>3.4028237</code> and move the decimal place right 38 times. Examples: <code>1.0, 0.0</code><br />
* Integer (whole number that could hold a zero, positive or negative value): Max value <code>2147483647</code><br />
* Boolean (truth value with two constants objects True and False , basically a toggle to enable or disable something using "true" or "false"): Examples: <code><Unlocks_Cheat>True</Unlocks_Cheat>, <Unlocks_Cheat>False</Unlocks_Cheat></code><br />
* String (represents a sequence or characters/text): Example: <code><string>OldCoot</string></code><br />
<br />
===sounds_r.vpp_pc Info===<br />
<br />
* S16 = Signed 16 bit<br />
* LE = Little endian<br />
* 2CH = 2 channels (stereo)<br />
<br />
* destruction.xwb_pc - unknown<br />
* dlc01_voc_d01offcam.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01dan.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm02.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm03.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm04.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm05.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm06.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01rfc.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01sam_pcm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01vasha_safe.xwb_pc.en_us.xwb_pc - unknown <br />
* mov_foley.xwb_pc - unknown <br />
* mov_jet_pack.xwb_pc - unknown <br />
* mov_male.xwb_pc - unknown <br />
* mov_npc_male.xwb_pc - unknown <br />
* mp_backpacks.xwb_pc - S16, LE, 2CH. Intermittent static starting ~28sec <br />
* mp_wep.xwb_pc - S16, LE, 2CH. Static at start and end <br />
* mus_briefings.xwb_pc - S16, LE, 2CH. <br />
* mus_demomaster.xwb_pc - S16, LE, 2CH. <br />
* mus_frontend.xwb_pc - S16, LE, 2CH. <br />
* mus_multiplayer.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_01.xwb_pc - S16, LE, 2CH. Static at start, may be header <br />
* mus_progression_02.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_03.xwb_pc - S16, LE, 2CH. <br />
* mus_sting.xwb_pc - S16, LE, 2CH. <br />
* obj_shared_ambient.xwb_pc - unknown<br />
* obj_shared_dth.xwb_pc - unknown <br />
* obj_shared_exp.xwb_pc - unknown<br />
* obj_shared_impact.xwb_pc - unknown <br />
* scripted_raids.xwb_pc - unknown <br />
* system.xwb_pc - S16, LE, 2CH. Mostly static, valid sound in middle <br />
* system_mp.xwb_pc - unknown <br />
* veh_civ_bus.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car1.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car2.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car3.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_flat.xwb_pc - unknown <br />
* veh_civ_flat2.xwb_pc - unknown<br />
* veh_civ_fuel.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_hauler.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_taxi.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_trash.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_walker.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_aax.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_abx.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_apc.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_atank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_htank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_mtank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_scout.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staff.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staffh2h.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_raider.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_atv.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_bull.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_dtruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_etruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_pickup.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_rover.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_roverwk.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supplyrt.xwb_pc - unknown<br />
* veh_min_wlklg.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_wlkmd.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_shared.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* walla.xwb_pc - unknown<br />
* weather.xwb_pc - S16, LE, 2CH.<br />
* wep_rfg.xwb_pc - S16, LE, 2CH. Mostly valid, some static<br />
<br />
===RfgUtil Guide===<br />
<br />
* Unpacking [Placeholder]<br />
* Repacking [Placeholder]<br />
* Command arguments [Placeholder]<br />
* Scripts [Placeholder]<br />
* Updating <code>.asm_pc</code> files [Placeholder]<br />
<br />
===Misc Notes===<br />
<br />
* When repacking <code>.vpp_pc</code> files don't compress and/or condense them if they weren't like that in the vanilla game, it will cause the game to crash. Eg: <code>items.vpp_pc</code>, <code>interface.vpp_pc</code>, map files etc. See the table below.<br />
* When repacking <code>.str2_pc</code> files ensure they are compressed and condensed.<br />
* <code>table.vpp_pc</code> overwrites changes to <code>.xtbl</code> files in <code>misc.vpp_pc</code>. The work around for this with the legacy mod manager is to rename the file however this breaks multiplayer and reduces the stability of the game. You should edit the same <code>.xtbl</code> files in both <code>misc.vpp_pc</code> & <code>table.vpp_pc</code>.<br />
<br />
{| class="wikitable"<br />
|+<br />
|-<br />
! Filename !! Alignment !! Compressed !! Condensed<br />
|-<br />
| ALL .str2 || 0 || Yes || Yes<br />
|-<br />
| MOST .vpp_pc || 2048 || No || No<br />
|-<br />
| dlc01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlcp01_misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| mp_common.vpp_pc || 2048 || Yes || No<br />
|-<br />
| steam.vpp_pc || 2048 || Yes || No<br />
|-<br />
| terr01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_dlc01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_terr01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlc01_l1.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp01_voices_en_us.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp02_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| dlcp03_misc.vpp_pc || 0? || Yes || No<br />
|-<br />
| dlcp01_anims.vpp_pc || 16? || Yes || Yes<br />
|-<br />
| anims.vpp_pc || 16 || Yes || Yes<br />
|-<br />
| table.vpp_pc || 64 || Yes || Yes<br />
|-<br />
| skybox.vpp_pc || 4096 || No || No<br />
|-<br />
| dlcp01_personas_en_us.vpp_pc || 4096 || No || No<br />
<br />
|}<br />
<br />
===Red Faction: Guerrilla Tools===<br />
<br />
* [https://github.com/Moneyl/RfgUtil/releases RfgUtil] - Used for unpacking most file formats and updating <code>.asm_pc</code> files<br />
* [https://github.com/rfg-modding/Nanoforge/releases Nanoforge] - Map editor, texture editor, <code>.xtbl</code> editor and more<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_tools/mTools.zip mTools] - Drag and drop tool to convert <code>.asm_pc</code> files to XML and vice versa<br />
* [https://github.com/rsl-dev/RSL/releases RSL] - Script Loader<br />
* [https://github.com/Moneyl/AsmTool AsmTool]- WIP Tool for modifying <code>.asm_pc</code> files used by Red Faction Guerrilla. This is meant to replace hand editing them, which is very error prone and tedious<br />
* [https://github.com/rfg-modding/SyncFaction/releases SyncFaction] - Tool for automatically installing the Terraform Patch replaces the legacy mod manager with bug fixes and new features<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5686 xdelta UI] - GUI for generating <code>.xdelta</code> (binary) patches<br />
* [http://www.ximple.cz/download.php XiMpLe XML Editor] - Lightweight GUI XML Editor that displays XML type files in a table grid views and shows what other <code>.xtbls</code> it is referencing. Very useful for understanding and editing <code>.xtbl</code> files.<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/Volition_Table_File_Editor.zip Volition Table File Editor] - GUI for editing <code>.xtbl</code> files<br />
* [https://jsonformatter.org/xml-formatter XML Formatter] - Use this to format <code>.xtbl</code> files so they are easier to read<br />
* [https://www.w3schools.com/xml/xml_validator.asp XML Validator] - Use this to validate <code>.xtbl</code> edits, any mistakes you make will crash the game<br />
* [https://onecompiler.com/lua/3ykpyrhhb LUA Validator] - Useful for validating RSL scripts for errors, note it's safe to ignore <code>attempt to index a nil value (global 'rfg')</code><br />
* [https://github.com/rfg-modding/RfgToolsPlusPlus/releases/tag/ExperimentalChunkExtractor_v0.2.0 Building extractor] - Experimental building extractor (.cchk_pc & .gchk_pc files). It isn't able to extract all buildings and it doesn't extract the textures.<br />
* [https://github.com/rfg-modding/RfgToolsPlusPlus/releases/tag/MiscMeshExtractor_V1.1.0 Misc mesh extractor] - Extractor miscellaneous mesh formats. For .cfmesh_pc, .cstch_pc, .cefct_pc, and .ccar_pc files. Requires the .NET 7 runtime to run. It doesn't extract the textures.<br />
<br />
===Useful Software===<br />
<br />
* [https://www.voidtools.com/ Voidtools Everything] - Locate files and folders by name instantly<br />
* [https://www.mythicsoft.com/agentransack/ Agent Ransack] - Bulk search for keywords within unpacked files<br />
* [https://notepad-plus-plus.org/downloads/ Notepad++] - Good text editor for manually editing <code>.xtbl</code> files, set language as XML<br />
<br />
==Tutorials==<br />
*[[Nanoforge xtbl editing]] - How to edit [[.xtbl]] files in Nanoforge.<br />
*[[Nanoforge Texture Editing]] - How to edit textures using Nanoforge.<br />
* XTBL Editing Guides [Placeholder]<br />
<br />
<br />
[[Category: Red Faction: Guerrilla]]<br />
[[Category: RF:G Editing]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Editing_Main_Page&diff=14371RF:G Editing Main Page2024-03-08T17:41:22Z<p>Camo: </p>
<hr />
<div>{{BubbleNav|RFG|no|no}}This will serve as a landing page for all resources related to [[Red Faction: Guerrilla]] editing for the '''Re-Mars-tered Edition'''.<br />
<br />
==External Links==<br />
===Community===<br />
*[https://discord.gg/factionfiles Faction Files Community Discord] - Active Red Faction series community Discord with #map-mod-development channel for community development discussion<br />
*[https://rfg-modding.github.io/SyncFaction/#/modding/intro SyncFaction Modding Intro] - Extensive writeup of all available mod formats and distribution methods. Includes mod examples!<br />
===Downloads===<br />
*[https://www.factionfiles.com/ff.php?action=files FactionFiles.com] - Custom mods, tools, patches, and reference material<br />
*[https://www.nexusmods.com/redfactionguerilla/mods/ Nexus Mods] - Custom mods<br />
*[https://www.nexusmods.com/redfactionguerrillaremarstered/mods/ Nexus Mods Re-Mars-tered] - Custom mods<br />
<br />
==Documentation==<br />
*[[RF:G Map organization]]<br />
*[[Nanoforge basics]]<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail<br />
===Core Concepts===<br />
*[[Red Faction: Guerrilla]]'s level editor is [[CLOE]], which is not publicly available.<br />
<br />
===Red Faction: Guerrilla File Formats===<br />
* <code>.xtbl</code> - XML table files are used to store properties or attributes in Red Faction: Guerrilla. Overall, their function is similar to the <code>.tbl</code> files of Red Faction and Red Faction II.<br />
* <code>.scriptx</code> - Internal XML scripting language file, commonly used for missions and activities<br />
* <code>.dtodx</code> - Weather/lighting file for maps that controls things like fog, tint, ambient colour, eye adaption, bloom, cloud color and speed<br />
* <code>.gtodx</code> - Skybox file for maps that controls things like the sun texture, moon positions and if the horizon mountain texture is enabled<br />
* <code>.vpp_pc</code> - Packfile<br />
* <code>.rigx</code> - Rig<br />
* <code>.str2_pc</code> - Texture Packfile<br />
* <code>.rfgzone_pc</code> - Map zone<br />
* <code>.layer_pc</code> - Map zone<br />
* <code>.cpeg_pc, cvbm_pc</code> - Texture cpu file<br />
* <code>.gpeg_pc, gvbm_pc</code> - Texture gpu file<br />
* <code>.asm_pc</code> - Asset assembler file<br />
* <code>.csmesh_pc</code> - Static mesh cpu file<br />
* <code>.gsmesh_pc</code> - Static mesh gpu file<br />
* <code>.ccmesh_pc</code> - Character mesh cpu file<br />
* <code>.gcmesh_pc</code> - Character mesh gpu file<br />
* <code>.ccar_pc</code> - Vehicle mesh cpu file<br />
* <code>.gcar_pc</code> - Vehicle mesh gpu file<br />
* <code>.anim_pc</code> - Animation<br />
* <code>.cchk_pc</code> - Destructible object cpu file<br />
* <code>.gchk_pc</code> - Destructible object gpu file<br />
* <code>.cefct_pc</code> - Visual effect cpu file<br />
* <code>.gefct_pc</code> - Visual effect gpu file<br />
* <code>.cfmesh_pc</code> - Foliage mesh<br />
* <code>.cstch</code> - Terrain clutter mesh cpu file<br />
* <code>.gstch</code> - Terrain clutter mesh gpu file<br />
* <code>.cterrain_pc</code> - Terrain zone cpu file<br />
* <code>.gterrain_pc</code> - Terrain zone gpu file<br />
* <code>.ctmesh_pc</code> - Terrain subzone cpu file<br />
* <code>.gtmesh_pc</code> - Terrain subzone gpu file<br />
* <code>.fsmib</code> - Fullscreen map data<br />
* <code>.fxo_kg</code> - Shader<br />
* <code>.le_strings</code> - Steam localization strings<br />
* <code>.rfglocatext</code> - Localization strings<br />
* <code>.mat_pc</code> - Render material<br />
* <code>.morph_pc</code> - Animation Morph<br />
* <code>.vint_doc</code> - UI<br />
* <code>.sim_pc</code> - Cloth sim<br />
* <code>.xgs_pc</code> - Sound config<br />
* <code>.xsb_pc</code> - Soundbank<br />
* <code>.xwb_pc</code> - Wavebank<br />
* <code>.aud_pc</code> - Audio categories<br />
* <code>.vf3_pc</code> - Font<br />
* <code>.vfdvp_pc</code> - ?<br />
* <code>.rfgvp_pc</code> - ?<br />
<br />
===Red Faction: Guerrilla File Structure===<br />
<br />
\Red Faction Guerrilla Re-MARS-tered\data\<br />
<br />
The two most important files for modding most of RF:G are <code>misc.vpp_pc</code> & <code>table.vpp_pc</code><br />
<br />
* <code>activities.vpp_pc</code> - contains textures for singleplayer activities<br />
* <code>anims.vpp_pc</code> - contains animation files<br />
* <code>chunks.vpp_pc</code> - contains <code>.rfgchunkx</code> files and seems to be related to the <code>preload_chunks.xtbl</code> file, it's possible to add them to a map using the correct <code>dest_checksum</code> & <code>uid</code> numbers. Game might also spawn <code>missing_chunk</code> or <code>missing_destroyable</code> if a mesh fails to load.<br />
* <code>cloth_sim.vpp_pc</code> - contains cloth simulation files<br />
* <code>decals.vpp_pc</code> - contains decal textures<br />
* <code>dlc01_l0.vpp_pc</code> - singleplayer DLC map<br />
* <code>dlc01_l1.vpp_pc</code> - only contains a blank <code>asm_pc</code> file<br />
* <code>dlc01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer DLC map<br />
* <code>dlcp01_activities.vpp_pc</code> - contains textures for singleplayer DLC activities<br />
* <code>dlcp01_anims.vpp_pc</code> - contains animation files for singleplayer DLC<br />
* <code>dlcp01_cloth_sim.vpp_pc</code> - contains cloth simulation files for singleplayer DLC<br />
* <code>dlcp01_effects.vpp_pc</code> - contains visual effect files for singleplayer DLC, some are <code>.str2</code><br />
* <code>dlcp01_humans.vpp_pc</code> - contains textures and meshes for characters in singleplayer DLC<br />
* <code>dlcp01_interface.vpp_pc</code> - contains textures for loading screens & thumbnails in singleplayer DLC<br />
* <code>dlcp01_items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in singleplayer DLC<br />
* <code>dlc01_misc.vpp_pc</code> - contains <code>.rig_pc</code> files, the <code>.fsmib</code> file and two <code>.xtbl</code> files for singleplayer DLC<br />
* <code>dlc01_missions.vpp_pc</code> - contains textures related to singleplayer DLC missions<br />
* <code>dlcp01_personas_en_us.vpp_pc</code> - <br />
* <code>dlcp01_vehicles.vpp_pc</code> - contains textures and meshes for singleplayer DLC vehicles<br />
* <code>dlcp01_voices_en_us.vpp_pc</code> -<br />
* <code>dlcp02_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for multiplayer DLC<br />
* <code>dlcp02_misc.vpp_pc</code> - <br />
* <code>dlcp03_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for wrecking crew DLC<br />
* <code>dlcp03_misc.vpp_pc</code> -<br />
* <code>effects.vpp_pc</code> - contains visual effect files, some are <code>.str2</code><br />
* <code>effects_mp.vpp_pc</code> - contains multiplayer only visual effect files, some are <code>.str2</code><br />
* <code>humans.vpp_pc</code> - contains textures and meshes for characters in both singleplayer and multiplayer<br />
* <code>interface.vpp_pc</code> - contains textures for loading screens & thumbnails in both SP and MP and character portraits in multiplayer<br />
* <code>items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in both singleplayer & multiplayer<br />
* <code>items_mp.vpp_pc</code> - contains multiplayer only textures and meshes<br />
* <code>misc.vpp_pc</code> contains <code>.xtbl</code> files and most other file types<br />
* <code>missions.vpp_pc</code> - contains textures for singleplayer missions<br />
* <code>mp_common.vpp_pc</code> - contains textures shared between multiplayer maps<br />
* <code>mp_xxx.vpp_pc</code> - multiplayer maps, excluding <code>mp_common.vpp_pc</code><br />
* <code>mpdlc_xxx.vpp_pc</code> - DLC multiplayer maps<br />
* <code>personas_de_de.vpp_pc</code> -<br />
* <code>personas_en_us.vpp_pc</code> - <br />
* <code>personas_es_es.vpp_pc</code> - <br />
* <code>personas_fr_fr.vpp_pc</code> -<br />
* <code>personas_it_it.vpp_pc</code> -<br />
* <code>personas_ru_ru.vpp_pc</code> -<br />
* <code>rfg_cine_00a.bik_xbox2</code> -<br />
* <code>rfg_cine_01a.bik_xbox2</code> -<br />
* <code>rfg_cine_02a.bik_xbox2</code> -<br />
* <code>rfg_cine_03a.bik_xbox2</code> - <br />
* <code>rfg_cine_03b.bik_xbox2</code> - <br />
* <code>rfg_cine_04a.bik_xbox2</code> - <br />
* <code>rfg_cine_05a.bik_xbox2</code> - <br />
* <code>rfg_cine_06a.bik_xbox2</code> - <br />
* <code>skybox.vpp_pc</code> - contains textures for the skybox like the clouds<br />
* <code>sounds_r.vpp_pc</code> - contains <code>.xmb_pc</code> sound files<br />
* <code>steam.vpp_pc</code> -<br />
* <code>table.vpp_pc</code> - contains only <code>.xtbl</code> files and will overwrite <code>.xtbl</code> files in <code>misc.vpp_pc</code><br />
* <code>terr01_l0.vpp_pc</code> - singleplayer map<br />
* <code>terr01_l1.vpp_pc</code> - singleplayer map<br />
* <code>terr01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer map<br />
* <code>vehicles_r.vpp_pc</code> - contains textures and meshes for singleplayer vehicles<br />
* <code>voices_de_de.vpp_pc</code> - <br />
* <code>voices_en_us.vpp_pc</code> - <br />
* <code>voices_es_es.vpp_pc</code> - <br />
* <code>voices_fr_fr.vpp_pc</code> - <br />
* <code>voices_it_it.vpp_pc</code> - <br />
* <code>voices_ru_ru.vpp_pc</code> -<br />
* <code>wcxxx.vpp_c</code> - wrecking crew maps<br />
* <code>zonescript_dlc01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer DLC map<br />
* <code>zonescript_terr01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer map<br />
* <code>xxx.bik</code> - pre-rendered custscenes<br />
<br />
===Scriptx Functions===<br />
<br />
* [https://www.factionfiles.com/ff.php?action=scriptxfuncs .scriptx functions]<br />
<br />
===Primitive data types & limits===<br />
<br />
* Floats (floating decimal points): Max value <code>3.4028237</code> and move the decimal place right 38 times. Examples: <code>1.0, 0.0</code><br />
* Integer (whole number that could hold a zero, positive or negative value): Max value <code>2147483647</code><br />
* Boolean (truth value with two constants objects True and False , basically a toggle to enable or disable something using "true" or "false"): Examples: <code><Unlocks_Cheat>True</Unlocks_Cheat>, <Unlocks_Cheat>False</Unlocks_Cheat></code><br />
* String (represents a sequence or characters/text): Example: <code><string>OldCoot</string></code><br />
<br />
===sounds_r.vpp_pc Info===<br />
<br />
* S16 = Signed 16 bit<br />
* LE = Little endian<br />
* 2CH = 2 channels (stereo)<br />
<br />
* destruction.xwb_pc - unknown<br />
* dlc01_voc_d01offcam.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01dan.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm02.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm03.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm04.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm05.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm06.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01rfc.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01sam_pcm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01vasha_safe.xwb_pc.en_us.xwb_pc - unknown <br />
* mov_foley.xwb_pc - unknown <br />
* mov_jet_pack.xwb_pc - unknown <br />
* mov_male.xwb_pc - unknown <br />
* mov_npc_male.xwb_pc - unknown <br />
* mp_backpacks.xwb_pc - S16, LE, 2CH. Intermittent static starting ~28sec <br />
* mp_wep.xwb_pc - S16, LE, 2CH. Static at start and end <br />
* mus_briefings.xwb_pc - S16, LE, 2CH. <br />
* mus_demomaster.xwb_pc - S16, LE, 2CH. <br />
* mus_frontend.xwb_pc - S16, LE, 2CH. <br />
* mus_multiplayer.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_01.xwb_pc - S16, LE, 2CH. Static at start, may be header <br />
* mus_progression_02.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_03.xwb_pc - S16, LE, 2CH. <br />
* mus_sting.xwb_pc - S16, LE, 2CH. <br />
* obj_shared_ambient.xwb_pc - unknown<br />
* obj_shared_dth.xwb_pc - unknown <br />
* obj_shared_exp.xwb_pc - unknown<br />
* obj_shared_impact.xwb_pc - unknown <br />
* scripted_raids.xwb_pc - unknown <br />
* system.xwb_pc - S16, LE, 2CH. Mostly static, valid sound in middle <br />
* system_mp.xwb_pc - unknown <br />
* veh_civ_bus.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car1.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car2.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car3.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_flat.xwb_pc - unknown <br />
* veh_civ_flat2.xwb_pc - unknown<br />
* veh_civ_fuel.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_hauler.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_taxi.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_trash.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_walker.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_aax.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_abx.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_apc.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_atank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_htank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_mtank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_scout.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staff.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staffh2h.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_raider.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_atv.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_bull.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_dtruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_etruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_pickup.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_rover.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_roverwk.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supplyrt.xwb_pc - unknown<br />
* veh_min_wlklg.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_wlkmd.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_shared.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* walla.xwb_pc - unknown<br />
* weather.xwb_pc - S16, LE, 2CH.<br />
* wep_rfg.xwb_pc - S16, LE, 2CH. Mostly valid, some static<br />
<br />
===RfgUtil Guide===<br />
<br />
* Unpacking [Placeholder]<br />
* Repacking [Placeholder]<br />
* Command arguments [Placeholder]<br />
* Scripts [Placeholder]<br />
* Updating <code>.asm_pc</code> files [Placeholder]<br />
<br />
===Misc Notes===<br />
<br />
* When repacking <code>.vpp_pc</code> files don't compress and/or condense them if they weren't like that in the vanilla game, it will cause the game to crash. Eg: <code>items.vpp_pc</code>, <code>interface.vpp_pc</code>, map files etc. See the table below.<br />
* When repacking <code>.str2_pc</code> files ensure they are compressed and condensed.<br />
* <code>table.vpp_pc</code> overwrites changes to <code>.xtbl</code> files in <code>misc.vpp_pc</code>. The work around for this with the legacy mod manager is to rename the file however this breaks multiplayer and reduces the stability of the game. You should edit the same <code>.xtbl</code> files in both <code>misc.vpp_pc</code> & <code>table.vpp_pc</code>.<br />
<br />
{| class="wikitable"<br />
|+<br />
|-<br />
! Filename !! Alignment !! Compressed !! Condensed<br />
|-<br />
| ALL .str2 || 0 || Yes || Yes<br />
|-<br />
| MOST .vpp_pc || 2048 || No || No<br />
|-<br />
| dlc01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlcp01_misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| mp_common.vpp_pc || 2048 || Yes || No<br />
|-<br />
| steam.vpp_pc || 2048 || Yes || No<br />
|-<br />
| terr01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_dlc01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_terr01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlc01_l1.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp01_voices_en_us.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp02_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| dlcp03_misc.vpp_pc || 0? || Yes || No<br />
|-<br />
| dlcp01_anims.vpp_pc || 16? || Yes || Yes<br />
|-<br />
| anims.vpp_pc || 16 || Yes || Yes<br />
|-<br />
| table.vpp_pc || 64 || Yes || Yes<br />
|-<br />
| skybox.vpp_pc || 4096 || No || No<br />
|-<br />
| dlcp01_personas_en_us.vpp_pc || 4096 || No || No<br />
<br />
|}<br />
<br />
===Red Faction: Guerrilla Tools===<br />
<br />
* [https://github.com/Moneyl/RfgUtil/releases RfgUtil] - Used for unpacking most file formats and updating <code>.asm_pc</code> files<br />
* [https://github.com/rfg-modding/Nanoforge/releases Nanoforge] - Map editor, texture editor, <code>.xtbl</code> editor and more<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/blob/main/z_tools/mTools.zip mTools] - Drag and drop tool to convert <code>.asm_pc</code> files to XML and vice versa<br />
* [https://github.com/rsl-dev/RSL/releases RSL] - Script Loader<br />
* [https://github.com/Moneyl/AsmTool AsmTool]- WIP Tool for modifying <code>.asm_pc</code> files used by Red Faction Guerrilla. This is meant to replace hand editing them, which is very error prone and tedious<br />
* [https://github.com/rfg-modding/SyncFaction/releases SyncFaction] - Tool for automatically installing the Terraform Patch replaces the legacy mod manager with bug fixes and new features<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5686 xdelta UI] - GUI for generating <code>.xdelta</code> (binary) patches<br />
* [http://www.ximple.cz/download.php XiMpLe XML Editor] - Lightweight GUI XML Editor that displays XML type files in a table grid views and shows what other <code>.xtbls</code> it is referencing. Very useful for understanding and editing <code>.xtbl</code> files.<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/Volition_Table_File_Editor.zip Volition Table File Editor] - GUI for editing <code>.xtbl</code> files<br />
* [https://jsonformatter.org/xml-formatter XML Formatter] - Use this to format <code>.xtbl</code> files so they are easier to read<br />
* [https://www.w3schools.com/xml/xml_validator.asp XML Validator] - Use this to validate <code>.xtbl</code> edits, any mistakes you make will crash the game<br />
* [https://onecompiler.com/lua/3ykpyrhhb LUA Validator] - Useful for validating RSL scripts for errors, note it's safe to ignore <code>attempt to index a nil value (global 'rfg')</code><br />
* [https://github.com/rfg-modding/RfgToolsPlusPlus/releases/tag/ExperimentalChunkExtractor_v0.2.0 Building extractor] - Experimental building extractor (.cchk_pc & .gchk_pc files). It isn't able to extract all buildings and it doesn't extract the textures.<br />
* [https://github.com/rfg-modding/RfgToolsPlusPlus/releases/tag/MiscMeshExtractor_V1.1.0 Misc mesh extractor] - Extractor miscellaneous mesh formats. For .cfmesh_pc, .cstch_pc, .cefct_pc, and .ccar_pc files. Requires the .NET 7 runtime to run. It doesn't extract the textures.<br />
<br />
===Useful Software===<br />
<br />
* [https://www.voidtools.com/ Voidtools Everything] - Locate files and folders by name instantly<br />
* [https://www.mythicsoft.com/agentransack/ Agent Ransack] - Bulk search for keywords within unpacked files<br />
* [https://notepad-plus-plus.org/downloads/ Notepad++] - Good text editor for manually editing <code>.xtbl</code> files, set language as XML<br />
<br />
==Tutorials==<br />
*[[Nanoforge xtbl editing]] - How to edit [[.xtbl]] files in Nanoforge.<br />
*[[Nanoforge Texture Editing]] - How to edit textures using Nanoforge.<br />
* XTBL Editing Guides [Placeholder]<br />
<br />
<br />
[[Category: Red Faction: Guerrilla]]<br />
[[Category: RF:G Editing]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Editing_Main_Page&diff=11361RF:G Editing Main Page2024-02-01T05:20:26Z<p>Camo: /* Red Faction: Guerrilla File Formats */</p>
<hr />
<div>{{BubbleNav|RFG|no|no}}This will serve as a landing page for all resources related to [[Red Faction: Guerrilla]] editing for the '''Re-Mars-tered Edition'''.<br />
<br />
==External Links==<br />
===Community===<br />
*[https://discord.gg/factionfiles Faction Files Community Discord] - Active Red Faction series community Discord with #map-mod-development channel for community development discussion<br />
===Downloads===<br />
*[https://www.factionfiles.com/ff.php?action=files FactionFiles.com] - Custom mods, tools, patches, and reference material<br />
*[https://www.nexusmods.com/redfactionguerilla/mods/ Nexus Mods] - Custom mods<br />
*[https://www.nexusmods.com/redfactionguerrillaremarstered/mods/ Nexus Mods Re-Mars-tered] - Custom mods<br />
<br />
==Documentation==<br />
*[[RF:G Map organization]]<br />
*[[Nanoforge basics]]<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail<br />
===Core Concepts===<br />
*[[Red Faction: Guerrilla]]'s level editor is [[CLOE]], which is not publicly available.<br />
<br />
===Red Faction: Guerrilla File Formats===<br />
* <code>.xtbl</code> - XML table files are used to store properties or attributes in Red Faction: Guerrilla. Overall, their function is similar to the <code>.tbl</code> files of Red Faction and Red Faction II.<br />
* <code>.scriptx</code> - Internal XML scripting language file, commonly used for missions and activities<br />
* <code>.dtodx</code> - Weather/lighting file for maps that controls things like fog, tint, ambient colour, eye adaption, bloom, cloud color and speed<br />
* <code>.gtodx</code> - Skybox file for maps that controls things like the sun texture, moon positions and if the horizon mountain texture is enabled<br />
* <code>.vpp_pc</code> - Packfile<br />
* <code>.rigx</code> - Rig<br />
* <code>.str2_pc</code> - Texture Packfile<br />
* <code>.rfgzone_pc</code> - Map zone<br />
* <code>.layer_pc</code> - Map zone<br />
* <code>.cpeg_pc, cvbm_pc</code> - Texture cpu file<br />
* <code>.gpeg_pc, gvbm_pc</code> - Texture gpu file<br />
* <code>.asm_pc</code> - Asset assembler file<br />
* <code>.csmesh_pc</code> - Static mesh cpu file<br />
* <code>.gsmesh_pc</code> - Static mesh gpu file<br />
* <code>.ccmesh_pc</code> - Character mesh cpu file<br />
* <code>.gcmesh_pc</code> - Character mesh gpu file<br />
* <code>.ccar_pc</code> - Vehicle mesh cpu file<br />
* <code>.gcar_pc</code> - Vehicle mesh gpu file<br />
* <code>.anim_pc</code> - Animation<br />
* <code>.cchk_pc</code> - Destructible object cpu file<br />
* <code>.gchk_pc</code> - Destructible object gpu file<br />
* <code>.cefct_pc</code> - Visual effect cpu file<br />
* <code>.gefct_pc</code> - Visual effect gpu file<br />
* <code>.cfmesh_pc</code> - Foliage mesh<br />
* <code>.cstch</code> - Terrain clutter mesh cpu file<br />
* <code>.gstch</code> - Terrain clutter mesh gpu file<br />
* <code>.cterrain_pc</code> - Terrain zone cpu file<br />
* <code>.gterrain_pc</code> - Terrain zone gpu file<br />
* <code>.ctmesh_pc</code> - Terrain subzone cpu file<br />
* <code>.gtmesh_pc</code> - Terrain subzone gpu file<br />
* <code>.fsmib</code> - Fullscreen map data<br />
* <code>.fxo_kg</code> - Shader<br />
* <code>.le_strings</code> - Steam localization strings<br />
* <code>.rfglocatext</code> - Localization strings<br />
* <code>.mat_pc</code> - Render material<br />
* <code>.morph_pc</code> - Animation Morph<br />
* <code>.vint_doc</code> - UI<br />
* <code>.sim_pc</code> - Cloth sim<br />
* <code>.xgs_pc</code> - Sound config<br />
* <code>.xsb_pc</code> - Soundbank<br />
* <code>.xwb_pc</code> - Wavebank<br />
* <code>.aud_pc</code> - Audio categories<br />
* <code>.vf3_pc</code> - Font<br />
* <code>.vfdvp_pc</code> - ?<br />
* <code>.rfgvp_pc</code> - ?<br />
<br />
===Red Faction: Guerrilla File Structure===<br />
<br />
\Red Faction Guerrilla Re-MARS-tered\data\<br />
<br />
The two most important files for modding most of RF:G are <code>misc.vpp_pc</code> & <code>table.vpp_pc</code><br />
<br />
* <code>activities.vpp_pc</code> - contains textures for singleplayer activities<br />
* <code>anims.vpp_pc</code> - contains animation files<br />
* <code>chunks.vpp_pc</code> - contains <code>.rfgchunkx</code> files and seems to be related to the <code>preload_chunks.xtbl</code> file, it's possible to add them to a map using the correct <code>dest_checksum</code> & <code>uid</code> numbers. Game might also spawn <code>missing_chunk</code> or <code>missing_destroyable</code> if a mesh fails to load.<br />
* <code>cloth_sim.vpp_pc</code> - contains cloth simulation files<br />
* <code>decals.vpp_pc</code> - contains decal textures<br />
* <code>dlc01_l0.vpp_pc</code> - singleplayer DLC map<br />
* <code>dlc01_l1.vpp_pc</code> - only contains a blank <code>asm_pc</code> file<br />
* <code>dlc01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer DLC map<br />
* <code>dlcp01_activities.vpp_pc</code> - contains textures for singleplayer DLC activities<br />
* <code>dlcp01_anims.vpp_pc</code> - contains animation files for singleplayer DLC<br />
* <code>dlcp01_cloth_sim.vpp_pc</code> - contains cloth simulation files for singleplayer DLC<br />
* <code>dlcp01_effects.vpp_pc</code> - contains visual effect files for singleplayer DLC, some are <code>.str2</code><br />
* <code>dlcp01_humans.vpp_pc</code> - contains textures and meshes for characters in singleplayer DLC<br />
* <code>dlcp01_interface.vpp_pc</code> - contains textures for loading screens & thumbnails in singleplayer DLC<br />
* <code>dlcp01_items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in singleplayer DLC<br />
* <code>dlc01_misc.vpp_pc</code> - contains <code>.rig_pc</code> files, the <code>.fsmib</code> file and two <code>.xtbl</code> files for singleplayer DLC<br />
* <code>dlc01_missions.vpp_pc</code> - contains textures related to singleplayer DLC missions<br />
* <code>dlcp01_personas_en_us.vpp_pc</code> - <br />
* <code>dlcp01_vehicles.vpp_pc</code> - contains textures and meshes for singleplayer DLC vehicles<br />
* <code>dlcp01_voices_en_us.vpp_pc</code> -<br />
* <code>dlcp02_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for multiplayer DLC<br />
* <code>dlcp02_misc.vpp_pc</code> - <br />
* <code>dlcp03_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for wrecking crew DLC<br />
* <code>dlcp03_misc.vpp_pc</code> -<br />
* <code>effects.vpp_pc</code> - contains visual effect files, some are <code>.str2</code><br />
* <code>effects_mp.vpp_pc</code> - contains multiplayer only visual effect files, some are <code>.str2</code><br />
* <code>humans.vpp_pc</code> - contains textures and meshes for characters in both singleplayer and multiplayer<br />
* <code>interface.vpp_pc</code> - contains textures for loading screens & thumbnails in both SP and MP and character portraits in multiplayer<br />
* <code>items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in both singleplayer & multiplayer<br />
* <code>items_mp.vpp_pc</code> - contains multiplayer only textures and meshes<br />
* <code>misc.vpp_pc</code> contains <code>.xtbl</code> files and most other file types<br />
* <code>missions.vpp_pc</code> - contains textures for singleplayer missions<br />
* <code>mp_common.vpp_pc</code> - contains textures shared between multiplayer maps<br />
* <code>mp_xxx.vpp_pc</code> - multiplayer maps, excluding <code>mp_common.vpp_pc</code><br />
* <code>mpdlc_xxx.vpp_pc</code> - DLC multiplayer maps<br />
* <code>personas_de_de.vpp_pc</code> -<br />
* <code>personas_en_us.vpp_pc</code> - <br />
* <code>personas_es_es.vpp_pc</code> - <br />
* <code>personas_fr_fr.vpp_pc</code> -<br />
* <code>personas_it_it.vpp_pc</code> -<br />
* <code>personas_ru_ru.vpp_pc</code> -<br />
* <code>rfg_cine_00a.bik_xbox2</code> -<br />
* <code>rfg_cine_01a.bik_xbox2</code> -<br />
* <code>rfg_cine_02a.bik_xbox2</code> -<br />
* <code>rfg_cine_03a.bik_xbox2</code> - <br />
* <code>rfg_cine_03b.bik_xbox2</code> - <br />
* <code>rfg_cine_04a.bik_xbox2</code> - <br />
* <code>rfg_cine_05a.bik_xbox2</code> - <br />
* <code>rfg_cine_06a.bik_xbox2</code> - <br />
* <code>skybox.vpp_pc</code> - contains textures for the skybox like the clouds<br />
* <code>sounds_r.vpp_pc</code> - contains <code>.xmb_pc</code> sound files<br />
* <code>steam.vpp_pc</code> -<br />
* <code>table.vpp_pc</code> - contains only <code>.xtbl</code> files and will overwrite <code>.xtbl</code> files in <code>misc.vpp_pc</code><br />
* <code>terr01_l0.vpp_pc</code> - singleplayer map<br />
* <code>terr01_l1.vpp_pc</code> - singleplayer map<br />
* <code>terr01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer map<br />
* <code>vehicles_r.vpp_pc</code> - contains textures and meshes for singleplayer vehicles<br />
* <code>voices_de_de.vpp_pc</code> - <br />
* <code>voices_en_us.vpp_pc</code> - <br />
* <code>voices_es_es.vpp_pc</code> - <br />
* <code>voices_fr_fr.vpp_pc</code> - <br />
* <code>voices_it_it.vpp_pc</code> - <br />
* <code>voices_ru_ru.vpp_pc</code> -<br />
* <code>wcxxx.vpp_c</code> - wrecking crew maps<br />
* <code>zonescript_dlc01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer DLC map<br />
* <code>zonescript_terr01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer map<br />
* <code>xxx.bik</code> - pre-rendered custscenes<br />
<br />
===Scriptx Functions===<br />
<br />
* [https://www.factionfiles.com/ff.php?action=scriptxfuncs .scriptx functions]<br />
<br />
===Primitive data types & limits===<br />
<br />
* Floats (floating decimal points): Max value <code>3.4028237</code> and move the decimal place right 38 times. Examples: <code>1.0, 0.0</code><br />
* Integer (whole number that could hold a zero, positive or negative value): Max value <code>2147483647</code><br />
* Boolean (truth value with two constants objects True and False , basically a toggle to enable or disable something using "true" or "false"): Examples: <code><Unlocks_Cheat>True</Unlocks_Cheat>, <Unlocks_Cheat>False</Unlocks_Cheat></code><br />
* String (represents a sequence or characters/text): Example: <code><string>OldCoot</string></code><br />
<br />
===sounds_r.vpp_pc Info===<br />
<br />
* S16 = Signed 16 bit<br />
* LE = Little endian<br />
* 2CH = 2 channels (stereo)<br />
<br />
* destruction.xwb_pc - unknown<br />
* dlc01_voc_d01offcam.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01dan.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm02.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm03.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm04.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm05.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm06.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01rfc.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01sam_pcm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01vasha_safe.xwb_pc.en_us.xwb_pc - unknown <br />
* mov_foley.xwb_pc - unknown <br />
* mov_jet_pack.xwb_pc - unknown <br />
* mov_male.xwb_pc - unknown <br />
* mov_npc_male.xwb_pc - unknown <br />
* mp_backpacks.xwb_pc - S16, LE, 2CH. Intermittent static starting ~28sec <br />
* mp_wep.xwb_pc - S16, LE, 2CH. Static at start and end <br />
* mus_briefings.xwb_pc - S16, LE, 2CH. <br />
* mus_demomaster.xwb_pc - S16, LE, 2CH. <br />
* mus_frontend.xwb_pc - S16, LE, 2CH. <br />
* mus_multiplayer.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_01.xwb_pc - S16, LE, 2CH. Static at start, may be header <br />
* mus_progression_02.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_03.xwb_pc - S16, LE, 2CH. <br />
* mus_sting.xwb_pc - S16, LE, 2CH. <br />
* obj_shared_ambient.xwb_pc - unknown<br />
* obj_shared_dth.xwb_pc - unknown <br />
* obj_shared_exp.xwb_pc - unknown<br />
* obj_shared_impact.xwb_pc - unknown <br />
* scripted_raids.xwb_pc - unknown <br />
* system.xwb_pc - S16, LE, 2CH. Mostly static, valid sound in middle <br />
* system_mp.xwb_pc - unknown <br />
* veh_civ_bus.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car1.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car2.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car3.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_flat.xwb_pc - unknown <br />
* veh_civ_flat2.xwb_pc - unknown<br />
* veh_civ_fuel.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_hauler.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_taxi.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_trash.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_walker.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_aax.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_abx.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_apc.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_atank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_htank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_mtank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_scout.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staff.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staffh2h.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_raider.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_atv.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_bull.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_dtruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_etruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_pickup.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_rover.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_roverwk.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supplyrt.xwb_pc - unknown<br />
* veh_min_wlklg.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_wlkmd.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_shared.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* walla.xwb_pc - unknown<br />
* weather.xwb_pc - S16, LE, 2CH.<br />
* wep_rfg.xwb_pc - S16, LE, 2CH. Mostly valid, some static<br />
<br />
===RfgUtil Guide===<br />
<br />
* Unpacking [Placeholder]<br />
* Repacking [Placeholder]<br />
* Command arguments [Placeholder]<br />
* Scripts [Placeholder]<br />
* Updating <code>.asm_pc</code> files [Placeholder]<br />
<br />
===Misc Notes===<br />
<br />
* When repacking <code>.vpp_pc</code> files don't compress and/or condense them if they weren't like that in the vanilla game, it will cause the game to crash. Eg: <code>items.vpp_pc</code>, <code>interface.vpp_pc</code>, map files etc. See the table below.<br />
* When repacking <code>.str2_pc</code> files ensure they are compressed and condensed.<br />
* <code>table.vpp_pc</code> overwrites changes to <code>.xtbl</code> files in <code>misc.vpp_pc</code>. The work around for this with the legacy mod manager is to rename the file however this breaks multiplayer and reduces the stability of the game. You should edit the same <code>.xtbl</code> files in both <code>misc.vpp_pc</code> & <code>table.vpp_pc</code>.<br />
<br />
{| class="wikitable"<br />
|+<br />
|-<br />
! Filename !! Alignment !! Compressed !! Condensed<br />
|-<br />
| ALL .str2 || 0 || Yes || Yes<br />
|-<br />
| MOST .vpp_pc || 2048 || No || No<br />
|-<br />
| dlc01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlcp01_misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| mp_common.vpp_pc || 2048 || Yes || No<br />
|-<br />
| steam.vpp_pc || 2048 || Yes || No<br />
|-<br />
| terr01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_dlc01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_terr01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlc01_l1.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp01_voices_en_us.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp02_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| dlcp03_misc.vpp_pc || 0? || Yes || No<br />
|-<br />
| dlcp01_anims.vpp_pc || 16? || Yes || Yes<br />
|-<br />
| anims.vpp_pc || 16 || Yes || Yes<br />
|-<br />
| table.vpp_pc || 64 || Yes || Yes<br />
|-<br />
| skybox.vpp_pc || 4096 || No || No<br />
|-<br />
| dlcp01_personas_en_us.vpp_pc || 4096 || No || No<br />
<br />
|}<br />
<br />
===Red Faction: Guerrilla Tools===<br />
<br />
* [https://github.com/Moneyl/RfgUtil/releases RfgUtil] - Used for unpacking most file formats and updating <code>.asm_pc</code> files<br />
* [https://github.com/Moneyl/Nanoforge/releases Nanoforge C++] - Map editor, texture editor, <code>.xtbl</code> editor and more<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/mTools.zip mTools] - Drag and drop tool to convert <code>.asm_pc</code> files to XML and vice versa<br />
* [https://github.com/rsl-dev/RSL/releases RSL] - Script Loader<br />
* [https://github.com/Moneyl/AsmTool AsmTool]- WIP Tool for modifying <code>.asm_pc</code> files used by Red Faction Guerrilla. This is meant to replace hand editing them, which is very error prone and tedious<br />
* [https://github.com/rfg-modding/SyncFaction/releases SyncFaction] - Tool for automatically installing the Terraform Patch replaces the legacy mod manager with bug fixes and new features<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5686 xdelta UI] - GUI for generating <code>.xdelta</code> (binary) patches<br />
* [http://www.ximple.cz/download.php XiMpLe XML Editor] - Lightweight GUI XML Editor that displays XML type files in a table grid views and shows what other <code>.xtbls</code> it is referencing. Very useful for understanding and editing <code>.xtbl</code> files.<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/Volition_Table_File_Editor.zip Volition Table File Editor] - GUI for editing <code>.xtbl</code> files<br />
* [https://jsonformatter.org/xml-formatter XML Formatter] - Use this to format <code>.xtbl</code> files so they are easier to read<br />
* [https://www.w3schools.com/xml/xml_validator.asp XML Validator] - Use this to validate <code>.xtbl</code> edits, any mistakes you make will crash the game<br />
* [https://onecompiler.com/lua/3ykpyrhhb LUA Validator] - Useful for validating RSL scripts for errors, note it's safe to ignore <code>attempt to index a nil value (global 'rfg')</code><br />
<br />
===Useful Software===<br />
<br />
* [https://www.voidtools.com/ Voidtools Everything] - Locate files and folders by name instantly<br />
* [https://www.mythicsoft.com/agentransack/ Agent Ransack] - Bulk search for keywords within unpacked files<br />
* [https://notepad-plus-plus.org/downloads/ Notepad++] - Good text editor for manually editing <code>.xtbl</code> files, set language as XML<br />
<br />
==Tutorials==<br />
*[[Nanoforge xtbl editing]] - How to edit [[.xtbl]] files in Nanoforge.<br />
*[[Nanoforge Texture Editing]] - How to edit textures using Nanoforge.<br />
* XTBL Editing Guides [Placeholder]<br />
<br />
<br />
[[Category: Red Faction: Guerrilla]]<br />
[[Category: RF:G Editing]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Editing_Main_Page&diff=9055RF:G Editing Main Page2023-10-24T00:32:50Z<p>Camo: </p>
<hr />
<div>{{RFGEditing}}<br />
{{Under construction}}<br />
<br />
This will serve as a landing page for all resources related to [[Red Faction: Guerrilla]] editing for the '''Re-Mars-tered Edition'''.<br />
<br />
==External Links==<br />
===Community===<br />
*[https://discord.gg/factionfiles Faction Files Community Discord] - Active Red Faction series community Discord with #map-mod-development channel for community development discussion<br />
===Downloads===<br />
*[https://www.factionfiles.com/ff.php?action=files FactionFiles.com] - Custom mods, tools, patches, and reference material<br />
*[https://www.nexusmods.com/redfactionguerilla/mods/ Nexus Mods] - Custom mods<br />
*[https://www.nexusmods.com/redfactionguerrillaremarstered/mods/ Nexus Mods Re-Mars-tered] - Custom mods<br />
<br />
==Documentation==<br />
*[[RF:G Map organization]]<br />
*[[Nanoforge basics]]<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail<br />
===Core Concepts===<br />
*[[Red Faction: Guerrilla]]'s level editor is [[CLOE]], which is not publicly available.<br />
<br />
===Red Faction: Guerrilla File Formats===<br />
* <code>.xtbl</code> - XML table files are used to store properties or attributes in Red Faction: Guerrilla. Overall, their function is similar to the <code>.tbl</code> files of Red Faction and Red Faction II.<br />
* <code>.scriptx</code> - Internal script engine file, commonly used for missions and activities<br />
* <code>.dtodx</code> - Weather/lighting file for maps that controls things like fog, tint, ambient colour, eye adaption, bloom, cloud color and speed<br />
* <code>.gtodx</code> - Skybox file for maps that controls things like the sun texture, moon positions and if the horizon mountain texture is enabled<br />
* <code>.vpp_pc</code> - Packfile<br />
* <code>.rigx</code> - Rig<br />
* <code>.str2_pc</code> - Texture Packfile<br />
* <code>.rfgzone_pc</code> - Map zone<br />
* <code>.layer_pc</code> - Map zone<br />
* <code>.cpeg_pc, cvbm_pc</code> - Texture cpu file<br />
* <code>.gpeg_pc, gvbm_pc</code> - Texture gpu file<br />
* <code>.asm_pc</code> - Asset assembler file<br />
* <code>.csmesh_pc</code> - Static mesh cpu file<br />
* <code>.gsmesh_pc</code> - Static mesh gpu file<br />
* <code>.ccmesh_pc</code> - Character mesh cpu file<br />
* <code>.gcmesh_pc</code> - Character mesh gpu file<br />
* <code>.ccar_pc</code> - Vehicle mesh cpu file<br />
* <code>.gcar_pc</code> - Vehicle mesh gpu file<br />
* <code>.anim_pc</code> - Animation<br />
* <code>.cchk_pc</code> - Destructible object cpu file<br />
* <code>.gchk_pc</code> - Destructible object gpu file<br />
* <code>.cefct_pc</code> - Visual effect cpu file<br />
* <code>.gefct_pc</code> - Visual effect gpu file<br />
* <code>.cfmesh_pc</code> - Foliage mesh<br />
* <code>.cstch</code> - Terrain clutter mesh cpu file<br />
* <code>.gstch</code> - Terrain clutter mesh gpu file<br />
* <code>.cterrain_pc</code> - Terrain zone cpu file<br />
* <code>.gterrain_pc</code> - Terrain zone gpu file<br />
* <code>.ctmesh_pc</code> - Terrain subzone cpu file<br />
* <code>.gtmesh_pc</code> - Terrain subzone gpu file<br />
* <code>.fsmib</code> - Fullscreen map data<br />
* <code>.fxo_kg</code> - Shader<br />
* <code>.le_strings</code> - Steam localization strings<br />
* <code>.rfglocatext</code> - Localization strings<br />
* <code>.mat_pc</code> - Render material<br />
* <code>.morph_pc</code> - Animation Morph<br />
* <code>.vint_doc</code> - UI<br />
* <code>.sim_pc</code> - Cloth sim<br />
* <code>.xgs_pc</code> - Sound config<br />
* <code>.xsb_pc</code> - Soundbank<br />
* <code>.xwb_pc</code> - Wavebank<br />
* <code>.aud_pc</code> - Audio categories<br />
* <code>.vf3_pc</code> - Font<br />
* <code>.vfdvp_pc</code> - ?<br />
* <code>.rfgvp_pc</code> - ?<br />
<br />
===Red Faction: Guerrilla File Structure===<br />
<br />
\Red Faction Guerrilla Re-MARS-tered\data\<br />
<br />
The two most important files for modding most of RF:G are <code>misc.vpp_pc</code> & <code>table.vpp_pc</code><br />
<br />
* <code>activities.vpp_pc</code> - contains textures for singleplayer activities<br />
* <code>anims.vpp_pc</code> - contains animation files<br />
* <code>chunks.vpp_pc</code> - contains <code>.rfgchunkx</code> files and seems to be related to the <code>preload_chunks.xtbl</code> file, it's possible to add them to a map using the correct <code>dest_checksum</code> & <code>uid</code> numbers. Game might also spawn <code>missing_chunk</code> or <code>missing_destroyable</code> if a mesh fails to load.<br />
* <code>cloth_sim.vpp_pc</code> - contains cloth simulation files<br />
* <code>decals.vpp_pc</code> - contains decal textures<br />
* <code>dlc01_l0.vpp_pc</code> - singleplayer DLC map<br />
* <code>dlc01_l1.vpp_pc</code> - only contains a blank <code>asm_pc</code> file<br />
* <code>dlc01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer DLC map<br />
* <code>dlcp01_activities.vpp_pc</code> - contains textures for singleplayer DLC activities<br />
* <code>dlcp01_anims.vpp_pc</code> - contains animation files for singleplayer DLC<br />
* <code>dlcp01_cloth_sim.vpp_pc</code> - contains cloth simulation files for singleplayer DLC<br />
* <code>dlcp01_effects.vpp_pc</code> - contains visual effect files for singleplayer DLC, some are <code>.str2</code><br />
* <code>dlcp01_humans.vpp_pc</code> - contains textures and meshes for characters in singleplayer DLC<br />
* <code>dlcp01_interface.vpp_pc</code> - contains textures for loading screens & thumbnails in singleplayer DLC<br />
* <code>dlcp01_items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in singleplayer DLC<br />
* <code>dlc01_misc.vpp_pc</code> - contains <code>.rig_pc</code> files, the <code>.fsmib</code> file and two <code>.xtbl</code> files for singleplayer DLC<br />
* <code>dlc01_missions.vpp_pc</code> - contains textures related to singleplayer DLC missions<br />
* <code>dlcp01_personas_en_us.vpp_pc</code> - <br />
* <code>dlcp01_vehicles.vpp_pc</code> - contains textures and meshes for singleplayer DLC vehicles<br />
* <code>dlcp01_voices_en_us.vpp_pc</code> -<br />
* <code>dlcp02_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for multiplayer DLC<br />
* <code>dlcp02_misc.vpp_pc</code> - <br />
* <code>dlcp03_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for wrecking crew DLC<br />
* <code>dlcp03_misc.vpp_pc</code> -<br />
* <code>effects.vpp_pc</code> - contains visual effect files, some are <code>.str2</code><br />
* <code>effects_mp.vpp_pc</code> - contains multiplayer only visual effect files, some are <code>.str2</code><br />
* <code>humans.vpp_pc</code> - contains textures and meshes for characters in both singleplayer and multiplayer<br />
* <code>interface.vpp_pc</code> - contains textures for loading screens & thumbnails in both SP and MP and character portraits in multiplayer<br />
* <code>items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in both singleplayer & multiplayer<br />
* <code>items_mp.vpp_pc</code> - contains multiplayer only textures and meshes<br />
* <code>misc.vpp_pc</code> contains <code>.xtbl</code> files and most other file types<br />
* <code>missions.vpp_pc</code> - contains textures for singleplayer missions<br />
* <code>mp_common.vpp_pc</code> - contains textures shared between multiplayer maps<br />
* <code>mp_xxx.vpp_pc</code> - multiplayer maps, excluding <code>mp_common.vpp_pc</code><br />
* <code>mpdlc_xxx.vpp_pc</code> - DLC multiplayer maps<br />
* <code>personas_de_de.vpp_pc</code> -<br />
* <code>personas_en_us.vpp_pc</code> - <br />
* <code>personas_es_es.vpp_pc</code> - <br />
* <code>personas_fr_fr.vpp_pc</code> -<br />
* <code>personas_it_it.vpp_pc</code> -<br />
* <code>personas_ru_ru.vpp_pc</code> -<br />
* <code>rfg_cine_00a.bik_xbox2</code> -<br />
* <code>rfg_cine_01a.bik_xbox2</code> -<br />
* <code>rfg_cine_02a.bik_xbox2</code> -<br />
* <code>rfg_cine_03a.bik_xbox2</code> - <br />
* <code>rfg_cine_03b.bik_xbox2</code> - <br />
* <code>rfg_cine_04a.bik_xbox2</code> - <br />
* <code>rfg_cine_05a.bik_xbox2</code> - <br />
* <code>rfg_cine_06a.bik_xbox2</code> - <br />
* <code>skybox.vpp_pc</code> - contains textures for the skybox like the clouds<br />
* <code>sounds_r.vpp_pc</code> - contains <code>.xmb_pc</code> sound files<br />
* <code>steam.vpp_pc</code> -<br />
* <code>table.vpp_pc</code> - contains only <code>.xtbl</code> files and will overwrite <code>.xtbl</code> files in <code>misc.vpp_pc</code><br />
* <code>terr01_l0.vpp_pc</code> - singleplayer map<br />
* <code>terr01_l1.vpp_pc</code> - singleplayer map<br />
* <code>terr01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer map<br />
* <code>vehicles_r.vpp_pc</code> - contains textures and meshes for singleplayer vehicles<br />
* <code>voices_de_de.vpp_pc</code> - <br />
* <code>voices_en_us.vpp_pc</code> - <br />
* <code>voices_es_es.vpp_pc</code> - <br />
* <code>voices_fr_fr.vpp_pc</code> - <br />
* <code>voices_it_it.vpp_pc</code> - <br />
* <code>voices_ru_ru.vpp_pc</code> -<br />
* <code>wcxxx.vpp_c</code> - wrecking crew maps<br />
* <code>zonescript_dlc01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer DLC map<br />
* <code>zonescript_terr01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer map<br />
* <code>xxx.bik</code> - pre-rendered custscenes<br />
<br />
===Scriptx Functions===<br />
<br />
* [https://www.factionfiles.com/ff.php?action=scriptxfuncs .scriptx functions]<br />
<br />
===Primitive data types & limits===<br />
<br />
* Floats (floating decimal points): Max value <code>3.4028237</code> and move the decimal place right 38 times. Examples: <code>1.0, 0.0</code><br />
* Integer (whole number that could hold a zero, positive or negative value): Max value <code>2147483647</code><br />
* Boolean (truth value with two constants objects True and False , basically a toggle to enable or disable something using "true" or "false"): Examples: <code><Unlocks_Cheat>True</Unlocks_Cheat>, <Unlocks_Cheat>False</Unlocks_Cheat></code><br />
* String (represents a sequence or characters/text): Example: <code><string>OldCoot</string></code><br />
<br />
===sounds_r.vpp_pc Info===<br />
<br />
* S16 = Signed 16 bit<br />
* LE = Little endian<br />
* 2CH = 2 channels (stereo)<br />
<br />
* destruction.xwb_pc - unknown<br />
* dlc01_voc_d01offcam.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01dan.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm02.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm03.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm04.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm05.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm06.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01rfc.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01sam_pcm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01vasha_safe.xwb_pc.en_us.xwb_pc - unknown <br />
* mov_foley.xwb_pc - unknown <br />
* mov_jet_pack.xwb_pc - unknown <br />
* mov_male.xwb_pc - unknown <br />
* mov_npc_male.xwb_pc - unknown <br />
* mp_backpacks.xwb_pc - S16, LE, 2CH. Intermittent static starting ~28sec <br />
* mp_wep.xwb_pc - S16, LE, 2CH. Static at start and end <br />
* mus_briefings.xwb_pc - S16, LE, 2CH. <br />
* mus_demomaster.xwb_pc - S16, LE, 2CH. <br />
* mus_frontend.xwb_pc - S16, LE, 2CH. <br />
* mus_multiplayer.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_01.xwb_pc - S16, LE, 2CH. Static at start, may be header <br />
* mus_progression_02.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_03.xwb_pc - S16, LE, 2CH. <br />
* mus_sting.xwb_pc - S16, LE, 2CH. <br />
* obj_shared_ambient.xwb_pc - unknown<br />
* obj_shared_dth.xwb_pc - unknown <br />
* obj_shared_exp.xwb_pc - unknown<br />
* obj_shared_impact.xwb_pc - unknown <br />
* scripted_raids.xwb_pc - unknown <br />
* system.xwb_pc - S16, LE, 2CH. Mostly static, valid sound in middle <br />
* system_mp.xwb_pc - unknown <br />
* veh_civ_bus.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car1.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car2.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car3.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_flat.xwb_pc - unknown <br />
* veh_civ_flat2.xwb_pc - unknown<br />
* veh_civ_fuel.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_hauler.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_taxi.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_trash.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_walker.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_aax.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_abx.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_apc.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_atank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_htank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_mtank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_scout.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staff.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staffh2h.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_raider.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_atv.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_bull.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_dtruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_etruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_pickup.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_rover.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_roverwk.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supplyrt.xwb_pc - unknown<br />
* veh_min_wlklg.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_wlkmd.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_shared.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* walla.xwb_pc - unknown<br />
* weather.xwb_pc - S16, LE, 2CH.<br />
* wep_rfg.xwb_pc - S16, LE, 2CH. Mostly valid, some static<br />
<br />
===RfgUtil Guide===<br />
<br />
* Unpacking [Placeholder]<br />
* Repacking [Placeholder]<br />
* Command arguments [Placeholder]<br />
* Scripts [Placeholder]<br />
* Updating <code>.asm_pc</code> files [Placeholder]<br />
<br />
===Misc Notes===<br />
<br />
* When repacking <code>.vpp_pc</code> files don't compress and/or condense them if they weren't like that in the vanilla game, it will cause the game to crash. Eg: <code>items.vpp_pc</code>, <code>interface.vpp_pc</code>, map files etc. See the table below.<br />
* When repacking <code>.str2_pc</code> files ensure they are compressed and condensed.<br />
* <code>table.vpp_pc</code> overwrites changes to <code>.xtbl</code> files in <code>misc.vpp_pc</code>. The work around for this with the legacy mod manager is to rename the file however this breaks multiplayer and reduces the stability of the game. You should edit the same <code>.xtbl</code> files in both <code>misc.vpp_pc</code> & <code>table.vpp_pc</code>.<br />
<br />
{| class="wikitable"<br />
|+<br />
|-<br />
! Filename !! Alignment !! Compressed !! Condensed<br />
|-<br />
| ALL .str2 || 0 || Yes || Yes<br />
|-<br />
| MOST .vpp_pc || 2048 || No || No<br />
|-<br />
| dlc01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlcp01_misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| mp_common.vpp_pc || 2048 || Yes || No<br />
|-<br />
| steam.vpp_pc || 2048 || Yes || No<br />
|-<br />
| terr01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_dlc01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_terr01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlc01_l1.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp01_voices_en_us.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp02_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| dlcp03_misc.vpp_pc || 0? || Yes || No<br />
|-<br />
| dlcp01_anims.vpp_pc || 16? || Yes || Yes<br />
|-<br />
| anims.vpp_pc || 16 || Yes || Yes<br />
|-<br />
| table.vpp_pc || 64 || Yes || Yes<br />
|-<br />
| skybox.vpp_pc || 4096 || No || No<br />
|-<br />
| dlcp01_personas_en_us.vpp_pc || 4096 || No || No<br />
<br />
|}<br />
<br />
===Red Faction: Guerrilla Tools===<br />
<br />
* [https://github.com/Moneyl/RfgUtil/releases RfgUtil] - Used for unpacking most file formats and updating <code>.asm_pc</code> files<br />
* [https://github.com/Moneyl/Nanoforge/releases Nanoforge C++] - Map editor, texture editor, <code>.xtbl</code> editor and more<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/mTools.zip mTools] - Drag and drop tool to convert <code>.asm_pc</code> files to XML and vice versa<br />
* [https://github.com/rsl-dev/RSL/releases RSL] - Script Loader<br />
* [https://github.com/Moneyl/AsmTool AsmTool]- WIP Tool for modifying <code>.asm_pc</code> files used by Red Faction Guerrilla. This is meant to replace hand editing them, which is very error prone and tedious<br />
* [https://github.com/rfg-modding/SyncFaction/releases SyncFaction] - Tool for automatically installing the Terraform Patch replaces the legacy mod manager with bug fixes and new features<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5686 xdelta UI] - GUI for generating <code>.xdelta</code> (binary) patches<br />
* [http://www.ximple.cz/download.php XiMpLe XML Editor] - Lightweight GUI XML Editor that displays XML type files in a table grid views and shows what other <code>.xtbls</code> it is referencing. Very useful for understanding and editing <code>.xtbl</code> files.<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/Volition_Table_File_Editor.zip Volition Table File Editor] - GUI for editing <code>.xtbl</code> files<br />
* [https://jsonformatter.org/xml-formatter XML Formatter] - Use this to format <code>.xtbl</code> files so they are easier to read<br />
* [https://www.w3schools.com/xml/xml_validator.asp XML Validator] - Use this to validate <code>.xtbl</code> edits, any mistakes you make will crash the game<br />
* [https://onecompiler.com/lua/3ykpyrhhb LUA Validator] - Useful for validating RSL scripts for errors, note it's safe to ignore <code>attempt to index a nil value (global 'rfg')</code><br />
<br />
===Useful Software===<br />
<br />
* [https://www.voidtools.com/ Voidtools Everything] - Locate files and folders by name instantly<br />
* [https://www.mythicsoft.com/agentransack/ Agent Ransack] - Bulk search for keywords within unpacked files<br />
* [https://notepad-plus-plus.org/downloads/ Notepad++] - Good text editor for manually editing <code>.xtbl</code> files, set language as XML<br />
<br />
==Tutorials==<br />
*[[Nanoforge xtbl editing]] - How to edit [[.xtbl]] files in Nanoforge.<br />
*[[Nanoforge Texture Editing]] - How to edit textures using Nanoforge.<br />
* XTBL Editing Guides [Placeholder]<br />
<br />
<br />
[[Category: Red Faction: Guerrilla]]<br />
[[Category: RF:G Editing]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Intro&diff=9054RF:G Intro2023-10-24T00:22:56Z<p>Camo: </p>
<hr />
<div>==Is multiplayer alive?==<br />
<br />
<blockquote>'''Yes, it is!'''</blockquote><br />
We have regular parties once a week. Things to know if you want to join:<br />
<br />
== Short HOWTO ==<br />
<br />
* You need RFG Re-mars-tered. GOG or Steam, clean install without mods<br />
* Use [https://github.com/rfg-modding/SyncFaction/releases SyncFaction] to update your game with community patches. It takes some time, also you will need '''40GiB''' of free space<br />
* Meanwhile, join [https://discord.gg/factionfiles FactionFiles Discord]. Check out '''server events''' for upcoming RFG Game Night, also visit <code>#role-selection</code> channel<br />
<br />
That's it, you're all set! 💥<br />
<br />
== More detailed guide ==<br />
<br />
Same steps but with more info and explanations<br />
<br />
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-aaa"><br />
<span class="mw-customtoggle-aaa"><code>[Click to expand]</code></span><br />
<div class="mw-collapsible-content"><br />
<br />
=== Community Patch ===<br />
<br />
You’ll need to install community-made patches to play. Download size is several gigabytes so please take some time to prepare.<br />
<br />
<blockquote>You will need at least '''40GiB''' of free storage space<br />
</blockquote><br />
<br />
Use [https://github.com/rfg-modding/SyncFaction/releases SyncFaction app]. It is made to keep players updated and simplify process as much as possible. Download and place .exe in game folder. Run it and let it do the thing.<br />
<br />
Why do we need patches and a launcher app?<br />
<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch Terraform Patch] adds new maps, weapons, rebalance, fixes game crashes and bugs (you can find kilometer-long changelog in description). It also serves as a base for future modding by restructuring some resources<br />
* [https://github.com/rfg-modding/Reconstructor Reconstructor] is a script loader and a game engine patcher. It fixes some crashes, bugs like hardcoded memory limits, and enables scripting in mods<br />
* RFG is not modding-friendly game. Players will crash if their game files are not the same, that’s why we need something to keep everyone updated<br />
* There is no simple way to auto-download new maps as in other games. Currently they are part of the patch and we release updates to add more<br />
* Multiplayer is currently broken in GOG version of the game, we fixed that<br />
* Want to use mods AND play multiplayer? Roll back to unpatched version of the game? SyncFaction lets you switch between versions in 1 click, see [https://rfg-modding.github.io/SyncFaction/#/usage Usage]<br />
<br />
=== FactionFiles Discord ===<br />
<br />
Join [https://discord.gg/factionfiles Red Faction Community Discord (FactionFiles)]<br />
<br />
* In <code>#role-selection</code> channel select role <code>RF:G Players (PC)</code>. This way you’ll be notified when somebody gathers people for multiplayer!<br />
* See server events (above channel list). Subscribe to <code>RF: Guerrilla Game Night</code> - you’ll get a notification when it starts<br />
<br />
[[File:RfgIntro-events.png|700px]]<br />
<br />
Feel free to ask for advice in <code>#rfg-matchmaking</code> and <code>#redfactionguerrilla</code> channels. Also you can hang out with us in one of the voice channels during game night!<br />
<br />
We used to have 2 weekly events: one in American timezone, another for Europe. If current time isn’t good for you, let’s schedule a new event!<br />
<br />
</div></div><br />
<br />
__notoc__<br />
<br />
[[File:RfgIntro-bright future.png|frameless|right|600px|]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Intro&diff=9053RF:G Intro2023-10-24T00:22:30Z<p>Camo: </p>
<hr />
<div>==Is multiplayer alive?==<br />
[[File:RfgIntro-bright future.png|frameless|left|600px|]]<br />
<br />
<blockquote>'''Yes, it is!'''</blockquote><br />
We have regular parties once a week. Things to know if you want to join:<br />
<br />
== Short HOWTO ==<br />
<br />
* You need RFG Re-mars-tered. GOG or Steam, clean install without mods<br />
* Use [https://github.com/rfg-modding/SyncFaction/releases SyncFaction] to update your game with community patches. It takes some time, also you will need '''40GiB''' of free space<br />
* Meanwhile, join [https://discord.gg/factionfiles FactionFiles Discord]. Check out '''server events''' for upcoming RFG Game Night, also visit <code>#role-selection</code> channel<br />
<br />
That's it, you're all set! 💥<br />
<br />
== More detailed guide ==<br />
<br />
Same steps but with more info and explanations<br />
<br />
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-aaa"><br />
<span class="mw-customtoggle-aaa"><code>[Click to expand]</code></span><br />
<div class="mw-collapsible-content"><br />
<br />
=== Community Patch ===<br />
<br />
You’ll need to install community-made patches to play. Download size is several gigabytes so please take some time to prepare.<br />
<br />
<blockquote>You will need at least '''40GiB''' of free storage space<br />
</blockquote><br />
<br />
Use [https://github.com/rfg-modding/SyncFaction/releases SyncFaction app]. It is made to keep players updated and simplify process as much as possible. Download and place .exe in game folder. Run it and let it do the thing.<br />
<br />
Why do we need patches and a launcher app?<br />
<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch Terraform Patch] adds new maps, weapons, rebalance, fixes game crashes and bugs (you can find kilometer-long changelog in description). It also serves as a base for future modding by restructuring some resources<br />
* [https://github.com/rfg-modding/Reconstructor Reconstructor] is a script loader and a game engine patcher. It fixes some crashes, bugs like hardcoded memory limits, and enables scripting in mods<br />
* RFG is not modding-friendly game. Players will crash if their game files are not the same, that’s why we need something to keep everyone updated<br />
* There is no simple way to auto-download new maps as in other games. Currently they are part of the patch and we release updates to add more<br />
* Multiplayer is currently broken in GOG version of the game, we fixed that<br />
* Want to use mods AND play multiplayer? Roll back to unpatched version of the game? SyncFaction lets you switch between versions in 1 click, see [https://rfg-modding.github.io/SyncFaction/#/usage Usage]<br />
<br />
=== FactionFiles Discord ===<br />
<br />
Join [https://discord.gg/factionfiles Red Faction Community Discord (FactionFiles)]<br />
<br />
* In <code>#role-selection</code> channel select role <code>RF:G Players (PC)</code>. This way you’ll be notified when somebody gathers people for multiplayer!<br />
* See server events (above channel list). Subscribe to <code>RF: Guerrilla Game Night</code> - you’ll get a notification when it starts<br />
<br />
[[File:RfgIntro-events.png|700px]]<br />
<br />
Feel free to ask for advice in <code>#rfg-matchmaking</code> and <code>#redfactionguerrilla</code> channels. Also you can hang out with us in one of the voice channels during game night!<br />
<br />
We used to have 2 weekly events: one in American timezone, another for Europe. If current time isn’t good for you, let’s schedule a new event!<br />
<br />
</div></div><br />
<br />
__notoc__</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Intro&diff=9052RF:G Intro2023-10-24T00:19:23Z<p>Camo: </p>
<hr />
<div>==Is multiplayer alive?==<br />
<br />
<blockquote>'''Yes, it is!'''</blockquote><br />
We have regular parties once a week. Things to know if you want to join:<br />
<br />
== Short HOWTO ==<br />
<br />
* You need RFG Re-mars-tered. GOG or Steam, clean install without mods<br />
* Use [https://github.com/rfg-modding/SyncFaction/releases SyncFaction] to update your game with community patches. It takes some time, also you will need '''40GiB''' of free space<br />
* Meanwhile, join [https://discord.gg/factionfiles FactionFiles Discord]. Check out '''server events''' for upcoming RFG Game Night, also visit <code>#role-selection</code> channel<br />
<br />
That's it, you're all set! 💥<br />
<br />
== More detailed guide ==<br />
<br />
Same steps but with more info and explanations<br />
<br />
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-aaa"><br />
<span class="mw-customtoggle-aaa"><code>[Click to expand]</code></span><br />
<div class="mw-collapsible-content"><br />
<br />
=== Community Patch ===<br />
<br />
You’ll need to install community-made patches to play. Download size is several gigabytes so please take some time to prepare.<br />
<br />
<blockquote>You will need at least '''40GiB''' of free storage space<br />
</blockquote><br />
<br />
Use [https://github.com/rfg-modding/SyncFaction/releases SyncFaction app]. It is made to keep players updated and simplify process as much as possible. Download and place .exe in game folder. Run it and let it do the thing.<br />
<br />
Why do we need patches and a launcher app?<br />
<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch Terraform Patch] adds new maps, weapons, rebalance, fixes game crashes and bugs (you can find kilometer-long changelog in description). It also serves as a base for future modding by restructuring some resources<br />
* [https://github.com/rfg-modding/Reconstructor Reconstructor] is a script loader and a game engine patcher. It fixes some crashes, bugs like hardcoded memory limits, and enables scripting in mods<br />
* RFG is not modding-friendly game. Players will crash if their game files are not the same, that’s why we need something to keep everyone updated<br />
* There is no simple way to auto-download new maps as in other games. Currently they are part of the patch and we release updates to add more<br />
* Multiplayer is currently broken in GOG version of the game, we fixed that<br />
* Want to use mods AND play multiplayer? Roll back to unpatched version of the game? SyncFaction lets you switch between versions in 1 click, see [https://rfg-modding.github.io/SyncFaction/#/usage Usage]<br />
<br />
=== FactionFiles Discord ===<br />
<br />
Join [https://discord.gg/factionfiles Red Faction Community Discord (FactionFiles)]<br />
<br />
* In <code>#role-selection</code> channel select role <code>RF:G Players (PC)</code>. This way you’ll be notified when somebody gathers people for multiplayer!<br />
* See server events (above channel list). Subscribe to <code>RF: Guerrilla Game Night</code> - you’ll get a notification when it starts<br />
<br />
[[File:RfgIntro-events.png|700px]]<br />
<br />
Feel free to ask for advice in <code>#rfg-matchmaking</code> and <code>#redfactionguerrilla</code> channels. Also you can hang out with us in one of the voice channels during game night!<br />
<br />
We used to have 2 weekly events: one in American timezone, another for Europe. If current time isn’t good for you, let’s schedule a new event!<br />
<br />
</div></div><br />
<br />
__notoc__<br />
<br />
<br />
[[File:RfgIntro-bright future.png|frameless|right|600px|]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Intro&diff=9051RF:G Intro2023-10-24T00:18:19Z<p>Camo: </p>
<hr />
<div>==Is multiplayer alive?==<br />
<br />
<blockquote>'''Yes, it is!'''</blockquote><br />
We have regular parties once a week. Things to know if you want to join:<br />
<br />
== Short HOWTO ==<br />
<br />
* You need RFG Re-mars-tered. GOG or Steam, clean install without mods<br />
* Use [https://github.com/rfg-modding/SyncFaction/releases SyncFaction] to update your game with community patches. It takes some time, also you will need '''40GiB''' of free space<br />
* Meanwhile, join [https://discord.gg/factionfiles FactionFiles Discord]. Check out '''server events''' for upcoming RFG Game Night, also visit <code>#role-selection</code> channel<br />
<br />
That's it, you're all set! 💥<br />
<br />
== More detailed guide ==<br />
<br />
Same steps but with more info and explanations<br />
<br />
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-aaa"><br />
<span class="mw-customtoggle-aaa"><code>[Click to expand]</code></span><br />
<div class="mw-collapsible-content"><br />
<br />
=== Community Patch ===<br />
<br />
You’ll need to install community-made patches to play. Download size is several gigabytes so please take some time to prepare.<br />
<br />
<blockquote>You will need at least '''40GiB''' of free storage space<br />
</blockquote><br />
<br />
Use [https://github.com/rfg-modding/SyncFaction/releases SyncFaction app]. It is made to keep players updated and simplify process as much as possible. Download and place .exe in game folder. Run it and let it do the thing.<br />
<br />
Why do we need patches and a launcher app?<br />
<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch Terraform Patch] adds new maps, weapons, rebalance, fixes game crashes and bugs (you can find kilometer-long changelog in description). It also serves as a base for future modding by restructuring some resources<br />
* [https://github.com/rfg-modding/Reconstructor Reconstructor] is a script loader and a game engine patcher. It fixes some crashes, bugs like hardcoded memory limits, and enables scripting in mods<br />
* RFG is not modding-friendly game. Players will crash if their game files are not the same, that’s why we need something to keep everyone updated<br />
* There is no simple way to auto-download new maps as in other games. Currently they are part of the patch and we release updates to add more<br />
* Multiplayer is currently broken in GOG version of the game, we fixed that<br />
* Want to use mods AND play multiplayer? Roll back to unpatched version of the game? SyncFaction lets you switch between versions in 1 click, see [https://rfg-modding.github.io/SyncFaction/#/usage Usage]<br />
<br />
=== FactionFiles Discord ===<br />
<br />
Join [https://discord.gg/factionfiles Red Faction Community Discord (FactionFiles)]<br />
<br />
* In <code>#role-selection</code> channel select role <code>RF:G Players (PC)</code>. This way you’ll be notified when somebody gathers people for multiplayer!<br />
* See server events (above channel list). Subscribe to <code>RF: Guerrilla Game Night</code> - you’ll get a notification when it starts<br />
<br />
[[File:RfgIntro-events.png|700px]]<br />
<br />
Feel free to ask for advice in <code>#rfg-matchmaking</code> and <code>#redfactionguerrilla</code> channels. Also you can hang out with us in one of the voice channels during game night!<br />
<br />
We used to have 2 weekly events: one in American timezone, another for Europe. If current time isn’t good for you, let’s schedule a new event!<br />
<br />
</div></div><br />
<br />
__notoc__</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Intro&diff=9050RF:G Intro2023-10-24T00:17:07Z<p>Camo: </p>
<hr />
<div>{{Is multiplayer alive?}}<br />
<br />
<blockquote>'''Yes, it is!'''</blockquote><br />
We have regular parties once a week. Things to know if you want to join:<br />
<br />
== Short HOWTO ==<br />
<br />
* You need RFG Re-mars-tered. GOG or Steam, clean install without mods<br />
* Use [https://github.com/rfg-modding/SyncFaction/releases SyncFaction] to update your game with community patches. It takes some time, also you will need '''40GiB''' of free space<br />
* Meanwhile, join [https://discord.gg/factionfiles FactionFiles Discord]. Check out '''server events''' for upcoming RFG Game Night, also visit <code>#role-selection</code> channel<br />
<br />
That's it, you're all set! 💥<br />
<br />
== More detailed guide ==<br />
<br />
Same steps but with more info and explanations<br />
<br />
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-aaa"><br />
<span class="mw-customtoggle-aaa"><code>[Click to expand]</code></span><br />
<div class="mw-collapsible-content"><br />
<br />
=== Community Patch ===<br />
<br />
You’ll need to install community-made patches to play. Download size is several gigabytes so please take some time to prepare.<br />
<br />
<blockquote>You will need at least '''40GiB''' of free storage space<br />
</blockquote><br />
<br />
Use [https://github.com/rfg-modding/SyncFaction/releases SyncFaction app]. It is made to keep players updated and simplify process as much as possible. Download and place .exe in game folder. Run it and let it do the thing.<br />
<br />
Why do we need patches and a launcher app?<br />
<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch Terraform Patch] adds new maps, weapons, rebalance, fixes game crashes and bugs (you can find kilometer-long changelog in description). It also serves as a base for future modding by restructuring some resources<br />
* [https://github.com/rfg-modding/Reconstructor Reconstructor] is a script loader and a game engine patcher. It fixes some crashes, bugs like hardcoded memory limits, and enables scripting in mods<br />
* RFG is not modding-friendly game. Players will crash if their game files are not the same, that’s why we need something to keep everyone updated<br />
* There is no simple way to auto-download new maps as in other games. Currently they are part of the patch and we release updates to add more<br />
* Multiplayer is currently broken in GOG version of the game, we fixed that<br />
* Want to use mods AND play multiplayer? Roll back to unpatched version of the game? SyncFaction lets you switch between versions in 1 click, see [https://rfg-modding.github.io/SyncFaction/#/usage Usage]<br />
<br />
=== FactionFiles Discord ===<br />
<br />
Join [https://discord.gg/factionfiles Red Faction Community Discord (FactionFiles)]<br />
<br />
* In <code>#role-selection</code> channel select role <code>RF:G Players (PC)</code>. This way you’ll be notified when somebody gathers people for multiplayer!<br />
* See server events (above channel list). Subscribe to <code>RF: Guerrilla Game Night</code> - you’ll get a notification when it starts<br />
<br />
[[File:RfgIntro-events.png|700px]]<br />
<br />
Feel free to ask for advice in <code>#rfg-matchmaking</code> and <code>#redfactionguerrilla</code> channels. Also you can hang out with us in one of the voice channels during game night!<br />
<br />
We used to have 2 weekly events: one in American timezone, another for Europe. If current time isn’t good for you, let’s schedule a new event!<br />
<br />
</div></div><br />
<br />
__notoc__</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Intro&diff=9049RF:G Intro2023-10-24T00:15:47Z<p>Camo: /* Introduction for new players */</p>
<hr />
<div>[[File:RfgIntro-bright future.png|frameless|right|600px|]]<br />
<br />
==Is multiplayer alive?==<br />
<br />
<blockquote>'''Yes, it is!'''<br />
</blockquote><br />
We have regular parties once a week. Things to know if you want to join:<br />
<br />
== Short HOWTO ==<br />
<br />
* You need RFG Re-mars-tered. GOG or Steam, clean install without mods<br />
* Use [https://github.com/rfg-modding/SyncFaction/releases SyncFaction] to update your game with community patches. It takes some time, also you will need '''40GiB''' of free space<br />
* Meanwhile, join [https://discord.gg/factionfiles FactionFiles Discord]. Check out '''server events''' for upcoming RFG Game Night, also visit <code>#role-selection</code> channel<br />
<br />
That's it, you're all set! 💥<br />
<br />
== More detailed guide ==<br />
<br />
Same steps but with more info and explanations<br />
<br />
<div class="mw-collapsible mw-collapsed" id="mw-customcollapsible-aaa"><br />
<span class="mw-customtoggle-aaa"><code>[Click to expand]</code></span><br />
<div class="mw-collapsible-content"><br />
<br />
=== Community Patch ===<br />
<br />
You’ll need to install community-made patches to play. Download size is several gigabytes so please take some time to prepare.<br />
<br />
<blockquote>You will need at least '''40GiB''' of free storage space<br />
</blockquote><br />
<br />
Use [https://github.com/rfg-modding/SyncFaction/releases SyncFaction app]. It is made to keep players updated and simplify process as much as possible. Download and place .exe in game folder. Run it and let it do the thing.<br />
<br />
Why do we need patches and a launcher app?<br />
<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch Terraform Patch] adds new maps, weapons, rebalance, fixes game crashes and bugs (you can find kilometer-long changelog in description). It also serves as a base for future modding by restructuring some resources<br />
* [https://github.com/rfg-modding/Reconstructor Reconstructor] is a script loader and a game engine patcher. It fixes some crashes, bugs like hardcoded memory limits, and enables scripting in mods<br />
* RFG is not modding-friendly game. Players will crash if their game files are not the same, that’s why we need something to keep everyone updated<br />
* There is no simple way to auto-download new maps as in other games. Currently they are part of the patch and we release updates to add more<br />
* Multiplayer is currently broken in GOG version of the game, we fixed that<br />
* Want to use mods AND play multiplayer? Roll back to unpatched version of the game? SyncFaction lets you switch between versions in 1 click, see [https://rfg-modding.github.io/SyncFaction/#/usage Usage]<br />
<br />
=== FactionFiles Discord ===<br />
<br />
Join [https://discord.gg/factionfiles Red Faction Community Discord (FactionFiles)]<br />
<br />
* In <code>#role-selection</code> channel select role <code>RF:G Players (PC)</code>. This way you’ll be notified when somebody gathers people for multiplayer!<br />
* See server events (above channel list). Subscribe to <code>RF: Guerrilla Game Night</code> - you’ll get a notification when it starts<br />
<br />
[[File:RfgIntro-events.png|700px]]<br />
<br />
Feel free to ask for advice in <code>#rfg-matchmaking</code> and <code>#redfactionguerrilla</code> channels. Also you can hang out with us in one of the voice channels during game night!<br />
<br />
We used to have 2 weekly events: one in American timezone, another for Europe. If current time isn’t good for you, let’s schedule a new event!<br />
<br />
</div></div><br />
<br />
__notoc__</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Editing_Main_Page&diff=9016RF:G Editing Main Page2023-09-04T23:53:12Z<p>Camo: Updated SF version and removed link to legacy mod manager</p>
<hr />
<div>{{RFGEditing}}<br />
{{Under construction}}<br />
<br />
This will serve as a landing page for all resources related to [[Red Faction: Guerrilla]] editing for the '''Re-Mars-tered Edition'''.<br />
<br />
==External Links==<br />
===Community===<br />
*[https://discord.gg/factionfiles Faction Files Community Discord] - Active Red Faction series community Discord with #map-mod-development channel for community development discussion<br />
===Downloads===<br />
*[https://www.factionfiles.com/ff.php?action=files FactionFiles.com] - Custom mods, tools, patches, and reference material<br />
*[https://www.nexusmods.com/redfactionguerilla/mods/ Nexus Mods] - Custom mods<br />
*[https://www.nexusmods.com/redfactionguerrillaremarstered/mods/ Nexus Mods Re-Mars-tered] - Custom mods<br />
<br />
==Documentation==<br />
*[[RF:G Map organization]]<br />
*[[Nanoforge basics]]<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail<br />
===Core Concepts===<br />
*[[Red Faction: Guerrilla]]'s level editor is [[CLOE]], which is not publicly available.<br />
<br />
===Red Faction: Guerrilla File Formats===<br />
* <code>.xtbl</code> - XML table files are used to store properties or attributes in Red Faction: Guerrilla. Overall, their function is similar to the <code>.tbl</code> files of Red Faction and Red Faction II.<br />
* <code>.scriptx</code> - Internal script engine file, commonly used for missions and activities<br />
* <code>.dtodx</code> - Weather/lighting file for maps that controls things like fog, tint, ambient colour, eye adaption, bloom, cloud color and speed<br />
* <code>.gtodx</code> - Skybox file for maps that controls things like the sun texture, moon positions and if the horizon mountain texture is enabled<br />
* <code>.vpp_pc</code> - Packfile<br />
* <code>.rigx</code> - Rig<br />
* <code>.str2_pc</code> - Texture Packfile<br />
* <code>.rfgzone_pc</code> - Map zone<br />
* <code>.layer_pc</code> - Map zone<br />
* <code>.cpeg_pc, cvbm_pc</code> - Texture cpu file<br />
* <code>.gpeg_pc, gvbm_pc</code> - Texture gpu file<br />
* <code>.asm_pc</code> - Streaming index<br />
* <code>.csmesh_pc</code> - Static mesh cpu file<br />
* <code>.gsmesh_pc</code> - Static mesh gpu file<br />
* <code>.ccmesh_pc</code> - Character mesh cpu file<br />
* <code>.gcmesh_pc</code> - Character mesh gpu file<br />
* <code>.ccar_pc</code> - Vehicle mesh cpu file<br />
* <code>.gcar_pc</code> - Vehicle mesh gpu file<br />
* <code>.anim_pc</code> - Animation<br />
* <code>.cchk_pc</code> - Destructible object cpu file<br />
* <code>.gchk_pc</code> - Destructible object gpu file<br />
* <code>.cefct_pc</code> - Visual effect cpu file<br />
* <code>.gefct_pc</code> - Visual effect gpu file<br />
* <code>.cfmesh_pc</code> - Foliage mesh<br />
* <code>.cstch</code> - Terrain clutter mesh cpu file<br />
* <code>.gstch</code> - Terrain clutter mesh gpu file<br />
* <code>.cterrain_pc</code> - Terrain zone cpu file<br />
* <code>.gterrain_pc</code> - Terrain zone gpu file<br />
* <code>.ctmesh_pc</code> - Terrain subzone cpu file<br />
* <code>.gtmesh_pc</code> - Terrain subzone gpu file<br />
* <code>.fsmib</code> - Fullscreen map data<br />
* <code>.fxo_kg</code> - Shader<br />
* <code>.le_strings</code> - Steam localization strings<br />
* <code>.rfglocatext</code> - Localization strings<br />
* <code>.mat_pc</code> - Render material<br />
* <code>.morph_pc</code> - Animation Morph<br />
* <code>.vint_doc</code> - UI<br />
* <code>.sim_pc</code> - Cloth sim<br />
* <code>.xgs_pc</code> - Sound config<br />
* <code>.xsb_pc</code> - Soundbank<br />
* <code>.xwb_pc</code> - Wavebank<br />
* <code>.aud_pc</code> - Audio categories<br />
* <code>.vf3_pc</code> - Font<br />
* <code>.vfdvp_pc</code> - ?<br />
* <code>.rfgvp_pc</code> - ?<br />
<br />
===Red Faction: Guerrilla File Structure===<br />
<br />
\Red Faction Guerrilla Re-MARS-tered\data\<br />
<br />
The two most important files for modding most of RF:G are <code>misc.vpp_pc</code> & <code>table.vpp_pc</code><br />
<br />
* <code>activities.vpp_pc</code> - contains textures for singleplayer activities<br />
* <code>anims.vpp_pc</code> - contains animation files<br />
* <code>chunks.vpp_pc</code> - contains <code>.rfgchunkx</code> files and seems to be related to the <code>preload_chunks.xtbl</code> file, it's possible to add them to a map using the correct <code>dest_checksum</code> & <code>uid</code> numbers. Game might also spawn <code>missing_chunk</code> or <code>missing_destroyable</code> if a mesh fails to load.<br />
* <code>cloth_sim.vpp_pc</code> - contains cloth simulation files<br />
* <code>decals.vpp_pc</code> - contains decal textures<br />
* <code>dlc01_l0.vpp_pc</code> - singleplayer DLC map<br />
* <code>dlc01_l1.vpp_pc</code> - only contains a blank <code>asm_pc</code> file<br />
* <code>dlc01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer DLC map<br />
* <code>dlcp01_activities.vpp_pc</code> - contains textures for singleplayer DLC activities<br />
* <code>dlcp01_anims.vpp_pc</code> - contains animation files for singleplayer DLC<br />
* <code>dlcp01_cloth_sim.vpp_pc</code> - contains cloth simulation files for singleplayer DLC<br />
* <code>dlcp01_effects.vpp_pc</code> - contains visual effect files for singleplayer DLC, some are <code>.str2</code><br />
* <code>dlcp01_humans.vpp_pc</code> - contains textures and meshes for characters in singleplayer DLC<br />
* <code>dlcp01_interface.vpp_pc</code> - contains textures for loading screens & thumbnails in singleplayer DLC<br />
* <code>dlcp01_items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in singleplayer DLC<br />
* <code>dlc01_misc.vpp_pc</code> - contains <code>.rig_pc</code> files, the <code>.fsmib</code> file and two <code>.xtbl</code> files for singleplayer DLC<br />
* <code>dlc01_missions.vpp_pc</code> - contains textures related to singleplayer DLC missions<br />
* <code>dlcp01_personas_en_us.vpp_pc</code> - <br />
* <code>dlcp01_vehicles.vpp_pc</code> - contains textures and meshes for singleplayer DLC vehicles<br />
* <code>dlcp01_voices_en_us.vpp_pc</code> -<br />
* <code>dlcp02_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for multiplayer DLC<br />
* <code>dlcp02_misc.vpp_pc</code> - <br />
* <code>dlcp03_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for wrecking crew DLC<br />
* <code>dlcp03_misc.vpp_pc</code> -<br />
* <code>effects.vpp_pc</code> - contains visual effect files, some are <code>.str2</code><br />
* <code>effects_mp.vpp_pc</code> - contains multiplayer only visual effect files, some are <code>.str2</code><br />
* <code>humans.vpp_pc</code> - contains textures and meshes for characters in both singleplayer and multiplayer<br />
* <code>interface.vpp_pc</code> - contains textures for loading screens & thumbnails in both SP and MP and character portraits in multiplayer<br />
* <code>items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in both singleplayer & multiplayer<br />
* <code>items_mp.vpp_pc</code> - contains multiplayer only textures and meshes<br />
* <code>misc.vpp_pc</code> contains <code>.xtbl</code> files and most other file types<br />
* <code>missions.vpp_pc</code> - contains textures for singleplayer missions<br />
* <code>mp_common.vpp_pc</code> - contains textures shared between multiplayer maps<br />
* <code>mp_xxx.vpp_pc</code> - multiplayer maps, excluding <code>mp_common.vpp_pc</code><br />
* <code>mpdlc_xxx.vpp_pc</code> - DLC multiplayer maps<br />
* <code>personas_de_de.vpp_pc</code> -<br />
* <code>personas_en_us.vpp_pc</code> - <br />
* <code>personas_es_es.vpp_pc</code> - <br />
* <code>personas_fr_fr.vpp_pc</code> -<br />
* <code>personas_it_it.vpp_pc</code> -<br />
* <code>personas_ru_ru.vpp_pc</code> -<br />
* <code>rfg_cine_00a.bik_xbox2</code> -<br />
* <code>rfg_cine_01a.bik_xbox2</code> -<br />
* <code>rfg_cine_02a.bik_xbox2</code> -<br />
* <code>rfg_cine_03a.bik_xbox2</code> - <br />
* <code>rfg_cine_03b.bik_xbox2</code> - <br />
* <code>rfg_cine_04a.bik_xbox2</code> - <br />
* <code>rfg_cine_05a.bik_xbox2</code> - <br />
* <code>rfg_cine_06a.bik_xbox2</code> - <br />
* <code>skybox.vpp_pc</code> - contains textures for the skybox like the clouds<br />
* <code>sounds_r.vpp_pc</code> - contains <code>.xmb_pc</code> sound files<br />
* <code>steam.vpp_pc</code> -<br />
* <code>table.vpp_pc</code> - contains only <code>.xtbl</code> files and will overwrite <code>.xtbl</code> files in <code>misc.vpp_pc</code><br />
* <code>terr01_l0.vpp_pc</code> - singleplayer map<br />
* <code>terr01_l1.vpp_pc</code> - singleplayer map<br />
* <code>terr01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer map<br />
* <code>vehicles_r.vpp_pc</code> - contains textures and meshes for singleplayer vehicles<br />
* <code>voices_de_de.vpp_pc</code> - <br />
* <code>voices_en_us.vpp_pc</code> - <br />
* <code>voices_es_es.vpp_pc</code> - <br />
* <code>voices_fr_fr.vpp_pc</code> - <br />
* <code>voices_it_it.vpp_pc</code> - <br />
* <code>voices_ru_ru.vpp_pc</code> -<br />
* <code>wcxxx.vpp_c</code> - wrecking crew maps<br />
* <code>zonescript_dlc01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer DLC map<br />
* <code>zonescript_terr01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer map<br />
* <code>xxx.bik</code> - pre-rendered custscenes<br />
<br />
===Scriptx Functions===<br />
<br />
* [https://www.factionfiles.com/ff.php?action=scriptxfuncs .scriptx functions]<br />
<br />
===Primitive data types & limits===<br />
<br />
* Floats (floating decimal points): Max value <code>3.4028237</code> and move the decimal place right 38 times. Examples: <code>1.0, 0.0</code><br />
* Integer (whole number that could hold a zero, positive or negative value): Max value <code>2147483647</code><br />
* Boolean (truth value with two constants objects True and False , basically a toggle to enable or disable something using "true" or "false"): Examples: <code><Unlocks_Cheat>True</Unlocks_Cheat>, <Unlocks_Cheat>False</Unlocks_Cheat></code><br />
* String (represents a sequence or characters/text): Example: <code><string>OldCoot</string></code><br />
<br />
===sounds_r.vpp_pc Info===<br />
<br />
* S16 = Signed 16 bit<br />
* LE = Little endian<br />
* 2CH = 2 channels (stereo)<br />
<br />
* destruction.xwb_pc - unknown<br />
* dlc01_voc_d01offcam.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01dan.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm02.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm03.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm04.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm05.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm06.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01rfc.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01sam_pcm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01vasha_safe.xwb_pc.en_us.xwb_pc - unknown <br />
* mov_foley.xwb_pc - unknown <br />
* mov_jet_pack.xwb_pc - unknown <br />
* mov_male.xwb_pc - unknown <br />
* mov_npc_male.xwb_pc - unknown <br />
* mp_backpacks.xwb_pc - S16, LE, 2CH. Intermittent static starting ~28sec <br />
* mp_wep.xwb_pc - S16, LE, 2CH. Static at start and end <br />
* mus_briefings.xwb_pc - S16, LE, 2CH. <br />
* mus_demomaster.xwb_pc - S16, LE, 2CH. <br />
* mus_frontend.xwb_pc - S16, LE, 2CH. <br />
* mus_multiplayer.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_01.xwb_pc - S16, LE, 2CH. Static at start, may be header <br />
* mus_progression_02.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_03.xwb_pc - S16, LE, 2CH. <br />
* mus_sting.xwb_pc - S16, LE, 2CH. <br />
* obj_shared_ambient.xwb_pc - unknown<br />
* obj_shared_dth.xwb_pc - unknown <br />
* obj_shared_exp.xwb_pc - unknown<br />
* obj_shared_impact.xwb_pc - unknown <br />
* scripted_raids.xwb_pc - unknown <br />
* system.xwb_pc - S16, LE, 2CH. Mostly static, valid sound in middle <br />
* system_mp.xwb_pc - unknown <br />
* veh_civ_bus.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car1.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car2.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car3.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_flat.xwb_pc - unknown <br />
* veh_civ_flat2.xwb_pc - unknown<br />
* veh_civ_fuel.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_hauler.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_taxi.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_trash.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_walker.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_aax.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_abx.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_apc.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_atank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_htank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_mtank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_scout.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staff.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staffh2h.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_raider.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_atv.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_bull.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_dtruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_etruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_pickup.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_rover.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_roverwk.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supplyrt.xwb_pc - unknown<br />
* veh_min_wlklg.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_wlkmd.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_shared.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* walla.xwb_pc - unknown<br />
* weather.xwb_pc - S16, LE, 2CH.<br />
* wep_rfg.xwb_pc - S16, LE, 2CH. Mostly valid, some static<br />
<br />
===RfgUtil Guide===<br />
<br />
* Unpacking [Placeholder]<br />
* Repacking [Placeholder]<br />
* Command arguments [Placeholder]<br />
* Scripts [Placeholder]<br />
* Updating <code>.asm_pc</code> files [Placeholder]<br />
<br />
===Misc Notes===<br />
<br />
* When repacking <code>.vpp_pc</code> files don't compress and/or condense them if they weren't like that in the vanilla game, it will cause the game to crash. Eg: <code>items.vpp_pc</code>, <code>interface.vpp_pc</code>, map files etc. See the table below.<br />
* When repacking <code>.str2_pc</code> files ensure they are compressed and condensed.<br />
* <code>table.vpp_pc</code> overwrites changes to <code>.xtbl</code> files in <code>misc.vpp_pc</code>. The work around for this with the legacy mod manager is to rename the file however this breaks multiplayer and reduces the stability of the game. You should edit the same <code>.xtbl</code> files in both <code>misc.vpp_pc</code> & <code>table.vpp_pc</code>.<br />
<br />
{| class="wikitable"<br />
|+<br />
|-<br />
! Filename !! Alignment !! Compressed !! Condensed<br />
|-<br />
| ALL .str2 || 0 || Yes || Yes<br />
|-<br />
| MOST .vpp_pc || 2048 || No || No<br />
|-<br />
| dlc01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlcp01_misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| mp_common.vpp_pc || 2048 || Yes || No<br />
|-<br />
| steam.vpp_pc || 2048 || Yes || No<br />
|-<br />
| terr01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_dlc01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_terr01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlc01_l1.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp01_voices_en_us.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp02_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| dlcp03_misc.vpp_pc || 0? || Yes || No<br />
|-<br />
| dlcp01_anims.vpp_pc || 16? || Yes || Yes<br />
|-<br />
| anims.vpp_pc || 16 || Yes || Yes<br />
|-<br />
| table.vpp_pc || 64 || Yes || Yes<br />
|-<br />
| skybox.vpp_pc || 4096 || No || No<br />
|-<br />
| dlcp01_personas_en_us.vpp_pc || 4096 || No || No<br />
<br />
|}<br />
<br />
===Red Faction: Guerrilla Tools===<br />
<br />
* [https://github.com/Moneyl/RfgUtil/releases RfgUtil] - Used for unpacking most file formats and updating <code>.asm_pc</code> files<br />
* [https://github.com/Moneyl/Nanoforge/releases Nanoforge C++] - Map editor, texture editor, <code>.xtbl</code> editor and more<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/mTools.zip mTools] - Drag and drop tool to convert <code>.asm_pc</code> files to XML and vice versa<br />
* [https://github.com/rsl-dev/RSL/releases RSL] - Script Loader<br />
* [https://github.com/Moneyl/AsmTool AsmTool]- WIP Tool for modifying <code>.asm_pc</code> files used by Red Faction Guerrilla. This is meant to replace hand editing them, which is very error prone and tedious<br />
* [https://github.com/rfg-modding/SyncFaction/releases SyncFaction] - Tool for automatically installing the Terraform Patch replaces the legacy mod manager with bug fixes and new features<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5686 xdelta UI] - GUI for generating <code>.xdelta</code> (binary) patches<br />
* [http://www.ximple.cz/download.php XiMpLe XML Editor] - Lightweight GUI XML Editor that displays XML type files in a table grid views and shows what other <code>.xtbls</code> it is referencing. Very useful for understanding and editing <code>.xtbl</code> files.<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/Volition_Table_File_Editor.zip Volition Table File Editor] - GUI for editing <code>.xtbl</code> files<br />
* [https://jsonformatter.org/xml-formatter XML Formatter] - Use this to format <code>.xtbl</code> files so they are easier to read<br />
* [https://www.w3schools.com/xml/xml_validator.asp XML Validator] - Use this to validate <code>.xtbl</code> edits, any mistakes you make will crash the game<br />
* [https://onecompiler.com/lua/3ykpyrhhb LUA Validator] - Useful for validating RSL scripts for errors, note it's safe to ignore <code>attempt to index a nil value (global 'rfg')</code><br />
<br />
===Useful Software===<br />
<br />
* [https://www.voidtools.com/ Voidtools Everything] - Locate files and folders by name instantly<br />
* [https://www.mythicsoft.com/agentransack/ Agent Ransack] - Bulk search for keywords within unpacked files<br />
* [https://notepad-plus-plus.org/downloads/ Notepad++] - Good text editor for manually editing <code>.xtbl</code> files, set language as XML<br />
<br />
==Tutorials==<br />
*[[Nanoforge xtbl editing]] - How to edit [[.xtbl]] files in Nanoforge.<br />
*[[Nanoforge Texture Editing]] - How to edit textures using Nanoforge.<br />
* XTBL Editing Guides [Placeholder]<br />
<br />
<br />
[[Category: Red Faction: Guerrilla]]<br />
[[Category: RF:G Editing]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Game_Night_News&diff=8979RF:G Game Night News2023-06-25T11:59:52Z<p>Camo: /* News */</p>
<hr />
<div>{{Under construction}}<br />
<br />
== News ==<br />
<br />
* RF:GR Terraform Patch: Warehouse Custom Map ALPHA TEST was recently released on the 25th of June, 2023. Please update before game night!<br />
* SyncFaction v9 was recently released on the 14th of March, 2023. Please update before game night!<br />
<br />
== Multiplayer Server Status ==<br />
<br />
* Steam version: Fix already included in latest update from Steam.<br />
* GOG version: You will need to manually replace <code>sw_api.dll</code> in the <code>Red Faction Guerrilla Re-Mars-tered</code> folder with the one from here: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_debug/mp_fix/gog/sw_api.dll<br />
<br />
== Installing Terraform Patch ==<br />
<br />
# Download https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
# Open SyncFaction.<br />
# The first time you run it SyncFaction will take some time verifying your game files are vanilla, if you encounter any errors please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game in Steam. You can quickly find your game folder by right clicking RF:G in your Steam library, selecting properties, clicking Local files and finally Browse. Verify integrity of game files is also found here.<br />
# After SyncFaction is done verifying you will see a button at the bottom middle <code>Update to latest Community Patch</code>, click it & SyncFaction will automatically download and install the patch; you will see the progress tracked in the log.<br />
# When it has successfully installed the patch you will see this wiki page instead of the log along with <code>Run Game</code>, <code>Apply</code> & <code>Refresh</code> buttons, you don't need to do anything else and can close SyncFaction now.<br />
<br />
== Updating Terraform Patch ==<br />
<br />
* If you've played game nights before, get latest SF version and let it do the update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* No need to waste time verifying game with Steam!<br />
<br />
== Troubleshooting ==<br />
<br />
* Make sure you're on the latest SF version and update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* If you suspect your game is corrupted, please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game.<br />
* Sometimes after installing the required .NET version you will need to restart your computer for SF to work.<br />
* '''DON'T''' install any mods or maps on top of the patch or you'll corrupt your game!<br />
* '''DON'T''' use RSL1 for the Steam version of the game, it won't allow you into multiplayer due to cheating concerns.<br />
* If you have both the Steam & GOG versions installed, lots of drives or SF is having issues finding your game install try putting <code>SyncFaction.exe</code> with <code>rfg.exe</code> in the respective game versions folder.<br />
* If your anti virus detects <code>SyncFaction.exe</code> as malware you can be assured it's a false positive, it's open source on github and developed by a trusted member of the community. You can safely make an exception in your anti virus software.<br />
* If SyncFaction has trouble downloading the patch and shows an error starting with <code>System.Net.Http.HttpRequestException</code> it's probably being blocked by your firewall.<br />
* If your game crashes on startup it's possible you incorrectly replaced <code>sw_api.dll</code> for the Steam version when that is only needed for the GOG version, try restoring it to the Steam version: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_debug/mp_fix/steam/sw_api.dll<br />
* If you're unable to move your character, pause the game and then unpause.<br />
* If you're unable to connect to a lobby, go back to the main menu then back into multiplayer. If it still doesn't work you will need to restart your game, the host of the lobby can also try starting a new lobby if it still doesn't work.<br />
* If your GPU only has 1gb of VRAM try turning down all graphics settings down to minimum.<br />
* '''NUCLEAR''' option if other troubleshooting steps above fail or your game is frequently crashing: delete the entire <code>data</code> folder and verify game in Steam. If using GOG completely uninstall the game and install from scratch and then use the latest SF version to re-install the Terraform Patch.<br />
* This app release is not tested thoroughly so please be patient & report any bugs to rast1234.<br />
<br />
=== Saving Space ===<br />
<br />
* After you've updated to the current latest version of the patch it's safe to delete the <code>\data\.syncfaction\mod_xxx</code> folders.<br />
* This is because previous patch versions are cached there and not needed since last update is not incremental.<br />
<br />
=== Confirming Patch Installed Correctly === <br />
<br />
* On the first loading screen before the main menu you should see <code>Terraform Patch v1.075 ALPHA</code> at the bottom right. Example: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/misc.vpp_pc/E_TEXTURE_CHANGES/SOURCE/ui_loading_init.png?raw=true<br />
* When creating a custom match the default options should have fleetfoot selected as the starting backpack.<br />
* You should see DLC Wrecking Crew & custom maps when going through map selection such as Storage, Abandoned, Nordic Bonus, Ruins, Imperial etc.<br />
* You should see DLC Weapons when going through weapons such as the Subverter, Spiker, Misslepod etc.<br />
* You should see new characters in the multiplayer customization screen such as Jenkins, Sam, Voice of Mars etc.<br />
<br />
=== Networking Issues === <br />
<br />
* As the game relies on THQN servers and it seems NAT punching isn't always reliable some connection issues like not being able to join certain player & players not being able to join you may require manual configuration of your network to resolve.<br />
* Ensure <code>rfg.exe</code> isn't blocked by the Windows Firewall for both <code>Inbound</code> and <code>Outbound</code> connections. You can make new rules to <code>Allow the connection</code> for both <code>Inbound</code> and <code>Outbound</code> by searching for <code>Windows Defender Firewall with Advanced Security</code>. See the guide below for more advanced instructions.<br />
* Ensure all the games ports are forwarded in your routers firewall: you will need to setup a Static IP on your computer and forward the following ports in your router: <code>TCP: 80</code>, <code>UDP: 88</code>, <code>TCP/UDP: 443</code>, <code>TCP/UDP: 3074</code>, <code>UDP: 3478</code>, <code>UDP: 4379-4380</code>, <code>TCP/UDP: 23022</code>, <code>TCP/UDP: 38888</code>, <code>TCP/UDP 27000-27100</code> & <code>TCP/UDP: 61111</code>. Consult your routers manual on how to do this and see the guide below for detailed instructions on setting up a Static IP.<br />
* You can also setup DMZ for your Static IP but this is less secure. Consult your routers manual on how to do this.<br />
* It's possible your ISP is blocking ports, you can try using their app if they provide one or calling them and asking them to unblock all ports.<br />
* It's possible issues may be caused by a bad router/modem.<br />
* [https://www.howtogeek.com/19249/how-to-assign-a-static-ip-address-in-xp-vista-or-windows-7/ How to Assign a Static IP Address in Windows 10 or 11]<br />
* [https://www.howtogeek.com/112564/how-to-create-advanced-firewall-rules-in-the-windows-firewall/ How to Create Advanced Firewall Rules in the Windows Firewall]<br />
<br />
=== Configs & Save Data Corruption ===<br />
<br />
* It's unknown if this is required but it might be worth a try if you've followed all previous troubleshooting steps and you're still having issues with your game.<br />
* Delete <code>config.ini</code> in <code>%APPDATA%\kaiko\rfg\</code>. This will reset all your settings to default and you will have to reconfigure them the next time you start your game.<br />
* Steam save: <code><Steam-folder>\userdata\<user-id>\667720\remote\</code> or <code><Steam-folder>\userdata\<user-id>\667720\remote\autocloud\save</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* GOG save: <code>%LOCALAPPDATA%\GOG.com\Galaxy\Applications\51153410217180642\Storage\Shared\Files\autocloud\save\</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* Note: It's possible to transfer the Steam save to GOG or vice versa so you can try that also.<br />
<br />
=== Improving Game Stability ===<br />
<br />
# Right click <code>rfg.exe</code> in your game folder.<br />
# Select <code>Properties</code> in the context menu.<br />
# Select the <code>Compatibility</code> tab.<br />
# Tick <code>Disable fullscreen optimizations</code>.<br />
# Click <code>Change high DPI settings</code>.<br />
# Tick <code>Override high DPI scaling Behavior. Scaling performed by: Application</code>.<br />
# Click ok to both windows.<br />
# If on Windows 11 follow the below additional steps.<br />
# Open the <code>Settings</code> app.<br />
# Navigate to System > Display > Graphics > Add an app > Desktop app > Find <code>rfg.exe</code>.<br />
# Once it's added, search for rfg and click <code>Options</code>.<br />
# Tick <code>Don't use optimizations for windowed games</code>.<br />
# Make sure you select exclusive fullscreen inside the games option menu.<br />
[[File:GameStabilityFix.jpeg|frameless|512px]]<br />
<br />
=== Microstuttering Fix ===<br />
<br />
* Disable '''VSYNC''' in the games option menu.<br />
* Force '''VSYNC''' in your graphics card control panel. <br />
* Cap the framerate to your refresh rate in your graphics card control panel.<br />
* Make sure you select exclusive fullscreen inside the games option menu.<br />
<br />
== Terraform Patch Info ==<br />
<br />
* Changelog: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/changelog.txt<br />
* Known Issues: https://github.com/users/CamoRF/projects/3/views/1<br />
* Github: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch<br />
* This patch is an alpha version so you may encounter bugs, please ping Camo in the rfg-modding channel to report any issues.<br />
<br />
== Recommended Competitive Game Settings ==<br />
<br />
* Note: settings are always personal preference but this should serve as a decent starting guide if you want to play more competitively.<br />
* The default keybindings for RF:G are unusual compared to other shooters, most members in the community recommend the following settings:<br />
* All options are found under <code>Main Menu</code> --> <code>Options</code><br />
<br />
* Controls & Keybindings<br />
* Zoom: Right Click<br />
* Melee Attack: F<br />
* Melee Attack 2: Side Mouse Button if your mouse has one<br />
* Shoulder Switch: Side Mouse Button if your mouse has one<br />
* Zoom: Hold<br />
* Crouch: Toggle<br />
<br />
* Audio Options (These will allow you to hear enemy movement more clearly)<br />
* Ambience: 50%<br />
* Music: 0%<br />
* Voice: 50%<br />
* SFX: 100%<br />
<br />
* Graphics Options<br />
* FOV: 85<br />
* Depth of Field: Disabled<br />
* Motion Blur: Disabled<br />
<br />
* Game Options<br />
* Camera Shake: Disabled<br />
<br />
== Run game ==<br />
<br />
All maps are included in the Terraform Patch and you don't need to install anything else. Join the [https://discord.gg/factionfiles FactionFiles Discord] and subscribe to RF:G Game Night event!</div>Camohttps://www.redfactionwiki.com/w/index.php?title=Nanoforge_basics&diff=8978Nanoforge basics2023-06-25T03:29:34Z<p>Camo: /* Spectator Cameras */</p>
<hr />
<div>{{RFGEditing}}<br />
{{Under construction}}<br />
<br />
This page goes over how to install Nanoforge and it's basic features. This article only goes over the basics of each feature. See the other guides for more detailed explanations.<br />
<br />
==Installation==<br />
===Download===<br />
Nanoforge releases are posted on [https://github.com/Moneyl/Nanoforge/releases github]. Multiple releases will be listed. You should always download the most recent release. To download it, look for the <code>▸Assets</code> button(1), click it, and download the first zip file listed under it(2).<br />
<br />
[[File:NanoforgeDownloadStepsAnnotated.png|frameless|768px]]<br />
<br />
===Install===<br />
*Unpack the zip file you downloaded anywhere and run Nanoforge.exe<br />
*You should now see the start screen. On the left side it has the data path and the recent projects list. On the right it has the changelog. Nanoforge with attempt to auto detect your RFG install. If it says that your data path is invalid click the <code>Browse...</code> button and select your RFG data folder.<br />
<br />
==Features==<br />
This section gives a quick rundown of each of Nanoforge's features.<br />
<br />
===Projects===<br />
Nanoforge uses projects to track edits made to game files. The idea is to use a single project per mod. You only need to create a project if you're editing files. You don't need one to view and export files. To create a new project click <code>New project</code> in the start page or <code>File > New project...</code> on the main menu bar. Fill out all the info on the popup and click <code>Create</code>. Below are each of the fields to fill in:<br />
*Name: The name of the project. Used to name the project file and as the name in any modinfo.xml files it generates.<br />
*Path: Path to the folder that the project should be created in.<br />
*Description: (Optional) Description of what the mod is. Used in the description field of modinfo.xml.<br />
*Author: (Optional) Author(s) of the mod. Used in the author filed of modinfo.xml.<br />
*Create project folder: If unchecked then the project files are placed directly in the folder chosen for path. If checked a folder with the entered name will be created in that folder.<br />
<br />
===File explorer===<br />
The file explorer lets you view the contents of vpp_pc and str2_pc files without extracting them manually. You can double click supported file formats like textures to open them. If you single click a vpp_pc or str2_pc file it will expand to show it's contents. Extra info about the file will be shown in the properties panel for some files when single clicking them.<br />
<br />
[[File:Nanoforge ProjectCreationExample3.png|frameless|256px]]<br />
<br />
====Search====<br />
You can use the search bar to limit which files are shown in the file explorer. By default it will only show files with names that contain the search term. You can also use some special characters to specialize your search behavior:<br />
*Start your search with *: Will only show files with names that end with whatever comes after *<br />
*End your search with *: Will only show files with names that start with whatever comes before *<br />
<br />
If you prefer regex you can check the regex search option. Note that the regex search option is much slower than the default one.<br />
<br />
===Properties panel===<br />
The properties panel sometimes will show additional info about files selected in the file explorer. It also may be used by other UI panels to show additional info. For example, it can list object properties when viewing territories (see map viewing section below).<br />
<br />
[[File:Nanoforge_PropertiesPanel2.png|frameless|256px]]<br />
<br />
===Textures===<br />
You can open texture files by double clicking them in the file explorer. Textures are split into two files. Either a cpeg_pc and gpeg_pc file pair or a cvbm_pc and gvbm_pc file pair. You can double click any of these to open a texture. A single RFG texture file can contain multiple textures, which we'll refer to as subtextures. Info about the selected subtexture will be shown below the subtexture list.<br />
<br />
[[File:Nanoforge_TextureDocument.png|frameless|768px]]<br />
<br />
Above is an example of what you might see if you open a texture file. On the sidebar to the left there a few things, in order:<br />
*The subtexture list. Click on one to see more info about it below.<br />
*Texture info. This is info about the selected subtexture.<br />
*Header info. This is general info about the cpeg/cvbm file.<br />
<br />
====Exporting textures====<br />
Textures can be exported to files you can edit with common image editors like Paint.NET, GIMP, or Photoshop. Currently textures can only be exported as .dds files. You can export single subtextures by right clicking one of them and clicking <code>Export...</code>. You can export all subtextures at once with the <code>Export all...</code> button.<br />
<br />
====Editing textures====<br />
Textures can be edited by imported textures you've edited externally. Currently it can only import .dds files. You do this by right clicking a subtexture, clicking <code>Replace...</code> and selecting the file you want to replace the subtexture with. Once you do this it's critical that you press the <code>Save</code> button above the subtexture list to save your edit. This edit will be automatically saved to your current project when you click <code>Save</code>. See [[Nanoforge Texture Editing]] for more info.<br />
<br />
===Meshes===<br />
Nanoforge supports viewing and exporting .csmesh_pc (static mesh) and .ccmesh_pc (character mesh) files. Just like textures, meshes consist of two files. Every csmesh_pc file is paired with a gsmesh_pc file, and every ccmesh_pc file is paired with a gcmesh_pc file. You can click any of them to open a mesh. When you open a mesh you'll first see a blank space. Meshes are loaded on a background thread so it may take a few seconds for the mesh to be loaded and for it's textures to show up. Before its textures are found or if the textures cant be found you might see textures from previously loaded meshes applied to the mesh.<br />
<br />
[[File:Nanoforge_MeshDocument.png|frameless|512px]]<br />
<br />
Above is what you might see if you open a mesh file. There's a few parts of the UI to note, in order:<br />
* The camera button. This lets you control camera settings like speed and location. You can move the camera by holding down the right mouse button and using WASD to move around. If this doesn't work try left clicking on the mesh 3D view. Only the most recently selected mesh reacts to camera controls so if you have several open it'll only move one camera.<br />
* The scene button. This has some rendering settings for the mesh such as scale and lighting color/intensity.<br />
* The info button. This shows some additional info about the mesh such as vertex format, and the LOD slider for meshes with multiple levels of detail.<br />
* The export button. This lets you export the mesh and it's textures to a .obj file, which can be imported into tools like blender.<br />
* The status bar. This shows the loading status and percentage. It will show <code>Done! ✓</code> once loading is complete.<br />
<br />
====Exporting meshes====<br />
To export a mesh:<br />
* Wait for it to finish loading. The status bar will show <code>Done! ✓</code> and 100%.<br />
* Click the export button. Top left of the document, button furthest to the right.<br />
* Select a folder to export the mesh and it's textures to and click <code>Export</code>.<br />
<br />
A single gltf file and the meshes textures will be exported. Each lod level is labelled in the gltf under their own subnode. Currently these gltf files don't look right as is when imported into Blender. This is because GLTF uses a different rendering model than RFG. Typically meshes have a diffuse, specular, and normal texture. Their names end with _d, _s, and _n respectively. You'll need to make the following changes to the textures in the Blender shading tab:<br />
* Diffuse -> Set color space to linear, attach texture color to "Base Color" on the BSDF<br />
* Specular -> Set color space to linear, attach texture color to "Specular" on the BSDF<br />
* Normal -> Set color space to SRGB, attach texture color to "Normal" on the BSDF<br />
<br />
In the near future an extension will be made to automatically patch the shader graph.<br />
<br />
====Camera movement====<br />
To move the camera hold down the right mouse button over the 3D view and use WASD to move around. Holding down shift while moving will cause the camera to move faster. Pressing Q and E will move the camera directly up and directly down respectively.<br />
<br />
===Mod packaging===<br />
Once you're done editing textures you can use Nanoforge to repack the editing files and generate a modinfo.xml for you. To do this, simply click <code>File > Package mod</code> on the main menu bar. Once it's done go to the "Output" folder inside your project folder to see the modinfo.xml and any files that it relies on. These are ready for use with the re-mars-tered mod manager.<br />
<br />
===Map view===<br />
Nanoforge has partial support for viewing maps like the main campaign map. We'll be referring to them as territories as that's how RFG groups together many zones. See [[RF:G Map organization]] for more details on how RFG maps are structured. To open a territory via <code>Tools > Open territory</code> on the main menu bar. Terr01 is the main campaign map territory. A new document should appear when you open a new territory. Camera movement is the same as the mesh viewer. See [[#Camera_movement|camera movement]]. Terrain is loaded in the background so you'll see separate blocks of terrain pop into view as they load. Bounding boxes are drawn for zone objects. With a territory open you should see new information on the zone panel and the zone objects panel. You can dock panels by clicking and dragging on their titles. It's recommended that you dock the zone object list below the zone list so you can see both at once.<br />
<br />
Below is an annotated image of information you can view about territories plus descriptions for each annotation.<br />
<br />
[[File:Nanoforge_W3p0erDiTj.jpg|frameless|1024px]]<br />
<br />
* First, in the top left is the zone list. Territories are made up of one or more zones which in turn have many zone objects. Click a zone to see its object in the zone objects panel (bottom left). By default the zone with the most objects is selected. In this case that's <code>04_06</code>. Note that each zone corresponds to a rfgzone_pc file. So, for example, <code>04_06</code> is really terr01_04_06.rfgzone_pc.<br />
* Next, bottom left is the zone objects list. This lists the objects inside the selected zone. Click an object to see its properties in the properties panel. Some objects have child objects, denoted by having a triangle in front of their name which you can click to expand them. You can filter objects by type inside the filters header. By default some very common objects like navpoints are hidden.<br />
* Finally, in the top right is the properties panel. This shows the properties of the selected zone object.<br />
<br />
==Object Flags==<br />
* Flag 0 (Persistent): Unknown, any objects with this flag have a separate copy stored in a second <code>rfgzone_pc</code> file with its name prefixed with <code>p__.</code> So, for example, Crescent has two <code>rfgzone_pc</code> files. <code>mp_crescent.rfgzone_pc</code> and <code>p_mp_crescent.rfgzone_pc</code>. The objects with the persistent flag are stored in both zone files, while objects without that flag are only stored in <code>mp_crescent.rfgzone_pc</code>. It's consistently used on player spawns, on most siege objectives and on most <code>rfg_movers</code> on Siege maps. It's recommended you don't enable or disable this flag on maps if you're using the Terraform Patch as it contains fixes for missing objects that incorrectly used this flag or were missing it; doing so will cause objects to vanish.<br />
* Flag 1: Unknown<br />
* Flag 2: Unknown <br />
* Flag 3: Unknown; might be related to how the game saves/loads map data from save files (requires more investigation)<br />
* Flag 4: Unknown; seems to always get converted to the runtime flag <code>streaming_fixed</code>, most <code>rfg_movers</code> and <code>general_movers</code> have this flag. If you're using the Terraform Patch it's recommended you don't disable this flag as it applies it to all objects since it was used most of the time and objects missing it were assumed to be an error by Volition. (They also made mistakes with the gamemode and persistent flags)<br />
* Flag 5: Unknown; seems to get converted to the runtime flag <code>force_full_save</code><br />
* Flag 6: Unknown<br />
* Flag 7: Unknown<br />
* Flag 8: Spawns in Anarchy<br />
* Flag 9: Spawns in Team Anarchy<br />
* Flag 10: Spawns in CTF<br />
* Flag 11: Spawns in Siege<br />
* Flag 12: Spawns in Damage Control<br />
* Flag 13: Spawns in Bagman<br />
* Flag 14: Spawns in Team Bagman<br />
* Flag 15: Spawns in Demolition<br />
<br />
==Chunk Flags==<br />
* Applies to <code>rfg_movers</code> & <code>general_movers</code>.<br />
* When editing their properties in the inspector it's possible to change the <code>chunk_flags</code>.<br />
* You can also use <code>gameplay_properties.xtbl</code> to apply these flags and change <code>gameplay_props</code>. If you're using the Terraform Patch a new <code>gameplay_prop</code> named <code>Invulnerable</code> is added which also can be used to make objects indestructible.<br />
* Eg: <code>dynamic_link invulnerable</code> will make the object indestructible. Full list of flags below:<br />
* child_gives_control: Unknown.<br />
* building: Unknown.<br />
* dynamic_link: Unknown.<br />
* world_anchor: Unknown.<br />
* no_cover: Might be where EDF can't take cover behind objects.<br />
* propaganda: EDF propaganda billboards you destroy for the achievement in singleplayer have this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows to track the players progress and reduce EDF control of the sector.<br />
* kiosk: <code>tech_kiosk_EDF_A</code> has this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows its a special object that plays propaganda videos.<br />
* touch_terrain: Unknown, no <code>gameplay_properties.xtbl</code> entries use this flag and it's missing from the table description.<br />
* supply_crate: EDF crates you destroy for the achievement in singleplayer have this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows to track the players progress.<br />
* mining: Ores you mine for salvage and the achievement in singleplayer have this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows to track the players progress.<br />
* one_of_many: Unknown, <code>windmill_0708</code>, <code>0102smokestack_86</code> & <code>0102smokestack_86_child</code> have this flag in <code>gameplay_properties.xtbl</code>. Might be related to one of the side activities where you have to destroy multiple targets.<br />
* plume_on_death: Unknown.<br />
* invulnerable: Makes an object indestructible.<br />
* inherit_damaga_pct: Unknown.<br />
* regrow_on_stream: Unknown.<br />
* casts_drop_shadow: Object will cast drop shadows.<br />
* disable_collapse_effect: Unknown.<br />
* force_dynamic: Unknown.<br />
* show_on_map: Most objects in <code>gameplay_properties.xtbl</code>. Most likely means the object will show on the minimap in singleplayer.<br />
* regenerate: Unknown.<br />
* casts_shadow: Object will cast a shadow map.<br />
<br />
==Object Info==<br />
* <code>obj_zone</code> = Defines the wind speed, terrain file name & <code>spawn_resource_data</code>. If you move its location the terrain will no longer have collision.<br />
* <code>MPST</code> = Multiplayer siege target.<br />
* <code>MPDCT</code> = Multiplayer damage control target.<br />
* <code>shape_cutter</code> = Causes object to start off with initial damage, used on damage control targets or maps like crash site, ruins & remnant where they put a hole in the wall.<br />
* <code>spawn_node</code> = Camera view at start of match and end of game. If a map doesn't have a least one of these it will crash.<br />
* <code>spectator_camera</code> = Camera view exclusively for players using the spectator mode, recommended to just ignore adding them and use <code>spawn_nodes</code> instead.<br />
* <code>trigger_region</code> = Killbox that can be set to a mine or cliff.<br />
* <code>rfg_mover</code> = Buildings, backpack racks & more.<br />
* <code>general_mover</code> = Explosive barrels and the <code>backpack_effect_attach.cchk_pc</code> objects for example.<br />
* <code>player_start</code> = Spawn point, can be set to Neutral, EDF or Guerilla.<br />
* <code>item</code> = In multiplayer the bag for bagman is set to <code>item_type</code> "multi_object_bagman_flag" and references <code>items_3d.xtbl</code>.<br />
* <code>weapon</code> = Weapon spawn, <code>weapon_type</code> determines which weapon will spawn and references <code>weapons.xtbl</code>.<br />
* <code>object_effect</code> = Visual effect, eg the fire on Nordic Bonus.<br />
* <code>multi_object_marker</code> = Multiple uses, in multiplayer the <code>marker_type</code> can be set to <code>Backpack rack</code>, <code>Spawn node</code>, <code>Flag capture zone</code>, <code>King of the Hill target</code>, <code>Siege target</code> & <code>Spectator camera</code>.<br />
* <code>cover_node</code> =<br />
* <code>navpoint</code> = Probably where NPCs can navigate, similar to navmeshes in other games.<br />
* <code>object_action_node</code> = <br />
* <code>object_squad_spawn_node</code> = Probably where squads spawn and references various <code>squads.xtbl</code> files.<br />
* <code>object_path_road</code> = Probably where NPCs can drive vehicles.<br />
* <code>object_guard_node</code> =<br />
* <code>object_vehicle_spawn_node</code> = Probably where vehicles can spawn like walkers found around the SP map.<br />
* <code>object_bounding_box</code> = Seems to be only be used in singleplayer, unknown why.<br />
* <code>object_activity_spawn</code> = Probably where you can start a side activity like demolition master for example.<br />
* <code>object_house_arrest_node</code> = Related to the house arrest side activity.<br />
* <code>object_patrol</code> = Probably where EDF patrol.<br />
* <code>object_dummy</code> =<br />
* <code>object_mission_start_node</code> = Probably where you can start a main mission.<br />
* <code>object_restricted_area</code> = Probably where the EDF will attack on sight and you will get an alert level in SP.<br />
* <code>backpack_effect_attach.cchk_pc</code> = Seems to be for attaching the backpack to the player when they spawn, DO NOT TOUCH IT ALL OR THE MAP WILL CRASH WHEN SPAWNING.<br />
<br />
==Object Properties==<br />
* <code>gameplay_props</code> references <code>gameplay_properties.xtbl</code>.<br />
* <code>backpack_type</code> references <code>mp_backpacks.xtbl</code>.<br />
* <code>weapon_type</code> references <code>weapons.xtbl</code>.<br />
* <code>item_type</code> references <code>items_3d.xtbl</code>.<br />
* <code>spawn_resource_data</code> references <code>spawn_resource.xtbl</code>.<br />
* <code>ambient_spawn</code> references <code>ambient_spawn_info.xtbl</code> or <code>dlc01_ambient_spawn_info.xtbl</code>.<br />
* <code>visual</code> references <code>effects.xtbl</code>.<br />
* <code>sound</code> references <code>foley.xtbl</code> (not included in the game for some reason) however there is <code>dlc01_foley.xtbl</code>.<br />
<br />
==Spawn Points==<br />
* <code>mp_team</code> can be set to <code>Neutral</code>, <code>EDF</code> or <code>Guerilla</code>.<br />
* When making a CTF map and you don't want players spawning at the opposing base ensure you disable the Flag <code>Spawn in CTF</code> for any Neutral spawn points.<br />
* Unknown if the <code>respawn</code> and <code>initial_spawn</code> booleans do anything in multiplayer.<br />
* <code>indoor</code> boolean is probably left over from Saints Row since all of RF:G is technically outdoors and no spawn points use this boolean.<br />
* <code>checkpoint_respawn</code> & <code>activity_respawn</code> are only used in singleplayer.<br />
* Foward X axis (blue line) determines player spawn direction.<br />
<br />
==Spawn Nodes==<br />
* Camera views at the start of match or when a player dies and is spectating.<br />
* Foward X axis (blue line) determines player camera direction & view.<br />
* If a map doesn't have at least one <code>Spawn node</code> it will crash when loading.<br />
<br />
==Spectator Cameras==<br />
* Believed to be similar to a <code>Spawn node</code> but used exclusively by players using the spectator option in matchmaking. Recommended to just ignore adding these since the community only plays custom games and adding <code>Spawn nodes</code> to your map will serve the same purpose.<br />
* Foward X axis (blue line) determines player camera direction & view.<br />
<br />
==Mover Types==<br />
* Applies to <code>rfg_movers</code><br />
* When editing their properties it's possible to change the <code>mtype</code> field to the corresponding numbers<br />
* Fixed = 0 (default)<br />
* Normal = 1 (unknown)<br />
* Lite = 2 (unknown)<br />
* Ultra Lite = 3 (unknown)<br />
* World Only = 4 (no collision but you can still destroy it with a hammer for example)<br />
* No Collision = 5 (no collision)<br />
<br />
==Damage Control Targets==<br />
# Deep clone <code>MPDCT_MAPNAME_XXX</code>.<br />
# Move </code>MPDCT_MAPNAME_XXX</code> to the location of your choosing.<br />
# In object properties for the parent change <code>display_name</code> to whatever you want your new damage control objective to be called.<br />
# If you're making a map that doesn't already have a damage control target you can open it in another tab and use the deep clone feature. If you're using the Terraform Patch the majority of Wrecking Crew maps will already have the asset along with all Siege maps.<br />
# It's also possible to have only <code>1</code> target & more than <code>3</code>. The limit before the game will crash is a total of <code>6</code> targets when tested solo. The limit might be lower when played with other people but needs to be tested more.<br />
# It's also possible that using the same <code>display_name</code> name for each target can introduce instability.<br />
# The only valid value for the <code>mp_team</code> property is <code>Neutral</code>. If you change the team to <code>EDF</code> or <code>Guerilla</code> and disable the <code>shape_cutter</code> child so the target starts off intact it will belong to that team but not score any points until it's destroyed and repaired.<br />
# You can disable the <code>shape_cutter</code> child so the target starts off intact instead of destroyed like it is by default.<br />
# Any object can be used for a target if you add the <code>multi_object_marker</code>, <code>shape_cutter</code> and offset them correctly from the parent. See Stratosphere if using the Terraform Patch for how to do this; shipping containers are the targets added on that map in the patch.<br />
<br />
==Siege Targets==<br />
# Open a siege map in one tab, open a regular map with the same objects in another tab.<br />
# Deep clone the siege target to the regular map.<br />
# Move the added siege target to the exact same location as the existing matching object on the regular map.<br />
# Disable all the gamemode flags for the added siege target except for "Spawn in Siege" including its children.<br />
# Delete all the children of the siege targets (usually spawns that will be outside the map since they were deep cloned from the siege map), after they are all deleted make sure to "orphan children" of the child to ensure it doesn't have ghost children. <br />
# Disable the <code>Spawn in siege</code> flag on the matching original map object.<br />
# You need to update <code>mp_levels.xtbl</code> so the map is selectable in siege.<br />
# Ensure the siege target and its child have the persistent flag.<br />
# The <code>priority</code> property for the <code>Siege target</code> child determines which siege objects are unlocked to destroy, eg if you set it to <code>1</code> it would be the first target the attackers can destroy, you can have multiple targets unlocked by using the same number and if you wanted to have targets unlocked one at a time you would use <code>1</code>, <code>2</code>, <code>3</code> and so on. If you use a value of <code>4294967295</code> they are also unlocked at the same time.<br />
# You must use an existing string in the game for the <code>display_name</code> property on the child or the map will crash.<br />
# If you mess up the offset of the child the map will crash.<br />
<br />
==Backpack Racks==<br />
* Make sure you deep clone them when adding new racks, the child <code>Backpack rack</code> is required for it to work properly.<br />
* Ensure that when moving the rack to a new location you only move the parent (the child will follow and be offset correctly), they will be named <code>Jetpack</code> for example if you're using the Terraform Patch.<br />
* When editing the child <code>backpack_type</code> determines which backpack will spawn, most are the same as their in game names with the exception of Firepower <code>Commando</code> & Concussion <code>Shockwave</code>. These names are from <code>mp_backpacks.xtbl</code>.<br />
* When editing the child you can change the number of backpacks on a rack, edit <code>num_backpacks</code> and change it from a value ranging from <code>0-3</code>, although <code>0</code> would mean the rack is empty and useless.<br />
* When editing the child it's possible to make it team exclusive, this means only the EDF or Red Faction can pickup backpacks from that rack during team game modes. Edit <code>mp_team</code> and enter either <code>EDF</code> or <code>Guerilla</code>. In game that rack will have a green glow around it if your team can use it.<br />
* The <code>random_backpacks</code> boolean in the object properties for the <code>Backpack rack</code> child doesn't seem to do anything.<br />
* It's possible to make Backpack Racks destructable by changing <code>gameplay_props</code> to <code>Default</code>. During team game modes teams can fight for control by destroying racks and repairing them so only their team can use them. Racks you're able to use will glow green and racks you can't will glow red if you're using the Terraform Patch.<br />
* The maximum number of Backpack Racks you can have on a map before it causes issues is <code>25</code>.<br />
<br />
==Capture the Flag targets==<br />
* The EDF and Red Faction have their own unique flag stand placed near their team spawns on regular multiplayer maps.<br />
* Make sure you use deep cloning and only move the parent when placing or moving them so the child is offset correctly.<br />
* Objects are called <code>edf_flag_stand.cchk_pc</code> & <code>guerrilla_flag_stand.cchk_pc</code>.<br />
* If you attempt to add more than two stands to a map, the extras will not work as capture points and only the asset will appear.<br />
* <code>Neutral</code> is not a valid value for <code>mp_team</code>.<br />
<br />
==Bagman Objective Spawn==<br />
* Object is an <code>item</code> type referencing <code>items.3d_xtbl</code>.<br />
* Ignore the varying bounding box sizes when positioning the bag spawn, the XYZ axis position is what matters (the red, blue & green lines).<br />
* The <code>respawn</code> boolean doesn't do what you expect, the bag will still return to the original spawn point regardless if it's enabled or not.<br />
* You can't place more than one bag on a map normally, only one will spawn. However you can have different bag locations in Bagman and Team Bagman by using the gamemode flags.<br />
<br />
==Weapon Spawns==<br />
* You should clone other weapons to add new ones, if you make them from scratch and don't get the bounding box correct for certain weapons it can cause duplicate weapon spawns in some cases.<br />
* <code>weapon_type</code> determines which weapon will spawn and references <code>weapons.xtbl</code>.<br />
* The <code>preplaced</code> boolean needs more testing but you can disable weapons in certain game modes by disabling the game mode flags anyway.<br />
* The <code>respawns</code> boolean will cause the weapon to not re-spawn again during a match after it has been picked up for the first time.<br />
* Ensure the bounding box is slightly above the ground/floor when positioning weapons.<br />
<br />
==Trigger Regions==<br />
* In multiplayer & singleplayer these are used to prevent the player from going out of bounds.<br />
* <code>region_kill_type</code> can be set to a <code>cliff</code> or a <code>mine</code>. A cliff will cause the player to fall to their death, while a mine will explode and kill the player; this is also reflected in the killfeed message in multiplayer.<br />
* In singleplayer the <code>trigger_flags</code> can be changed so the trigger isn't enabled during missions and/or activities. Eg. <code>not_in_mission</code> will disable it during a main mission, <code>not_in_activity</code> would disable it during a side activity and <code>not_in_mission not_in_activity</code> would disable it during both.<br />
* The <code>enabled</code> boolean allows mappers to enable/disable the region.<br />
* The <code>trigger_shape</code> can be set to a <code>box</code> or <code>sphere</code>. However Nanoforge cannot render spherical bounding boxes yet.<br />
* <code>outer_radius</code> might control the size of the region, but this is untested.<br />
<br />
==Object Effects==<br />
* Plays an effect such as smoke, fire, explosion, sparks, etc. Also can play sounds if the effect has one in <code>effects.xtbl</code> and the sound string is used.<br />
* <code>sound_alr</code> = Unknown. <br />
* <code>sound</code> = The name of the sound in <code>effects.xtbl</code><br />
* <code>visual</code> = The name of the effect in <code>effects.xtbl</code><br />
* <code>looping</code> = Controls if the effect will play once or continuously.<br />
<br />
==Shape Cutters==<br />
* Used to damage or cut holes into destructible objects ahead of time.<br />
* <code>outer_radius</code> might control the size of the cutter, but this is untested.<br />
<br />
==Maps with names different from their in-game names==<br />
* wc1 - Complex<br />
* wc2 - Watchtower<br />
* wc3 - Scrapheap<br />
* wc4 - Vista<br />
* wc5 - Fortress<br />
* wc6 - Factory<br />
* wc7 - Gulch<br />
* wc8 - Cascade<br />
* wc9 - Transmission<br />
* wc10 - Pipeline<br />
* wcdlc1 - Ruins<br />
* wcdlc2 - Repercussion<br />
* wcdlc3 - Imperial<br />
* wcdlc4 - Expansion<br />
* wcdlc5 - Frost<br />
* wcdlc6 - Abandoned<br />
* wcdlc7 - Stratosphere <br />
* wcdlc8 - Invasion<br />
* wcdlc9 - Nordic Bonus<br />
* mpcx_crossover - Doubletime<br />
* mpcx_assembly - Outpost <br />
* mpdlc_landbridge - Equilibrium<br />
* mpdlc_islands - Haven<br />
* mpdlc_minibase - Complex<br />
* mpdlc_overhang - Gradient<br />
* mpdlc_ruins - Remnant<br />
<br />
==Maps with similar terrain==<br />
* Crash Site/Complex/Nordic Bonus<br />
* Rift/Factory<br />
* Remnant/Ruins<br />
* Broadside/Invasion<br />
* Wasteland/Gulch<br />
* Outpost/Framework<br />
* Radial/Transmission<br />
* Sand Pit/Division/Watchtower<br />
* Tutorial Area/Pipeline<br />
* Pinnacle/Fortress<br />
<br />
==Misc Notes==<br />
* Deep clone objects if you want to keep the children of an object and use regular clone if you just want to clone the parent. Only move the parent when deep cloning and the children will follow and be offset correctly.<br />
* If you see anything that looks like XML inside <code>layer_pc</code> or <code>rfgzone_pc</code> files you can ignore that as we're 99% sure it's junk from their file packer reusing memory without zeroing it out.<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail.<br />
<br />
===Localization strings===<br />
While Nanoforge is only in English at the moment it can view localized strings used by RFG. RFG uses placeholder strings in many xtbls which are replaced with their localization at runtime. These are shown automatically in the xtbl editor. You can also view a list of all localized strings via <code>Tools > Localization > View localized strings</code>. You can search by placeholder by checking "Search by identifier". You must fully enter the identifier without typos for this to work since it's comparing it to a hash of the identifier stored in the games localization files.<br />
<br />
[[File:Nanoforge_LocalizedStringList0.png|frameless|768px]]<br />
<br />
===Scriptx viewer===<br />
RFG uses an xml based scripting system called scriptx for some mission logic. The viewer is an attempt at making it easier to read scriptx files which can be difficult to understand. It's a low priority feature so it likely won't see changes for a while but was enabled in case it's useful to people editing scriptx files. You still need to edit them by hand but it can help make it clearer what a script is doing. You can access it via <code>View > Scriptx Viewer (WIP)</code>.<br />
<br />
[[File:Nanoforge_ScriptxViewer0.png|frameless|768px]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Game_Night_News&diff=8977RF:G Game Night News2023-06-24T12:12:17Z<p>Camo: /* Troubleshooting */</p>
<hr />
<div>{{Under construction}}<br />
<br />
== News ==<br />
<br />
* Terraform Patch v1.07.5 was recently released on the 8th of June, 2023. Please update before game night!<br />
* SyncFaction v9 was recently released on the 14th of March, 2023. Please update before game night!<br />
<br />
== Multiplayer Server Status ==<br />
<br />
* Steam version: Fix already included in latest update from Steam.<br />
* GOG version: You will need to manually replace <code>sw_api.dll</code> in the <code>Red Faction Guerrilla Re-Mars-tered</code> folder with the one from here: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_debug/mp_fix/gog/sw_api.dll<br />
<br />
== Installing Terraform Patch ==<br />
<br />
# Download https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
# Open SyncFaction.<br />
# The first time you run it SyncFaction will take some time verifying your game files are vanilla, if you encounter any errors please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game in Steam. You can quickly find your game folder by right clicking RF:G in your Steam library, selecting properties, clicking Local files and finally Browse. Verify integrity of game files is also found here.<br />
# After SyncFaction is done verifying you will see a button at the bottom middle <code>Update to latest Community Patch</code>, click it & SyncFaction will automatically download and install the patch; you will see the progress tracked in the log.<br />
# When it has successfully installed the patch you will see this wiki page instead of the log along with <code>Run Game</code>, <code>Apply</code> & <code>Refresh</code> buttons, you don't need to do anything else and can close SyncFaction now.<br />
<br />
== Updating Terraform Patch ==<br />
<br />
* If you've played game nights before, get latest SF version and let it do the update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* No need to waste time verifying game with Steam!<br />
<br />
== Troubleshooting ==<br />
<br />
* Make sure you're on the latest SF version and update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* If you suspect your game is corrupted, please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game.<br />
* Sometimes after installing the required .NET version you will need to restart your computer for SF to work.<br />
* '''DON'T''' install any mods or maps on top of the patch or you'll corrupt your game!<br />
* '''DON'T''' use RSL1 for the Steam version of the game, it won't allow you into multiplayer due to cheating concerns.<br />
* If you have both the Steam & GOG versions installed, lots of drives or SF is having issues finding your game install try putting <code>SyncFaction.exe</code> with <code>rfg.exe</code> in the respective game versions folder.<br />
* If your anti virus detects <code>SyncFaction.exe</code> as malware you can be assured it's a false positive, it's open source on github and developed by a trusted member of the community. You can safely make an exception in your anti virus software.<br />
* If SyncFaction has trouble downloading the patch and shows an error starting with <code>System.Net.Http.HttpRequestException</code> it's probably being blocked by your firewall.<br />
* If your game crashes on startup it's possible you incorrectly replaced <code>sw_api.dll</code> for the Steam version when that is only needed for the GOG version, try restoring it to the Steam version: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_debug/mp_fix/steam/sw_api.dll<br />
* If you're unable to move your character, pause the game and then unpause.<br />
* If you're unable to connect to a lobby, go back to the main menu then back into multiplayer. If it still doesn't work you will need to restart your game, the host of the lobby can also try starting a new lobby if it still doesn't work.<br />
* If your GPU only has 1gb of VRAM try turning down all graphics settings down to minimum.<br />
* '''NUCLEAR''' option if other troubleshooting steps above fail or your game is frequently crashing: delete the entire <code>data</code> folder and verify game in Steam. If using GOG completely uninstall the game and install from scratch and then use the latest SF version to re-install the Terraform Patch.<br />
* This app release is not tested thoroughly so please be patient & report any bugs to rast1234.<br />
<br />
=== Saving Space ===<br />
<br />
* After you've updated to the current latest version of the patch it's safe to delete the <code>\data\.syncfaction\mod_xxx</code> folders.<br />
* This is because previous patch versions are cached there and not needed since last update is not incremental.<br />
<br />
=== Confirming Patch Installed Correctly === <br />
<br />
* On the first loading screen before the main menu you should see <code>Terraform Patch v1.075 ALPHA</code> at the bottom right. Example: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/misc.vpp_pc/E_TEXTURE_CHANGES/SOURCE/ui_loading_init.png?raw=true<br />
* When creating a custom match the default options should have fleetfoot selected as the starting backpack.<br />
* You should see DLC Wrecking Crew & custom maps when going through map selection such as Storage, Abandoned, Nordic Bonus, Ruins, Imperial etc.<br />
* You should see DLC Weapons when going through weapons such as the Subverter, Spiker, Misslepod etc.<br />
* You should see new characters in the multiplayer customization screen such as Jenkins, Sam, Voice of Mars etc.<br />
<br />
=== Networking Issues === <br />
<br />
* As the game relies on THQN servers and it seems NAT punching isn't always reliable some connection issues like not being able to join certain player & players not being able to join you may require manual configuration of your network to resolve.<br />
* Ensure <code>rfg.exe</code> isn't blocked by the Windows Firewall for both <code>Inbound</code> and <code>Outbound</code> connections. You can make new rules to <code>Allow the connection</code> for both <code>Inbound</code> and <code>Outbound</code> by searching for <code>Windows Defender Firewall with Advanced Security</code>. See the guide below for more advanced instructions.<br />
* Ensure all the games ports are forwarded in your routers firewall: you will need to setup a Static IP on your computer and forward the following ports in your router: <code>TCP: 80</code>, <code>UDP: 88</code>, <code>TCP/UDP: 443</code>, <code>TCP/UDP: 3074</code>, <code>UDP: 3478</code>, <code>UDP: 4379-4380</code>, <code>TCP/UDP: 23022</code>, <code>TCP/UDP: 38888</code>, <code>TCP/UDP 27000-27100</code> & <code>TCP/UDP: 61111</code>. Consult your routers manual on how to do this and see the guide below for detailed instructions on setting up a Static IP.<br />
* You can also setup DMZ for your Static IP but this is less secure. Consult your routers manual on how to do this.<br />
* It's possible your ISP is blocking ports, you can try using their app if they provide one or calling them and asking them to unblock all ports.<br />
* It's possible issues may be caused by a bad router/modem.<br />
* [https://www.howtogeek.com/19249/how-to-assign-a-static-ip-address-in-xp-vista-or-windows-7/ How to Assign a Static IP Address in Windows 10 or 11]<br />
* [https://www.howtogeek.com/112564/how-to-create-advanced-firewall-rules-in-the-windows-firewall/ How to Create Advanced Firewall Rules in the Windows Firewall]<br />
<br />
=== Configs & Save Data Corruption ===<br />
<br />
* It's unknown if this is required but it might be worth a try if you've followed all previous troubleshooting steps and you're still having issues with your game.<br />
* Delete <code>config.ini</code> in <code>%APPDATA%\kaiko\rfg\</code>. This will reset all your settings to default and you will have to reconfigure them the next time you start your game.<br />
* Steam save: <code><Steam-folder>\userdata\<user-id>\667720\remote\</code> or <code><Steam-folder>\userdata\<user-id>\667720\remote\autocloud\save</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* GOG save: <code>%LOCALAPPDATA%\GOG.com\Galaxy\Applications\51153410217180642\Storage\Shared\Files\autocloud\save\</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* Note: It's possible to transfer the Steam save to GOG or vice versa so you can try that also.<br />
<br />
=== Improving Game Stability ===<br />
<br />
# Right click <code>rfg.exe</code> in your game folder.<br />
# Select <code>Properties</code> in the context menu.<br />
# Select the <code>Compatibility</code> tab.<br />
# Tick <code>Disable fullscreen optimizations</code>.<br />
# Click <code>Change high DPI settings</code>.<br />
# Tick <code>Override high DPI scaling Behavior. Scaling performed by: Application</code>.<br />
# Click ok to both windows.<br />
# If on Windows 11 follow the below additional steps.<br />
# Open the <code>Settings</code> app.<br />
# Navigate to System > Display > Graphics > Add an app > Desktop app > Find <code>rfg.exe</code>.<br />
# Once it's added, search for rfg and click <code>Options</code>.<br />
# Tick <code>Don't use optimizations for windowed games</code>.<br />
# Make sure you select exclusive fullscreen inside the games option menu.<br />
[[File:GameStabilityFix.jpeg|frameless|512px]]<br />
<br />
=== Microstuttering Fix ===<br />
<br />
* Disable '''VSYNC''' in the games option menu.<br />
* Force '''VSYNC''' in your graphics card control panel. <br />
* Cap the framerate to your refresh rate in your graphics card control panel.<br />
* Make sure you select exclusive fullscreen inside the games option menu.<br />
<br />
== Terraform Patch Info ==<br />
<br />
* Changelog: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/changelog.txt<br />
* Known Issues: https://github.com/users/CamoRF/projects/3/views/1<br />
* Github: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch<br />
* This patch is an alpha version so you may encounter bugs, please ping Camo in the rfg-modding channel to report any issues.<br />
<br />
== Recommended Competitive Game Settings ==<br />
<br />
* Note: settings are always personal preference but this should serve as a decent starting guide if you want to play more competitively.<br />
* The default keybindings for RF:G are unusual compared to other shooters, most members in the community recommend the following settings:<br />
* All options are found under <code>Main Menu</code> --> <code>Options</code><br />
<br />
* Controls & Keybindings<br />
* Zoom: Right Click<br />
* Melee Attack: F<br />
* Melee Attack 2: Side Mouse Button if your mouse has one<br />
* Shoulder Switch: Side Mouse Button if your mouse has one<br />
* Zoom: Hold<br />
* Crouch: Toggle<br />
<br />
* Audio Options (These will allow you to hear enemy movement more clearly)<br />
* Ambience: 50%<br />
* Music: 0%<br />
* Voice: 50%<br />
* SFX: 100%<br />
<br />
* Graphics Options<br />
* FOV: 85<br />
* Depth of Field: Disabled<br />
* Motion Blur: Disabled<br />
<br />
* Game Options<br />
* Camera Shake: Disabled<br />
<br />
== Run game ==<br />
<br />
All maps are included in the Terraform Patch and you don't need to install anything else. Join the [https://discord.gg/factionfiles FactionFiles Discord] and subscribe to RF:G Game Night event!</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Game_Night_News&diff=8976RF:G Game Night News2023-06-24T12:11:10Z<p>Camo: /* Networking Issues */</p>
<hr />
<div>{{Under construction}}<br />
<br />
== News ==<br />
<br />
* Terraform Patch v1.07.5 was recently released on the 8th of June, 2023. Please update before game night!<br />
* SyncFaction v9 was recently released on the 14th of March, 2023. Please update before game night!<br />
<br />
== Multiplayer Server Status ==<br />
<br />
* Steam version: Fix already included in latest update from Steam.<br />
* GOG version: You will need to manually replace <code>sw_api.dll</code> in the <code>Red Faction Guerrilla Re-Mars-tered</code> folder with the one from here: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_debug/mp_fix/gog/sw_api.dll<br />
<br />
== Installing Terraform Patch ==<br />
<br />
# Download https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
# Open SyncFaction.<br />
# The first time you run it SyncFaction will take some time verifying your game files are vanilla, if you encounter any errors please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game in Steam. You can quickly find your game folder by right clicking RF:G in your Steam library, selecting properties, clicking Local files and finally Browse. Verify integrity of game files is also found here.<br />
# After SyncFaction is done verifying you will see a button at the bottom middle <code>Update to latest Community Patch</code>, click it & SyncFaction will automatically download and install the patch; you will see the progress tracked in the log.<br />
# When it has successfully installed the patch you will see this wiki page instead of the log along with <code>Run Game</code>, <code>Apply</code> & <code>Refresh</code> buttons, you don't need to do anything else and can close SyncFaction now.<br />
<br />
== Updating Terraform Patch ==<br />
<br />
* If you've played game nights before, get latest SF version and let it do the update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* No need to waste time verifying game with Steam!<br />
<br />
== Troubleshooting ==<br />
<br />
* Make sure you're on the latest SF version and update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* If you suspect your game is corrupted, please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game.<br />
* Sometimes after installing the required .NET version you will need to restart your computer for SF to work.<br />
* '''DON'T''' install any mods or maps on top of the patch or you'll corrupt your game!<br />
* '''DON'T''' use RSL1 for the Steam version of the game, it won't allow you into multiplayer due to cheating concerns.<br />
* If you have both the Steam & GOG versions installed, lots of drives or SF is having issues finding your game install try putting <code>SyncFaction.exe</code> with <code>rfg.exe</code> in the respective game versions folder.<br />
* If your anti virus detects <code>SyncFaction.exe</code> as malware you can be assured it's a false positive, it's open source on github and developed by a trusted member of the community. You can safely make an exception in your anti virus software.<br />
* If SyncFaction has trouble downloading the patch and shows an error starting with <code>System.Net.Http.HttpRequestException</code> it's probably being blocked by your firewall.<br />
* If your game crashes on startup it's possible you incorrectly replaced <code>sw_api.dll</code> for the Steam version when that is only needed for the GOG version, try restoring it to the Steam version: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_debug/mp_fix/steam/sw_api.dll<br />
* If you're unable to move your character, pause the game and then unpause.<br />
* If your GPU only has 1gb of VRAM try turning down all graphics settings down to minimum.<br />
* '''NUCLEAR''' option if other troubleshooting steps above fail or your game is frequently crashing: delete the entire <code>data</code> folder and verify game in Steam. If using GOG completely uninstall the game and install from scratch and then use the latest SF version to re-install the Terraform Patch.<br />
* This app release is not tested thoroughly so please be patient & report any bugs to rast1234.<br />
<br />
=== Saving Space ===<br />
<br />
* After you've updated to the current latest version of the patch it's safe to delete the <code>\data\.syncfaction\mod_xxx</code> folders.<br />
* This is because previous patch versions are cached there and not needed since last update is not incremental.<br />
<br />
=== Confirming Patch Installed Correctly === <br />
<br />
* On the first loading screen before the main menu you should see <code>Terraform Patch v1.075 ALPHA</code> at the bottom right. Example: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/misc.vpp_pc/E_TEXTURE_CHANGES/SOURCE/ui_loading_init.png?raw=true<br />
* When creating a custom match the default options should have fleetfoot selected as the starting backpack.<br />
* You should see DLC Wrecking Crew & custom maps when going through map selection such as Storage, Abandoned, Nordic Bonus, Ruins, Imperial etc.<br />
* You should see DLC Weapons when going through weapons such as the Subverter, Spiker, Misslepod etc.<br />
* You should see new characters in the multiplayer customization screen such as Jenkins, Sam, Voice of Mars etc.<br />
<br />
=== Networking Issues === <br />
<br />
* As the game relies on THQN servers and it seems NAT punching isn't always reliable some connection issues like not being able to join certain player & players not being able to join you may require manual configuration of your network to resolve.<br />
* Ensure <code>rfg.exe</code> isn't blocked by the Windows Firewall for both <code>Inbound</code> and <code>Outbound</code> connections. You can make new rules to <code>Allow the connection</code> for both <code>Inbound</code> and <code>Outbound</code> by searching for <code>Windows Defender Firewall with Advanced Security</code>. See the guide below for more advanced instructions.<br />
* Ensure all the games ports are forwarded in your routers firewall: you will need to setup a Static IP on your computer and forward the following ports in your router: <code>TCP: 80</code>, <code>UDP: 88</code>, <code>TCP/UDP: 443</code>, <code>TCP/UDP: 3074</code>, <code>UDP: 3478</code>, <code>UDP: 4379-4380</code>, <code>TCP/UDP: 23022</code>, <code>TCP/UDP: 38888</code>, <code>TCP/UDP 27000-27100</code> & <code>TCP/UDP: 61111</code>. Consult your routers manual on how to do this and see the guide below for detailed instructions on setting up a Static IP.<br />
* You can also setup DMZ for your Static IP but this is less secure. Consult your routers manual on how to do this.<br />
* It's possible your ISP is blocking ports, you can try using their app if they provide one or calling them and asking them to unblock all ports.<br />
* It's possible issues may be caused by a bad router/modem.<br />
* [https://www.howtogeek.com/19249/how-to-assign-a-static-ip-address-in-xp-vista-or-windows-7/ How to Assign a Static IP Address in Windows 10 or 11]<br />
* [https://www.howtogeek.com/112564/how-to-create-advanced-firewall-rules-in-the-windows-firewall/ How to Create Advanced Firewall Rules in the Windows Firewall]<br />
<br />
=== Configs & Save Data Corruption ===<br />
<br />
* It's unknown if this is required but it might be worth a try if you've followed all previous troubleshooting steps and you're still having issues with your game.<br />
* Delete <code>config.ini</code> in <code>%APPDATA%\kaiko\rfg\</code>. This will reset all your settings to default and you will have to reconfigure them the next time you start your game.<br />
* Steam save: <code><Steam-folder>\userdata\<user-id>\667720\remote\</code> or <code><Steam-folder>\userdata\<user-id>\667720\remote\autocloud\save</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* GOG save: <code>%LOCALAPPDATA%\GOG.com\Galaxy\Applications\51153410217180642\Storage\Shared\Files\autocloud\save\</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* Note: It's possible to transfer the Steam save to GOG or vice versa so you can try that also.<br />
<br />
=== Improving Game Stability ===<br />
<br />
# Right click <code>rfg.exe</code> in your game folder.<br />
# Select <code>Properties</code> in the context menu.<br />
# Select the <code>Compatibility</code> tab.<br />
# Tick <code>Disable fullscreen optimizations</code>.<br />
# Click <code>Change high DPI settings</code>.<br />
# Tick <code>Override high DPI scaling Behavior. Scaling performed by: Application</code>.<br />
# Click ok to both windows.<br />
# If on Windows 11 follow the below additional steps.<br />
# Open the <code>Settings</code> app.<br />
# Navigate to System > Display > Graphics > Add an app > Desktop app > Find <code>rfg.exe</code>.<br />
# Once it's added, search for rfg and click <code>Options</code>.<br />
# Tick <code>Don't use optimizations for windowed games</code>.<br />
# Make sure you select exclusive fullscreen inside the games option menu.<br />
[[File:GameStabilityFix.jpeg|frameless|512px]]<br />
<br />
=== Microstuttering Fix ===<br />
<br />
* Disable '''VSYNC''' in the games option menu.<br />
* Force '''VSYNC''' in your graphics card control panel. <br />
* Cap the framerate to your refresh rate in your graphics card control panel.<br />
* Make sure you select exclusive fullscreen inside the games option menu.<br />
<br />
== Terraform Patch Info ==<br />
<br />
* Changelog: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/changelog.txt<br />
* Known Issues: https://github.com/users/CamoRF/projects/3/views/1<br />
* Github: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch<br />
* This patch is an alpha version so you may encounter bugs, please ping Camo in the rfg-modding channel to report any issues.<br />
<br />
== Recommended Competitive Game Settings ==<br />
<br />
* Note: settings are always personal preference but this should serve as a decent starting guide if you want to play more competitively.<br />
* The default keybindings for RF:G are unusual compared to other shooters, most members in the community recommend the following settings:<br />
* All options are found under <code>Main Menu</code> --> <code>Options</code><br />
<br />
* Controls & Keybindings<br />
* Zoom: Right Click<br />
* Melee Attack: F<br />
* Melee Attack 2: Side Mouse Button if your mouse has one<br />
* Shoulder Switch: Side Mouse Button if your mouse has one<br />
* Zoom: Hold<br />
* Crouch: Toggle<br />
<br />
* Audio Options (These will allow you to hear enemy movement more clearly)<br />
* Ambience: 50%<br />
* Music: 0%<br />
* Voice: 50%<br />
* SFX: 100%<br />
<br />
* Graphics Options<br />
* FOV: 85<br />
* Depth of Field: Disabled<br />
* Motion Blur: Disabled<br />
<br />
* Game Options<br />
* Camera Shake: Disabled<br />
<br />
== Run game ==<br />
<br />
All maps are included in the Terraform Patch and you don't need to install anything else. Join the [https://discord.gg/factionfiles FactionFiles Discord] and subscribe to RF:G Game Night event!</div>Camohttps://www.redfactionwiki.com/w/index.php?title=Red_Faction_Quick_Start_Guide&diff=8975Red Faction Quick Start Guide2023-06-24T12:00:21Z<p>Camo: Changed size of image - Camo</p>
<hr />
<div>Welcome to the Red Faction Quick Start Guide!<br />
<br />
==Quick Links==<br />
*[https://discord.gg/fRrUzuV RFChat.com] - Invite link to join the '''Red Faction Community Discord''': where the community lives, and the place to ask questions, receive assistance, or find players.<br />
*[[Dash Faction Installation Guide]] - Installation guide for the '''de facto standard Red Faction client''': [[RF Clients#Dash Faction|Dash Faction]].<br />
*[[Red Faction FAQ]] - '''FAQ page''' providing answers to common questions and solutions to common issues.<br />
*[https://factionfiles.com FactionFiles.com] - FactionFiles community file host, offering thousands of '''custom maps and mods'''.<br />
*[[Red Faction Console Commands]] - Complete listing of all available '''console commands''' in Red Faction.<br />
*[[Red Faction Command Line Parameters]] - Complete listing of all available '''command line parameters''' in Red Faction.<br />
*[[RF1 Editing Main Page]] - Comprehensive community knowledgebase on custom level creation via the [[RED|Red Faction Level Editor]], and modification development.<br />
*[[Red Faction Multiplayer Guide]] - Overview of the most important aspects of RF multiplayer.<br />
*[[Red Faction Campaign]] - Overview of all the levels in the RF stock single player campaign.<br />
<br />
==Essentials==<br />
*Recommended game version/client: '''Dash Faction''' <br />
**Dash Faction is the de facto standard Red Faction client for all purposes. It resolves countless bugs with the game, fixes virtually all compatibility issues with modern computers, and adds many very useful features. Furthermore, the [[Red Faction Campaign]], as well as many custom levels and mods, simply won't function properly without Dash Faction. There is no downside to using Dash Faction, and it is '''highly''' recommended you install it if you wish to play or host servers for Red Faction. Dash Faction is open source and actively developed by rafalh. <br />
**You can read more about Dash Faction here: [[RF Client Versions#Dash Faction|Dash Faction]]<br />
**You can find instructions on how to download and install Dash Faction here: [[Dash Faction Installation Guide]]<br />
<br />
<br />
*Join the community! '''Red Faction Community Discord'''<br />
**The community is approachable, and very welcoming to both new and old school players alike. If you like Red Faction, you'll fit right in. <br />
**Join by clicking: [https://discord.gg/fRrUzuV RFChat.com]<br />
<br />
<br />
==Settings==<br />
===In-Game Settings===<br />
<gallery><br />
File:RFOptionsMain1.jpg|Click Options in the main menu to access available options<br />
File:RFOptionsGame1.jpg|Available Game options<br />
File:RFOptionsVideo1.jpg|Available Video options<br />
File:RFOptionsAudio1.jpg|Available Audio options<br />
File:RFOptionsControls1.jpg|Available Controls options<br />
</gallery><br />
<br />
*'''Game Options'''<br />
**'''Difficulty Level''' - Set difficulty for single player. Affects damage taken from enemy weapon fire, amount of ammo/health/armor obtained from pickups, and duration of countdown timers. Also configurable in-game via the '''difficulty''' [[Red Faction Console Commands#Dash Faction|console command]]. (in Dash Faction)<br />
**'''Show 1st Person Weapon''' - Toggle visibility of first person weapon models.<br />
**'''Autoswitch Weapons''' - Toggle autoswitch for non-explosive weapons (as per priority specified in Autoswitch Priority).<br />
**'''Autoswitch Explosives''' - Toggle autoswitch for explosive weapons (as per priority specified in Autoswitch Priority).<br />
**'''Autoswitch Priority''' - Priority for weapon autoswitch (if turned on, see above). When you pick up a new weapon, if autoswitch is turned on and the new weapon is higher in the priority list, switch to the new weapon. '''Move up''' and '''Move down''' move the selected weapon in the priority list.<br />
*'''Video Options'''<br />
**'''Detail Level''' - Set video options preset. Available options are Low, Medium, High, and Custom. Automatically changes to Custom if you edit any settings manually.<br />
**'''Shadows''' - Toggle visibility of circle shadows under enemy player models.<br />
**'''Decals''' - Toggle visibility of bullet and blast decals on geometry.<br />
**'''Dynamic lighting''' - Toggle visibility of dynamic lighting (ie. muzzle flashes; light emitted from projectiles; glows coming from players with [[Damage Amplifier]], [[Invulnerability]], and CTF flags)<br />
**'''Texture resolution''' - Set texture resolution. Available options are Low, Medium, and High. High renders textures at their native resolution, medium scales them down by a factor of 2, low scales them down by a factor of 4.<br />
**'''Character detail''' - Set model detail level. Despite label, this option sets detail level for all models, not just characters. Available options are Low, Medium, and High.<br />
**'''Filtering''' - Set filtering level. Available options are bilinear and trilinear. Also configurable in-game via the '''trilinear_filtering''' [[Red Faction Console Commands#Dash Faction|console command]]. (in Dash Faction)<br />
**'''Gamma/brightness''' - Sets gamma for the game window.<br />
*'''Sound Options'''<br />
**'''Sound Effects Volume''' - Set volume for any sounds that are not considered music or messages.<br />
**'''Music Volume''' - Set volume for all music tracks in game. Note that in come custom multiplayer maps, music is configured to use '''Sound Effects Volume''' instead.<br />
**'''Messages Volume''' - Set volume for HUD radio messages (from [[Eos]], [[Hendrix]], [[Capek]], etc.)<br />
*'''Controls Options'''<br />
**'''Mouse Sensitivity''' - Set sensitivity modifier for mouse input. Also configurable in-game via the '''ms''' [[Red Faction Console Commands#Dash Faction|console command]]. (in Dash Faction)<br />
**'''Mouse Y-Invert''' - Invert Y axis for mouse input.<br />
**'''Binds''' - Set available binds. Double click on a bind to set it, or select it and click '''Change Binding'''. <br />
**'''Default''' - Reset all available binds to their default settings.<br />
<br />
===Dash Faction Options===<br />
[[File:Dash Settings Presets.png|right|thumb|1000px|Dash Faction options presets. Game executable, Adapter & Resolution have been blanked out, since those three fields will be different for each player.]]<br />
*Access the '''Dash Faction''' Options panel by clicking the "Options" button in the Dash Faction Launcher before launching the game.<br />
*Common presets are displayed to the right. The individual options are explained below, but feel free to just replicate either the Best Graphics or Best Performance presets to the right.<br />
**'''Game executable''' - Path to your Red Faction game executable. This is normally configured during Dash Faction installation, and you should only need to change it if you've moved your Red Faction installation directory. You can change it by clicking ''Browse...''<br />
**'''Graphics'''<br />
***'''Resolution''' - Set the resolution of the game client. Presets are available by clicking the dropdown arrow, but you can also manually type in a custom resolution if you wish. (ie. 3840x2160 for 4k displays) Dash Faction will automatically adjust the HUD for whichever resolution you pick. It's generally recommended to set this to match your desktop resolution.<br />
***'''Color Depth''' - Color depth of the game. In virtually all cases, you should set this to 32 bits. 16 bits causes issues on some systems, and Dash Faction will not let you set it to 16 bits if it is expected to cause issues on your system.<br />
***'''Adapter''' - Select your graphics adapter. It's unlikely you'll ever need to adjust this option.<br />
***'''Window Mode''' - Select ''Full Screen'', ''Windowed'', or ''Stretched'' (no border windowed). It's generally recommended to keep this at Full Screen for best performance, but windowed and stretched are also fully functional if you'd rather play in one of those modes.<br />
***'''Rendering Cache''' - Recommended to set to 32MB.<br />
***'''Anti-Aliasing''' - Smooths out sharp edges at the cost of performance. For best performance, keep this off. For better graphical quality, turn it on. '''NOTE:''' Older Dash Faction versions experienced severe framerate drops while recording the game via OBS after enabling this option. Those issues should be fully resolved as of Dash Faction 1.6.1.<br />
***'''FPS Limit''' - Set the maximum framerate you wish your game to run at. Usually best to keep at 240, but configurable between 10 - 240. Also configurable in-game via the '''maxfps''' [[Red Faction Console Commands#Dash Faction|console command]].<br />
***'''Vsync''' - Wait for vertical sync. Reduces tearing, but caps your framerate at your monitor refresh rate (ie. 60Hz, 144Hz, etc.) and may cause input lag. Unless tearing is noticeable and unbearable for you, it's recommended to keep this off.<br />
***'''Fast animations''' - Performance option that skips rendering every second frame in animations, making them appear more "choppy". The performance improvement on most modern systems is negligible, but technically having this option on is a performance improvement. If you have a slower system, you may notice a significant performance improvement by turning this option on.<br />
***'''High model details''' - Expands the distance required for model level of detail (LOD) transitions by a factor of 10. Once enabled, this can be controlled in-game via the '''lod_distance_scale''' [[Red Faction Console Commands#Dash Faction|console command]]. '''NOTE:''' As of Dash Faction 1.6.1, this option replaces the previous "Disable LOD models" option, which fully disabled LOD transitions for meshes, meaning models were always displayed at the maximum detail level regardless of distance.<br />
***'''Anisotropic Filtering''' - Turns on Anisotropic Filtering in the game. This is a complex concept, so rather than describe it here, I'll direct you to [https://en.wikipedia.org/wiki/Anisotropic_filtering Wikipedia's article on it] if you wish to read about how it works. For Red Faction, just know that it improves graphical quality at the cost of potential performance impact.<br />
***'''High Scanner Resolution''' - Increases the resolution of the [[Rail Driver]] thermal scanner, so thermal signatures of players and vehicles look nicer.<br />
***'''High Monitor Resolution''' - Increases the resolution of camera images displayed on security monitors (single player only). <br />
***'''True Color Textures''' - If ticked, textures render with proper native color depth. Default behaviour (unticked) is classic RF behaviour - all textures are converted to 16 bit when rendered in-game.<br />
***'''Big HUD''' - Render larger HUD elements. Highly recommended when running the game at high resolutions (ie. anything above 1024x768). Also configurable in-game via the '''bighud''' [[Red Faction Console Commands#Dash Faction|console command]].<br />
**'''Multiplayer'''<br />
***'''Multiplayer Tracker''' - Tracker to query for a server list when going to the multiplayer "Join Game" screen for clients. For servers, this sets the tracker your server will be listed on. Defaults to ''rfgt.factionfiles.com'', which is the default community multiplayer tracker. Recommended to keep at this value, and hitting the '''Reset''' button will reset it to this.<br />
***'''Force Port''' - If checkbox is ticked and port number is specified, run the server or game client on the specified UDP port. If unticked, game client will run at a randomized high port, and dedicated server will run on UDP port 7755 (unless specified via [[Red Faction Command Line Parameters#Dash Faction|command line]] when launching the server).<br />
***'''Rate''' - Maximum transfer rate for network communication (in bits per second). Highly recommended to set this to a very high value (eg. 200000)<br />
**'''Miscellaneous'''<br />
***'''Use DirectInput''' - Use DirectInput for mouse input, rather than classic RF input. Improves accuracy of mouse input. You can read more about DirectInput on [https://en.wikipedia.org/wiki/DirectInput Wikipedia].<br />
***'''EAX Sound''' - Enables DirectSound3D in all cases, and enables EAX sound effects where present in levels. You can read more about EAX on [https://en.wikipedia.org/wiki/Environmental_Audio_Extensions Wikipedia].<br />
***'''Keep launcher open''' - Tick this box to keep the Dash Faction launcher open after launching the game. Default behaviour (unticked) is to close the launcher when launching the game.<br />
***'''Allow overriding game files by packages in user_maps''' - Allows you to replace default game assets (ie. sounds, models, textures, etc.) with customized assets. In a case where an asset file contained within a [[.vpp]] packfile in ''user_maps/multi'' or ''user_maps/single'' has the same filename as a core game asset file, if this box is ticked, the game will prefer the file from ''user_maps''. Note that you ''cannot'' use this functionality to load customized [[.tbl]] files - those must be modified via [[Mod#Conversion_Mods|conversion mods]]. This option is required to be on for [[Mod#Client-Side_Mods|clientside mods]] to function. Default behaviour (unticked) is to not allow such mods. You can read more about how to use clientside mods in the guide: [[Installing Clientside Mods (RF1)]]<br />
***'''Run game at reduced speed when window doesn't have focus''' - Tick this box to run the game at a drastically reduced framerate when minimized or out of focus. Improves system performance while the game is running in the background.<br />
***'''Game language''' - Choose game interface/subtitle language from stock supported languages. Available options are English, French, German, and Auto. Auto selects the game language automatically based on the presence of game files specific to certain regions.<br />
***'''Fast Start''' - Always skip playing THQ/Volition logo animations when launching the game.<br />
***'''FPS counter''' - Display framerate counter in the top right hand corner of the screen.<br />
***'''Linear pitch''' - Tick this box to enable linear pitch camera movement. Default behaviour (unticked) applies RF classic acceleration to camera pitch. Without linear pitch enabled, mouse sensitivity is reduced gradually when aiming up and down.<br />
***'''Scoreboard animations''' - Tick this box to enable animations when the multiplayer scoreboard is shown/hidden ("Multiplayer Stats" control, default bind is TAB).<br />
***'''Level Sounds''' - Default behaviour (ticked) plays sound effects in maps. Untick this option to disable map sound effects (like ambient sounds, etc.). The in-game '''levelsounds''' [[Red Faction Console Commands#Dash Faction|console command]] allows percentile volume configuration of level sounds, rather than simply the true/false choice available in the Options panel.<br />
<br />
<br />
[[Category:Red Faction]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=Red_Faction_Quick_Start_Guide&diff=8974Red Faction Quick Start Guide2023-06-24T11:56:30Z<p>Camo: Updated Dash Faction setting presets with latest launcher - Camo</p>
<hr />
<div>Welcome to the Red Faction Quick Start Guide!<br />
<br />
==Quick Links==<br />
*[https://discord.gg/fRrUzuV RFChat.com] - Invite link to join the '''Red Faction Community Discord''': where the community lives, and the place to ask questions, receive assistance, or find players.<br />
*[[Dash Faction Installation Guide]] - Installation guide for the '''de facto standard Red Faction client''': [[RF Clients#Dash Faction|Dash Faction]].<br />
*[[Red Faction FAQ]] - '''FAQ page''' providing answers to common questions and solutions to common issues.<br />
*[https://factionfiles.com FactionFiles.com] - FactionFiles community file host, offering thousands of '''custom maps and mods'''.<br />
*[[Red Faction Console Commands]] - Complete listing of all available '''console commands''' in Red Faction.<br />
*[[Red Faction Command Line Parameters]] - Complete listing of all available '''command line parameters''' in Red Faction.<br />
*[[RF1 Editing Main Page]] - Comprehensive community knowledgebase on custom level creation via the [[RED|Red Faction Level Editor]], and modification development.<br />
*[[Red Faction Multiplayer Guide]] - Overview of the most important aspects of RF multiplayer.<br />
*[[Red Faction Campaign]] - Overview of all the levels in the RF stock single player campaign.<br />
<br />
==Essentials==<br />
*Recommended game version/client: '''Dash Faction''' <br />
**Dash Faction is the de facto standard Red Faction client for all purposes. It resolves countless bugs with the game, fixes virtually all compatibility issues with modern computers, and adds many very useful features. Furthermore, the [[Red Faction Campaign]], as well as many custom levels and mods, simply won't function properly without Dash Faction. There is no downside to using Dash Faction, and it is '''highly''' recommended you install it if you wish to play or host servers for Red Faction. Dash Faction is open source and actively developed by rafalh. <br />
**You can read more about Dash Faction here: [[RF Client Versions#Dash Faction|Dash Faction]]<br />
**You can find instructions on how to download and install Dash Faction here: [[Dash Faction Installation Guide]]<br />
<br />
<br />
*Join the community! '''Red Faction Community Discord'''<br />
**The community is approachable, and very welcoming to both new and old school players alike. If you like Red Faction, you'll fit right in. <br />
**Join by clicking: [https://discord.gg/fRrUzuV RFChat.com]<br />
<br />
<br />
==Settings==<br />
===In-Game Settings===<br />
<gallery><br />
File:RFOptionsMain1.jpg|Click Options in the main menu to access available options<br />
File:RFOptionsGame1.jpg|Available Game options<br />
File:RFOptionsVideo1.jpg|Available Video options<br />
File:RFOptionsAudio1.jpg|Available Audio options<br />
File:RFOptionsControls1.jpg|Available Controls options<br />
</gallery><br />
<br />
*'''Game Options'''<br />
**'''Difficulty Level''' - Set difficulty for single player. Affects damage taken from enemy weapon fire, amount of ammo/health/armor obtained from pickups, and duration of countdown timers. Also configurable in-game via the '''difficulty''' [[Red Faction Console Commands#Dash Faction|console command]]. (in Dash Faction)<br />
**'''Show 1st Person Weapon''' - Toggle visibility of first person weapon models.<br />
**'''Autoswitch Weapons''' - Toggle autoswitch for non-explosive weapons (as per priority specified in Autoswitch Priority).<br />
**'''Autoswitch Explosives''' - Toggle autoswitch for explosive weapons (as per priority specified in Autoswitch Priority).<br />
**'''Autoswitch Priority''' - Priority for weapon autoswitch (if turned on, see above). When you pick up a new weapon, if autoswitch is turned on and the new weapon is higher in the priority list, switch to the new weapon. '''Move up''' and '''Move down''' move the selected weapon in the priority list.<br />
*'''Video Options'''<br />
**'''Detail Level''' - Set video options preset. Available options are Low, Medium, High, and Custom. Automatically changes to Custom if you edit any settings manually.<br />
**'''Shadows''' - Toggle visibility of circle shadows under enemy player models.<br />
**'''Decals''' - Toggle visibility of bullet and blast decals on geometry.<br />
**'''Dynamic lighting''' - Toggle visibility of dynamic lighting (ie. muzzle flashes; light emitted from projectiles; glows coming from players with [[Damage Amplifier]], [[Invulnerability]], and CTF flags)<br />
**'''Texture resolution''' - Set texture resolution. Available options are Low, Medium, and High. High renders textures at their native resolution, medium scales them down by a factor of 2, low scales them down by a factor of 4.<br />
**'''Character detail''' - Set model detail level. Despite label, this option sets detail level for all models, not just characters. Available options are Low, Medium, and High.<br />
**'''Filtering''' - Set filtering level. Available options are bilinear and trilinear. Also configurable in-game via the '''trilinear_filtering''' [[Red Faction Console Commands#Dash Faction|console command]]. (in Dash Faction)<br />
**'''Gamma/brightness''' - Sets gamma for the game window.<br />
*'''Sound Options'''<br />
**'''Sound Effects Volume''' - Set volume for any sounds that are not considered music or messages.<br />
**'''Music Volume''' - Set volume for all music tracks in game. Note that in come custom multiplayer maps, music is configured to use '''Sound Effects Volume''' instead.<br />
**'''Messages Volume''' - Set volume for HUD radio messages (from [[Eos]], [[Hendrix]], [[Capek]], etc.)<br />
*'''Controls Options'''<br />
**'''Mouse Sensitivity''' - Set sensitivity modifier for mouse input. Also configurable in-game via the '''ms''' [[Red Faction Console Commands#Dash Faction|console command]]. (in Dash Faction)<br />
**'''Mouse Y-Invert''' - Invert Y axis for mouse input.<br />
**'''Binds''' - Set available binds. Double click on a bind to set it, or select it and click '''Change Binding'''. <br />
**'''Default''' - Reset all available binds to their default settings.<br />
<br />
===Dash Faction Options===<br />
[[File:Dash Settings Presets.png|right|thumb|550px|Dash Faction options presets. Game executable, Adapter & Resolution have been blanked out, since those three fields will be different for each player.]]<br />
*Access the '''Dash Faction''' Options panel by clicking the "Options" button in the Dash Faction Launcher before launching the game.<br />
*Common presets are displayed to the right. The individual options are explained below, but feel free to just replicate either the Best Graphics or Best Performance presets to the right.<br />
**'''Game executable''' - Path to your Red Faction game executable. This is normally configured during Dash Faction installation, and you should only need to change it if you've moved your Red Faction installation directory. You can change it by clicking ''Browse...''<br />
**'''Graphics'''<br />
***'''Resolution''' - Set the resolution of the game client. Presets are available by clicking the dropdown arrow, but you can also manually type in a custom resolution if you wish. (ie. 3840x2160 for 4k displays) Dash Faction will automatically adjust the HUD for whichever resolution you pick. It's generally recommended to set this to match your desktop resolution.<br />
***'''Color Depth''' - Color depth of the game. In virtually all cases, you should set this to 32 bits. 16 bits causes issues on some systems, and Dash Faction will not let you set it to 16 bits if it is expected to cause issues on your system.<br />
***'''Adapter''' - Select your graphics adapter. It's unlikely you'll ever need to adjust this option.<br />
***'''Window Mode''' - Select ''Full Screen'', ''Windowed'', or ''Stretched'' (no border windowed). It's generally recommended to keep this at Full Screen for best performance, but windowed and stretched are also fully functional if you'd rather play in one of those modes.<br />
***'''Rendering Cache''' - Recommended to set to 32MB.<br />
***'''Anti-Aliasing''' - Smooths out sharp edges at the cost of performance. For best performance, keep this off. For better graphical quality, turn it on. '''NOTE:''' Older Dash Faction versions experienced severe framerate drops while recording the game via OBS after enabling this option. Those issues should be fully resolved as of Dash Faction 1.6.1.<br />
***'''FPS Limit''' - Set the maximum framerate you wish your game to run at. Usually best to keep at 240, but configurable between 10 - 240. Also configurable in-game via the '''maxfps''' [[Red Faction Console Commands#Dash Faction|console command]].<br />
***'''Vsync''' - Wait for vertical sync. Reduces tearing, but caps your framerate at your monitor refresh rate (ie. 60Hz, 144Hz, etc.) and may cause input lag. Unless tearing is noticeable and unbearable for you, it's recommended to keep this off.<br />
***'''Fast animations''' - Performance option that skips rendering every second frame in animations, making them appear more "choppy". The performance improvement on most modern systems is negligible, but technically having this option on is a performance improvement. If you have a slower system, you may notice a significant performance improvement by turning this option on.<br />
***'''High model details''' - Expands the distance required for model level of detail (LOD) transitions by a factor of 10. Once enabled, this can be controlled in-game via the '''lod_distance_scale''' [[Red Faction Console Commands#Dash Faction|console command]]. '''NOTE:''' As of Dash Faction 1.6.1, this option replaces the previous "Disable LOD models" option, which fully disabled LOD transitions for meshes, meaning models were always displayed at the maximum detail level regardless of distance.<br />
***'''Anisotropic Filtering''' - Turns on Anisotropic Filtering in the game. This is a complex concept, so rather than describe it here, I'll direct you to [https://en.wikipedia.org/wiki/Anisotropic_filtering Wikipedia's article on it] if you wish to read about how it works. For Red Faction, just know that it improves graphical quality at the cost of potential performance impact.<br />
***'''High Scanner Resolution''' - Increases the resolution of the [[Rail Driver]] thermal scanner, so thermal signatures of players and vehicles look nicer.<br />
***'''High Monitor Resolution''' - Increases the resolution of camera images displayed on security monitors (single player only). <br />
***'''True Color Textures''' - If ticked, textures render with proper native color depth. Default behaviour (unticked) is classic RF behaviour - all textures are converted to 16 bit when rendered in-game.<br />
***'''Big HUD''' - Render larger HUD elements. Highly recommended when running the game at high resolutions (ie. anything above 1024x768). Also configurable in-game via the '''bighud''' [[Red Faction Console Commands#Dash Faction|console command]].<br />
**'''Multiplayer'''<br />
***'''Multiplayer Tracker''' - Tracker to query for a server list when going to the multiplayer "Join Game" screen for clients. For servers, this sets the tracker your server will be listed on. Defaults to ''rfgt.factionfiles.com'', which is the default community multiplayer tracker. Recommended to keep at this value, and hitting the '''Reset''' button will reset it to this.<br />
***'''Force Port''' - If checkbox is ticked and port number is specified, run the server or game client on the specified UDP port. If unticked, game client will run at a randomized high port, and dedicated server will run on UDP port 7755 (unless specified via [[Red Faction Command Line Parameters#Dash Faction|command line]] when launching the server).<br />
***'''Rate''' - Maximum transfer rate for network communication (in bits per second). Highly recommended to set this to a very high value (eg. 200000)<br />
**'''Miscellaneous'''<br />
***'''Use DirectInput''' - Use DirectInput for mouse input, rather than classic RF input. Improves accuracy of mouse input. You can read more about DirectInput on [https://en.wikipedia.org/wiki/DirectInput Wikipedia].<br />
***'''EAX Sound''' - Enables DirectSound3D in all cases, and enables EAX sound effects where present in levels. You can read more about EAX on [https://en.wikipedia.org/wiki/Environmental_Audio_Extensions Wikipedia].<br />
***'''Keep launcher open''' - Tick this box to keep the Dash Faction launcher open after launching the game. Default behaviour (unticked) is to close the launcher when launching the game.<br />
***'''Allow overriding game files by packages in user_maps''' - Allows you to replace default game assets (ie. sounds, models, textures, etc.) with customized assets. In a case where an asset file contained within a [[.vpp]] packfile in ''user_maps/multi'' or ''user_maps/single'' has the same filename as a core game asset file, if this box is ticked, the game will prefer the file from ''user_maps''. Note that you ''cannot'' use this functionality to load customized [[.tbl]] files - those must be modified via [[Mod#Conversion_Mods|conversion mods]]. This option is required to be on for [[Mod#Client-Side_Mods|clientside mods]] to function. Default behaviour (unticked) is to not allow such mods. You can read more about how to use clientside mods in the guide: [[Installing Clientside Mods (RF1)]]<br />
***'''Run game at reduced speed when window doesn't have focus''' - Tick this box to run the game at a drastically reduced framerate when minimized or out of focus. Improves system performance while the game is running in the background.<br />
***'''Game language''' - Choose game interface/subtitle language from stock supported languages. Available options are English, French, German, and Auto. Auto selects the game language automatically based on the presence of game files specific to certain regions.<br />
***'''Fast Start''' - Always skip playing THQ/Volition logo animations when launching the game.<br />
***'''FPS counter''' - Display framerate counter in the top right hand corner of the screen.<br />
***'''Linear pitch''' - Tick this box to enable linear pitch camera movement. Default behaviour (unticked) applies RF classic acceleration to camera pitch. Without linear pitch enabled, mouse sensitivity is reduced gradually when aiming up and down.<br />
***'''Scoreboard animations''' - Tick this box to enable animations when the multiplayer scoreboard is shown/hidden ("Multiplayer Stats" control, default bind is TAB).<br />
***'''Level Sounds''' - Default behaviour (ticked) plays sound effects in maps. Untick this option to disable map sound effects (like ambient sounds, etc.). The in-game '''levelsounds''' [[Red Faction Console Commands#Dash Faction|console command]] allows percentile volume configuration of level sounds, rather than simply the true/false choice available in the Options panel.<br />
<br />
<br />
[[Category:Red Faction]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=File:Dash_Settings_Presets.png&diff=8973File:Dash Settings Presets.png2023-06-24T11:55:16Z<p>Camo: </p>
<hr />
<div></div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Editing_Main_Page&diff=8972RF:G Editing Main Page2023-06-24T04:30:31Z<p>Camo: /* Misc Notes */</p>
<hr />
<div>{{RFGEditing}}<br />
{{Under construction}}<br />
<br />
This will serve as a landing page for all resources related to [[Red Faction: Guerrilla]] editing for the '''Re-Mars-tered Edition'''.<br />
<br />
==External Links==<br />
===Community===<br />
*[https://discord.gg/factionfiles Faction Files Community Discord] - Active Red Faction series community Discord with #map-mod-development channel for community development discussion<br />
===Downloads===<br />
*[https://www.factionfiles.com/ff.php?action=files FactionFiles.com] - Custom mods, tools, patches, and reference material<br />
*[https://www.nexusmods.com/redfactionguerilla/mods/ Nexus Mods] - Custom mods<br />
*[https://www.nexusmods.com/redfactionguerrillaremarstered/mods/ Nexus Mods Re-Mars-tered] - Custom mods<br />
<br />
==Documentation==<br />
*[[RF:G Map organization]]<br />
*[[Nanoforge basics]]<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail<br />
===Core Concepts===<br />
*[[Red Faction: Guerrilla]]'s level editor is [[CLOE]], which is not publicly available.<br />
<br />
===Red Faction: Guerrilla File Formats===<br />
* <code>.xtbl</code> - XML table files are used to store properties or attributes in Red Faction: Guerrilla. Overall, their function is similar to the <code>.tbl</code> files of Red Faction and Red Faction II.<br />
* <code>.scriptx</code> - Internal script engine file, commonly used for missions and activities<br />
* <code>.dtodx</code> - Weather/lighting file for maps that controls things like fog, tint, ambient colour, eye adaption, bloom, cloud color and speed<br />
* <code>.gtodx</code> - Skybox file for maps that controls things like the sun texture, moon positions and if the horizon mountain texture is enabled<br />
* <code>.vpp_pc</code> - Packfile<br />
* <code>.rigx</code> - Rig<br />
* <code>.str2_pc</code> - Texture Packfile<br />
* <code>.rfgzone_pc</code> - Map zone<br />
* <code>.layer_pc</code> - Map zone<br />
* <code>.cpeg_pc, cvbm_pc</code> - Texture cpu file<br />
* <code>.gpeg_pc, gvbm_pc</code> - Texture gpu file<br />
* <code>.asm_pc</code> - Streaming index<br />
* <code>.csmesh_pc</code> - Static mesh cpu file<br />
* <code>.gsmesh_pc</code> - Static mesh gpu file<br />
* <code>.ccmesh_pc</code> - Character mesh cpu file<br />
* <code>.gcmesh_pc</code> - Character mesh gpu file<br />
* <code>.ccar_pc</code> - Vehicle mesh cpu file<br />
* <code>.gcar_pc</code> - Vehicle mesh gpu file<br />
* <code>.anim_pc</code> - Animation<br />
* <code>.cchk_pc</code> - Destructible object cpu file<br />
* <code>.gchk_pc</code> - Destructible object gpu file<br />
* <code>.cefct_pc</code> - Visual effect cpu file<br />
* <code>.gefct_pc</code> - Visual effect gpu file<br />
* <code>.cfmesh_pc</code> - Foliage mesh<br />
* <code>.cstch</code> - Terrain clutter mesh cpu file<br />
* <code>.gstch</code> - Terrain clutter mesh gpu file<br />
* <code>.cterrain_pc</code> - Terrain zone cpu file<br />
* <code>.gterrain_pc</code> - Terrain zone gpu file<br />
* <code>.ctmesh_pc</code> - Terrain subzone cpu file<br />
* <code>.gtmesh_pc</code> - Terrain subzone gpu file<br />
* <code>.fsmib</code> - Fullscreen map data<br />
* <code>.fxo_kg</code> - Shader<br />
* <code>.le_strings</code> - Steam localization strings<br />
* <code>.rfglocatext</code> - Localization strings<br />
* <code>.mat_pc</code> - Render material<br />
* <code>.morph_pc</code> - Animation Morph<br />
* <code>.vint_doc</code> - UI<br />
* <code>.sim_pc</code> - Cloth sim<br />
* <code>.xgs_pc</code> - Sound config<br />
* <code>.xsb_pc</code> - Soundbank<br />
* <code>.xwb_pc</code> - Wavebank<br />
* <code>.aud_pc</code> - Audio categories<br />
* <code>.vf3_pc</code> - Font<br />
* <code>.vfdvp_pc</code> - ?<br />
* <code>.rfgvp_pc</code> - ?<br />
<br />
===Red Faction: Guerrilla File Structure===<br />
<br />
\Red Faction Guerrilla Re-MARS-tered\data\<br />
<br />
The two most important files for modding most of RF:G are <code>misc.vpp_pc</code> & <code>table.vpp_pc</code><br />
<br />
* <code>activities.vpp_pc</code> - contains textures for singleplayer activities<br />
* <code>anims.vpp_pc</code> - contains animation files<br />
* <code>chunks.vpp_pc</code> - contains <code>.rfgchunkx</code> files and seems to be related to the <code>preload_chunks.xtbl</code> file, it's possible to add them to a map using the correct <code>dest_checksum</code> & <code>uid</code> numbers. Game might also spawn <code>missing_chunk</code> or <code>missing_destroyable</code> if a mesh fails to load.<br />
* <code>cloth_sim.vpp_pc</code> - contains cloth simulation files<br />
* <code>decals.vpp_pc</code> - contains decal textures<br />
* <code>dlc01_l0.vpp_pc</code> - singleplayer DLC map<br />
* <code>dlc01_l1.vpp_pc</code> - only contains a blank <code>asm_pc</code> file<br />
* <code>dlc01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer DLC map<br />
* <code>dlcp01_activities.vpp_pc</code> - contains textures for singleplayer DLC activities<br />
* <code>dlcp01_anims.vpp_pc</code> - contains animation files for singleplayer DLC<br />
* <code>dlcp01_cloth_sim.vpp_pc</code> - contains cloth simulation files for singleplayer DLC<br />
* <code>dlcp01_effects.vpp_pc</code> - contains visual effect files for singleplayer DLC, some are <code>.str2</code><br />
* <code>dlcp01_humans.vpp_pc</code> - contains textures and meshes for characters in singleplayer DLC<br />
* <code>dlcp01_interface.vpp_pc</code> - contains textures for loading screens & thumbnails in singleplayer DLC<br />
* <code>dlcp01_items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in singleplayer DLC<br />
* <code>dlc01_misc.vpp_pc</code> - contains <code>.rig_pc</code> files, the <code>.fsmib</code> file and two <code>.xtbl</code> files for singleplayer DLC<br />
* <code>dlc01_missions.vpp_pc</code> - contains textures related to singleplayer DLC missions<br />
* <code>dlcp01_personas_en_us.vpp_pc</code> - <br />
* <code>dlcp01_vehicles.vpp_pc</code> - contains textures and meshes for singleplayer DLC vehicles<br />
* <code>dlcp01_voices_en_us.vpp_pc</code> -<br />
* <code>dlcp02_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for multiplayer DLC<br />
* <code>dlcp02_misc.vpp_pc</code> - <br />
* <code>dlcp03_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for wrecking crew DLC<br />
* <code>dlcp03_misc.vpp_pc</code> -<br />
* <code>effects.vpp_pc</code> - contains visual effect files, some are <code>.str2</code><br />
* <code>effects_mp.vpp_pc</code> - contains multiplayer only visual effect files, some are <code>.str2</code><br />
* <code>humans.vpp_pc</code> - contains textures and meshes for characters in both singleplayer and multiplayer<br />
* <code>interface.vpp_pc</code> - contains textures for loading screens & thumbnails in both SP and MP and character portraits in multiplayer<br />
* <code>items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in both singleplayer & multiplayer<br />
* <code>items_mp.vpp_pc</code> - contains multiplayer only textures and meshes<br />
* <code>misc.vpp_pc</code> contains <code>.xtbl</code> files and most other file types<br />
* <code>missions.vpp_pc</code> - contains textures for singleplayer missions<br />
* <code>mp_common.vpp_pc</code> - contains textures shared between multiplayer maps<br />
* <code>mp_xxx.vpp_pc</code> - multiplayer maps, excluding <code>mp_common.vpp_pc</code><br />
* <code>mpdlc_xxx.vpp_pc</code> - DLC multiplayer maps<br />
* <code>personas_de_de.vpp_pc</code> -<br />
* <code>personas_en_us.vpp_pc</code> - <br />
* <code>personas_es_es.vpp_pc</code> - <br />
* <code>personas_fr_fr.vpp_pc</code> -<br />
* <code>personas_it_it.vpp_pc</code> -<br />
* <code>personas_ru_ru.vpp_pc</code> -<br />
* <code>rfg_cine_00a.bik_xbox2</code> -<br />
* <code>rfg_cine_01a.bik_xbox2</code> -<br />
* <code>rfg_cine_02a.bik_xbox2</code> -<br />
* <code>rfg_cine_03a.bik_xbox2</code> - <br />
* <code>rfg_cine_03b.bik_xbox2</code> - <br />
* <code>rfg_cine_04a.bik_xbox2</code> - <br />
* <code>rfg_cine_05a.bik_xbox2</code> - <br />
* <code>rfg_cine_06a.bik_xbox2</code> - <br />
* <code>skybox.vpp_pc</code> - contains textures for the skybox like the clouds<br />
* <code>sounds_r.vpp_pc</code> - contains <code>.xmb_pc</code> sound files<br />
* <code>steam.vpp_pc</code> -<br />
* <code>table.vpp_pc</code> - contains only <code>.xtbl</code> files and will overwrite <code>.xtbl</code> files in <code>misc.vpp_pc</code><br />
* <code>terr01_l0.vpp_pc</code> - singleplayer map<br />
* <code>terr01_l1.vpp_pc</code> - singleplayer map<br />
* <code>terr01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer map<br />
* <code>vehicles_r.vpp_pc</code> - contains textures and meshes for singleplayer vehicles<br />
* <code>voices_de_de.vpp_pc</code> - <br />
* <code>voices_en_us.vpp_pc</code> - <br />
* <code>voices_es_es.vpp_pc</code> - <br />
* <code>voices_fr_fr.vpp_pc</code> - <br />
* <code>voices_it_it.vpp_pc</code> - <br />
* <code>voices_ru_ru.vpp_pc</code> -<br />
* <code>wcxxx.vpp_c</code> - wrecking crew maps<br />
* <code>zonescript_dlc01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer DLC map<br />
* <code>zonescript_terr01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer map<br />
* <code>xxx.bik</code> - pre-rendered custscenes<br />
<br />
===Scriptx Functions===<br />
<br />
* [https://www.factionfiles.com/ff.php?action=scriptxfuncs .scriptx functions]<br />
<br />
===Primitive data types & limits===<br />
<br />
* Floats (floating decimal points): Max value <code>3.4028237</code> and move the decimal place right 38 times. Examples: <code>1.0, 0.0</code><br />
* Integer (whole number that could hold a zero, positive or negative value): Max value <code>2147483647</code><br />
* Boolean (truth value with two constants objects True and False , basically a toggle to enable or disable something using "true" or "false"): Examples: <code><Unlocks_Cheat>True</Unlocks_Cheat>, <Unlocks_Cheat>False</Unlocks_Cheat></code><br />
* String (represents a sequence or characters/text): Example: <code><string>OldCoot</string></code><br />
<br />
===sounds_r.vpp_pc Info===<br />
<br />
* S16 = Signed 16 bit<br />
* LE = Little endian<br />
* 2CH = 2 channels (stereo)<br />
<br />
* destruction.xwb_pc - unknown<br />
* dlc01_voc_d01offcam.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01dan.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm02.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm03.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm04.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm05.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm06.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01rfc.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01sam_pcm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01vasha_safe.xwb_pc.en_us.xwb_pc - unknown <br />
* mov_foley.xwb_pc - unknown <br />
* mov_jet_pack.xwb_pc - unknown <br />
* mov_male.xwb_pc - unknown <br />
* mov_npc_male.xwb_pc - unknown <br />
* mp_backpacks.xwb_pc - S16, LE, 2CH. Intermittent static starting ~28sec <br />
* mp_wep.xwb_pc - S16, LE, 2CH. Static at start and end <br />
* mus_briefings.xwb_pc - S16, LE, 2CH. <br />
* mus_demomaster.xwb_pc - S16, LE, 2CH. <br />
* mus_frontend.xwb_pc - S16, LE, 2CH. <br />
* mus_multiplayer.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_01.xwb_pc - S16, LE, 2CH. Static at start, may be header <br />
* mus_progression_02.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_03.xwb_pc - S16, LE, 2CH. <br />
* mus_sting.xwb_pc - S16, LE, 2CH. <br />
* obj_shared_ambient.xwb_pc - unknown<br />
* obj_shared_dth.xwb_pc - unknown <br />
* obj_shared_exp.xwb_pc - unknown<br />
* obj_shared_impact.xwb_pc - unknown <br />
* scripted_raids.xwb_pc - unknown <br />
* system.xwb_pc - S16, LE, 2CH. Mostly static, valid sound in middle <br />
* system_mp.xwb_pc - unknown <br />
* veh_civ_bus.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car1.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car2.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car3.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_flat.xwb_pc - unknown <br />
* veh_civ_flat2.xwb_pc - unknown<br />
* veh_civ_fuel.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_hauler.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_taxi.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_trash.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_walker.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_aax.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_abx.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_apc.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_atank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_htank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_mtank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_scout.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staff.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staffh2h.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_raider.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_atv.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_bull.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_dtruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_etruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_pickup.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_rover.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_roverwk.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supplyrt.xwb_pc - unknown<br />
* veh_min_wlklg.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_wlkmd.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_shared.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* walla.xwb_pc - unknown<br />
* weather.xwb_pc - S16, LE, 2CH.<br />
* wep_rfg.xwb_pc - S16, LE, 2CH. Mostly valid, some static<br />
<br />
===RfgUtil Guide===<br />
<br />
* Unpacking [Placeholder]<br />
* Repacking [Placeholder]<br />
* Command arguments [Placeholder]<br />
* Scripts [Placeholder]<br />
* Updating <code>.asm_pc</code> files [Placeholder]<br />
<br />
===Misc Notes===<br />
<br />
* When repacking <code>.vpp_pc</code> files don't compress and/or condense them if they weren't like that in the vanilla game, it will cause the game to crash. Eg: <code>items.vpp_pc</code>, <code>interface.vpp_pc</code>, map files etc. See the table below.<br />
* When repacking <code>.str2_pc</code> files ensure they are compressed and condensed.<br />
* <code>table.vpp_pc</code> overwrites changes to <code>.xtbl</code> files in <code>misc.vpp_pc</code>. The work around for this with the legacy mod manager is to rename the file however this breaks multiplayer and reduces the stability of the game. You should edit the same <code>.xtbl</code> files in both <code>misc.vpp_pc</code> & <code>table.vpp_pc</code>.<br />
<br />
{| class="wikitable"<br />
|+<br />
|-<br />
! Filename !! Alignment !! Compressed !! Condensed<br />
|-<br />
| ALL .str2 || 0 || Yes || Yes<br />
|-<br />
| MOST .vpp_pc || 2048 || No || No<br />
|-<br />
| dlc01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlcp01_misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| mp_common.vpp_pc || 2048 || Yes || No<br />
|-<br />
| steam.vpp_pc || 2048 || Yes || No<br />
|-<br />
| terr01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_dlc01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_terr01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlc01_l1.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp01_voices_en_us.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp02_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| dlcp03_misc.vpp_pc || 0? || Yes || No<br />
|-<br />
| dlcp01_anims.vpp_pc || 16? || Yes || Yes<br />
|-<br />
| anims.vpp_pc || 16 || Yes || Yes<br />
|-<br />
| table.vpp_pc || 64 || Yes || Yes<br />
|-<br />
| skybox.vpp_pc || 4096 || No || No<br />
|-<br />
| dlcp01_personas_en_us.vpp_pc || 4096 || No || No<br />
<br />
|}<br />
<br />
===Red Faction: Guerrilla Tools===<br />
<br />
* [https://github.com/Moneyl/RfgUtil/releases RfgUtil] - Used for unpacking most file formats and updating <code>.asm_pc</code> files<br />
* [https://github.com/Moneyl/Nanoforge/releases Nanoforge C++] - Map editor, texture editor, <code>.xtbl</code> editor and more<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/mTools.zip mTools] - Drag and drop tool to convert <code>.asm_pc</code> files to XML and vice versa<br />
* [https://github.com/rsl-dev/RSL/releases RSL] - Script Loader<br />
* [https://github.com/Moneyl/AsmTool AsmTool]- WIP Tool for modifying <code>.asm_pc</code> files used by Red Faction Guerrilla. This is meant to replace hand editing them, which is very error prone and tedious<br />
* [https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe SyncFaction] - WIP tool for automatically installing the Terraform Patch and eventually replacing the old mod manager<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5686 xdelta UI] - GUI for generating <code>.xdelta</code> (binary) patches<br />
* [http://www.ximple.cz/download.php XiMpLe XML Editor] - Lightweight GUI XML Editor that displays XML type files in a table grid views and shows what other <code>.xtbls</code> it is referencing. Very useful for understanding and editing <code>.xtbl</code> files.<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/Volition_Table_File_Editor.zip Volition Table File Editor] - GUI for editing <code>.xtbl</code> files<br />
* [https://jsonformatter.org/xml-formatter XML Formatter] - Use this to format <code>.xtbl</code> files so they are easier to read<br />
* [https://www.w3schools.com/xml/xml_validator.asp XML Validator] - Use this to validate <code>.xtbl</code> edits, any mistakes you make will crash the game<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5995 Mod Manager Re-mars-tered v1.03] - Legacy mod manager<br />
* [https://onecompiler.com/lua/3ykpyrhhb LUA Validator] - Useful for validating RSL scripts for errors, note it's safe to ignore <code>attempt to index a nil value (global 'rfg')</code><br />
<br />
===Useful Software===<br />
<br />
* [https://www.voidtools.com/ Voidtools Everything] - Locate files and folders by name instantly<br />
* [https://www.mythicsoft.com/agentransack/ Agent Ransack] - Bulk search for keywords within unpacked files<br />
* [https://notepad-plus-plus.org/downloads/ Notepad++] - Good text editor for manually editing <code>.xtbl</code> files, set language as XML<br />
<br />
==Tutorials==<br />
*[[Nanoforge xtbl editing]] - How to edit [[.xtbl]] files in Nanoforge.<br />
*[[Nanoforge Texture Editing]] - How to edit textures using Nanoforge.<br />
* XTBL Editing Guides [Placeholder]<br />
<br />
<br />
[[Category: Red Faction: Guerrilla]]<br />
[[Category: RF:G Editing]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Editing_Main_Page&diff=8971RF:G Editing Main Page2023-06-24T04:17:00Z<p>Camo: /* Misc Notes */</p>
<hr />
<div>{{RFGEditing}}<br />
{{Under construction}}<br />
<br />
This will serve as a landing page for all resources related to [[Red Faction: Guerrilla]] editing for the '''Re-Mars-tered Edition'''.<br />
<br />
==External Links==<br />
===Community===<br />
*[https://discord.gg/factionfiles Faction Files Community Discord] - Active Red Faction series community Discord with #map-mod-development channel for community development discussion<br />
===Downloads===<br />
*[https://www.factionfiles.com/ff.php?action=files FactionFiles.com] - Custom mods, tools, patches, and reference material<br />
*[https://www.nexusmods.com/redfactionguerilla/mods/ Nexus Mods] - Custom mods<br />
*[https://www.nexusmods.com/redfactionguerrillaremarstered/mods/ Nexus Mods Re-Mars-tered] - Custom mods<br />
<br />
==Documentation==<br />
*[[RF:G Map organization]]<br />
*[[Nanoforge basics]]<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail<br />
===Core Concepts===<br />
*[[Red Faction: Guerrilla]]'s level editor is [[CLOE]], which is not publicly available.<br />
<br />
===Red Faction: Guerrilla File Formats===<br />
* <code>.xtbl</code> - XML table files are used to store properties or attributes in Red Faction: Guerrilla. Overall, their function is similar to the <code>.tbl</code> files of Red Faction and Red Faction II.<br />
* <code>.scriptx</code> - Internal script engine file, commonly used for missions and activities<br />
* <code>.dtodx</code> - Weather/lighting file for maps that controls things like fog, tint, ambient colour, eye adaption, bloom, cloud color and speed<br />
* <code>.gtodx</code> - Skybox file for maps that controls things like the sun texture, moon positions and if the horizon mountain texture is enabled<br />
* <code>.vpp_pc</code> - Packfile<br />
* <code>.rigx</code> - Rig<br />
* <code>.str2_pc</code> - Texture Packfile<br />
* <code>.rfgzone_pc</code> - Map zone<br />
* <code>.layer_pc</code> - Map zone<br />
* <code>.cpeg_pc, cvbm_pc</code> - Texture cpu file<br />
* <code>.gpeg_pc, gvbm_pc</code> - Texture gpu file<br />
* <code>.asm_pc</code> - Streaming index<br />
* <code>.csmesh_pc</code> - Static mesh cpu file<br />
* <code>.gsmesh_pc</code> - Static mesh gpu file<br />
* <code>.ccmesh_pc</code> - Character mesh cpu file<br />
* <code>.gcmesh_pc</code> - Character mesh gpu file<br />
* <code>.ccar_pc</code> - Vehicle mesh cpu file<br />
* <code>.gcar_pc</code> - Vehicle mesh gpu file<br />
* <code>.anim_pc</code> - Animation<br />
* <code>.cchk_pc</code> - Destructible object cpu file<br />
* <code>.gchk_pc</code> - Destructible object gpu file<br />
* <code>.cefct_pc</code> - Visual effect cpu file<br />
* <code>.gefct_pc</code> - Visual effect gpu file<br />
* <code>.cfmesh_pc</code> - Foliage mesh<br />
* <code>.cstch</code> - Terrain clutter mesh cpu file<br />
* <code>.gstch</code> - Terrain clutter mesh gpu file<br />
* <code>.cterrain_pc</code> - Terrain zone cpu file<br />
* <code>.gterrain_pc</code> - Terrain zone gpu file<br />
* <code>.ctmesh_pc</code> - Terrain subzone cpu file<br />
* <code>.gtmesh_pc</code> - Terrain subzone gpu file<br />
* <code>.fsmib</code> - Fullscreen map data<br />
* <code>.fxo_kg</code> - Shader<br />
* <code>.le_strings</code> - Steam localization strings<br />
* <code>.rfglocatext</code> - Localization strings<br />
* <code>.mat_pc</code> - Render material<br />
* <code>.morph_pc</code> - Animation Morph<br />
* <code>.vint_doc</code> - UI<br />
* <code>.sim_pc</code> - Cloth sim<br />
* <code>.xgs_pc</code> - Sound config<br />
* <code>.xsb_pc</code> - Soundbank<br />
* <code>.xwb_pc</code> - Wavebank<br />
* <code>.aud_pc</code> - Audio categories<br />
* <code>.vf3_pc</code> - Font<br />
* <code>.vfdvp_pc</code> - ?<br />
* <code>.rfgvp_pc</code> - ?<br />
<br />
===Red Faction: Guerrilla File Structure===<br />
<br />
\Red Faction Guerrilla Re-MARS-tered\data\<br />
<br />
The two most important files for modding most of RF:G are <code>misc.vpp_pc</code> & <code>table.vpp_pc</code><br />
<br />
* <code>activities.vpp_pc</code> - contains textures for singleplayer activities<br />
* <code>anims.vpp_pc</code> - contains animation files<br />
* <code>chunks.vpp_pc</code> - contains <code>.rfgchunkx</code> files and seems to be related to the <code>preload_chunks.xtbl</code> file, it's possible to add them to a map using the correct <code>dest_checksum</code> & <code>uid</code> numbers. Game might also spawn <code>missing_chunk</code> or <code>missing_destroyable</code> if a mesh fails to load.<br />
* <code>cloth_sim.vpp_pc</code> - contains cloth simulation files<br />
* <code>decals.vpp_pc</code> - contains decal textures<br />
* <code>dlc01_l0.vpp_pc</code> - singleplayer DLC map<br />
* <code>dlc01_l1.vpp_pc</code> - only contains a blank <code>asm_pc</code> file<br />
* <code>dlc01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer DLC map<br />
* <code>dlcp01_activities.vpp_pc</code> - contains textures for singleplayer DLC activities<br />
* <code>dlcp01_anims.vpp_pc</code> - contains animation files for singleplayer DLC<br />
* <code>dlcp01_cloth_sim.vpp_pc</code> - contains cloth simulation files for singleplayer DLC<br />
* <code>dlcp01_effects.vpp_pc</code> - contains visual effect files for singleplayer DLC, some are <code>.str2</code><br />
* <code>dlcp01_humans.vpp_pc</code> - contains textures and meshes for characters in singleplayer DLC<br />
* <code>dlcp01_interface.vpp_pc</code> - contains textures for loading screens & thumbnails in singleplayer DLC<br />
* <code>dlcp01_items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in singleplayer DLC<br />
* <code>dlc01_misc.vpp_pc</code> - contains <code>.rig_pc</code> files, the <code>.fsmib</code> file and two <code>.xtbl</code> files for singleplayer DLC<br />
* <code>dlc01_missions.vpp_pc</code> - contains textures related to singleplayer DLC missions<br />
* <code>dlcp01_personas_en_us.vpp_pc</code> - <br />
* <code>dlcp01_vehicles.vpp_pc</code> - contains textures and meshes for singleplayer DLC vehicles<br />
* <code>dlcp01_voices_en_us.vpp_pc</code> -<br />
* <code>dlcp02_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for multiplayer DLC<br />
* <code>dlcp02_misc.vpp_pc</code> - <br />
* <code>dlcp03_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for wrecking crew DLC<br />
* <code>dlcp03_misc.vpp_pc</code> -<br />
* <code>effects.vpp_pc</code> - contains visual effect files, some are <code>.str2</code><br />
* <code>effects_mp.vpp_pc</code> - contains multiplayer only visual effect files, some are <code>.str2</code><br />
* <code>humans.vpp_pc</code> - contains textures and meshes for characters in both singleplayer and multiplayer<br />
* <code>interface.vpp_pc</code> - contains textures for loading screens & thumbnails in both SP and MP and character portraits in multiplayer<br />
* <code>items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in both singleplayer & multiplayer<br />
* <code>items_mp.vpp_pc</code> - contains multiplayer only textures and meshes<br />
* <code>misc.vpp_pc</code> contains <code>.xtbl</code> files and most other file types<br />
* <code>missions.vpp_pc</code> - contains textures for singleplayer missions<br />
* <code>mp_common.vpp_pc</code> - contains textures shared between multiplayer maps<br />
* <code>mp_xxx.vpp_pc</code> - multiplayer maps, excluding <code>mp_common.vpp_pc</code><br />
* <code>mpdlc_xxx.vpp_pc</code> - DLC multiplayer maps<br />
* <code>personas_de_de.vpp_pc</code> -<br />
* <code>personas_en_us.vpp_pc</code> - <br />
* <code>personas_es_es.vpp_pc</code> - <br />
* <code>personas_fr_fr.vpp_pc</code> -<br />
* <code>personas_it_it.vpp_pc</code> -<br />
* <code>personas_ru_ru.vpp_pc</code> -<br />
* <code>rfg_cine_00a.bik_xbox2</code> -<br />
* <code>rfg_cine_01a.bik_xbox2</code> -<br />
* <code>rfg_cine_02a.bik_xbox2</code> -<br />
* <code>rfg_cine_03a.bik_xbox2</code> - <br />
* <code>rfg_cine_03b.bik_xbox2</code> - <br />
* <code>rfg_cine_04a.bik_xbox2</code> - <br />
* <code>rfg_cine_05a.bik_xbox2</code> - <br />
* <code>rfg_cine_06a.bik_xbox2</code> - <br />
* <code>skybox.vpp_pc</code> - contains textures for the skybox like the clouds<br />
* <code>sounds_r.vpp_pc</code> - contains <code>.xmb_pc</code> sound files<br />
* <code>steam.vpp_pc</code> -<br />
* <code>table.vpp_pc</code> - contains only <code>.xtbl</code> files and will overwrite <code>.xtbl</code> files in <code>misc.vpp_pc</code><br />
* <code>terr01_l0.vpp_pc</code> - singleplayer map<br />
* <code>terr01_l1.vpp_pc</code> - singleplayer map<br />
* <code>terr01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer map<br />
* <code>vehicles_r.vpp_pc</code> - contains textures and meshes for singleplayer vehicles<br />
* <code>voices_de_de.vpp_pc</code> - <br />
* <code>voices_en_us.vpp_pc</code> - <br />
* <code>voices_es_es.vpp_pc</code> - <br />
* <code>voices_fr_fr.vpp_pc</code> - <br />
* <code>voices_it_it.vpp_pc</code> - <br />
* <code>voices_ru_ru.vpp_pc</code> -<br />
* <code>wcxxx.vpp_c</code> - wrecking crew maps<br />
* <code>zonescript_dlc01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer DLC map<br />
* <code>zonescript_terr01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer map<br />
* <code>xxx.bik</code> - pre-rendered custscenes<br />
<br />
===Scriptx Functions===<br />
<br />
* [https://www.factionfiles.com/ff.php?action=scriptxfuncs .scriptx functions]<br />
<br />
===Primitive data types & limits===<br />
<br />
* Floats (floating decimal points): Max value <code>3.4028237</code> and move the decimal place right 38 times. Examples: <code>1.0, 0.0</code><br />
* Integer (whole number that could hold a zero, positive or negative value): Max value <code>2147483647</code><br />
* Boolean (truth value with two constants objects True and False , basically a toggle to enable or disable something using "true" or "false"): Examples: <code><Unlocks_Cheat>True</Unlocks_Cheat>, <Unlocks_Cheat>False</Unlocks_Cheat></code><br />
* String (represents a sequence or characters/text): Example: <code><string>OldCoot</string></code><br />
<br />
===sounds_r.vpp_pc Info===<br />
<br />
* S16 = Signed 16 bit<br />
* LE = Little endian<br />
* 2CH = 2 channels (stereo)<br />
<br />
* destruction.xwb_pc - unknown<br />
* dlc01_voc_d01offcam.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01dan.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm02.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm03.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm04.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm05.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm06.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01rfc.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01sam_pcm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01vasha_safe.xwb_pc.en_us.xwb_pc - unknown <br />
* mov_foley.xwb_pc - unknown <br />
* mov_jet_pack.xwb_pc - unknown <br />
* mov_male.xwb_pc - unknown <br />
* mov_npc_male.xwb_pc - unknown <br />
* mp_backpacks.xwb_pc - S16, LE, 2CH. Intermittent static starting ~28sec <br />
* mp_wep.xwb_pc - S16, LE, 2CH. Static at start and end <br />
* mus_briefings.xwb_pc - S16, LE, 2CH. <br />
* mus_demomaster.xwb_pc - S16, LE, 2CH. <br />
* mus_frontend.xwb_pc - S16, LE, 2CH. <br />
* mus_multiplayer.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_01.xwb_pc - S16, LE, 2CH. Static at start, may be header <br />
* mus_progression_02.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_03.xwb_pc - S16, LE, 2CH. <br />
* mus_sting.xwb_pc - S16, LE, 2CH. <br />
* obj_shared_ambient.xwb_pc - unknown<br />
* obj_shared_dth.xwb_pc - unknown <br />
* obj_shared_exp.xwb_pc - unknown<br />
* obj_shared_impact.xwb_pc - unknown <br />
* scripted_raids.xwb_pc - unknown <br />
* system.xwb_pc - S16, LE, 2CH. Mostly static, valid sound in middle <br />
* system_mp.xwb_pc - unknown <br />
* veh_civ_bus.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car1.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car2.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car3.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_flat.xwb_pc - unknown <br />
* veh_civ_flat2.xwb_pc - unknown<br />
* veh_civ_fuel.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_hauler.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_taxi.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_trash.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_walker.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_aax.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_abx.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_apc.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_atank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_htank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_mtank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_scout.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staff.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staffh2h.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_raider.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_atv.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_bull.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_dtruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_etruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_pickup.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_rover.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_roverwk.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supplyrt.xwb_pc - unknown<br />
* veh_min_wlklg.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_wlkmd.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_shared.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* walla.xwb_pc - unknown<br />
* weather.xwb_pc - S16, LE, 2CH.<br />
* wep_rfg.xwb_pc - S16, LE, 2CH. Mostly valid, some static<br />
<br />
===RfgUtil Guide===<br />
<br />
* Unpacking [Placeholder]<br />
* Repacking [Placeholder]<br />
* Command arguments [Placeholder]<br />
* Scripts [Placeholder]<br />
* Updating <code>.asm_pc</code> files [Placeholder]<br />
<br />
===Misc Notes===<br />
<br />
* When repacking <code>.vpp_pc</code> files don't compress and/or condense them if they weren't like that in the vanilla game, it will cause the game to crash. Eg: <code>items.vpp_pc</code>, <code>interface.vpp_pc</code>, map files etc. See the table below.<br />
* When repacking <code>.str2_pc</code> files ensure they are compressed and condensed.<br />
* <code>table.vpp_pc</code> overwrites changes to <code>.xtbl</code> files in <code>misc.vpp_pc</code>. The work around for this with the legacy mod manager is to rename the file however this breaks multiplayer and reduces the stability of the game. You should edit the same <code>.xtbl</code> files in both <code>misc.vpp_pc</code> & <code>table.vpp_pc</code>.<br />
<br />
{| class="wikitable"<br />
|+<br />
|-<br />
! Filename !! Alignment !! Compressed !! Condensed<br />
|-<br />
| ALL .str2 || 0 || Yes || Yes<br />
|-<br />
| MOST .vpp_pc || 2048 || No || No<br />
|-<br />
| dlc01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlcp01_misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| mp_common.vpp_pc || 2048 || Yes || No<br />
|-<br />
| steam.vpp_pc || 2048 || Yes || No<br />
|-<br />
| terr01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_dlc01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_terr01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlc01_l1.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp01_voices_en_us.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp02_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| dlcp01_anims.vpp_pc || 16? || Yes || Yes<br />
|-<br />
| anims.vpp_pc || 16 || Yes || Yes<br />
|-<br />
| anims.vpp_pc || 16 || Yes || Yes<br />
|-<br />
| table.vpp_pc || 64 || Yes || Yes<br />
|-<br />
| skybox.vpp_pc || 4096 || No || No<br />
|-<br />
| dlcp01_personas_en_us.vpp_pc || 4096 || No || No<br />
<br />
|}<br />
<br />
===Red Faction: Guerrilla Tools===<br />
<br />
* [https://github.com/Moneyl/RfgUtil/releases RfgUtil] - Used for unpacking most file formats and updating <code>.asm_pc</code> files<br />
* [https://github.com/Moneyl/Nanoforge/releases Nanoforge C++] - Map editor, texture editor, <code>.xtbl</code> editor and more<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/mTools.zip mTools] - Drag and drop tool to convert <code>.asm_pc</code> files to XML and vice versa<br />
* [https://github.com/rsl-dev/RSL/releases RSL] - Script Loader<br />
* [https://github.com/Moneyl/AsmTool AsmTool]- WIP Tool for modifying <code>.asm_pc</code> files used by Red Faction Guerrilla. This is meant to replace hand editing them, which is very error prone and tedious<br />
* [https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe SyncFaction] - WIP tool for automatically installing the Terraform Patch and eventually replacing the old mod manager<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5686 xdelta UI] - GUI for generating <code>.xdelta</code> (binary) patches<br />
* [http://www.ximple.cz/download.php XiMpLe XML Editor] - Lightweight GUI XML Editor that displays XML type files in a table grid views and shows what other <code>.xtbls</code> it is referencing. Very useful for understanding and editing <code>.xtbl</code> files.<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/Volition_Table_File_Editor.zip Volition Table File Editor] - GUI for editing <code>.xtbl</code> files<br />
* [https://jsonformatter.org/xml-formatter XML Formatter] - Use this to format <code>.xtbl</code> files so they are easier to read<br />
* [https://www.w3schools.com/xml/xml_validator.asp XML Validator] - Use this to validate <code>.xtbl</code> edits, any mistakes you make will crash the game<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5995 Mod Manager Re-mars-tered v1.03] - Legacy mod manager<br />
* [https://onecompiler.com/lua/3ykpyrhhb LUA Validator] - Useful for validating RSL scripts for errors, note it's safe to ignore <code>attempt to index a nil value (global 'rfg')</code><br />
<br />
===Useful Software===<br />
<br />
* [https://www.voidtools.com/ Voidtools Everything] - Locate files and folders by name instantly<br />
* [https://www.mythicsoft.com/agentransack/ Agent Ransack] - Bulk search for keywords within unpacked files<br />
* [https://notepad-plus-plus.org/downloads/ Notepad++] - Good text editor for manually editing <code>.xtbl</code> files, set language as XML<br />
<br />
==Tutorials==<br />
*[[Nanoforge xtbl editing]] - How to edit [[.xtbl]] files in Nanoforge.<br />
*[[Nanoforge Texture Editing]] - How to edit textures using Nanoforge.<br />
* XTBL Editing Guides [Placeholder]<br />
<br />
<br />
[[Category: Red Faction: Guerrilla]]<br />
[[Category: RF:G Editing]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Editing_Main_Page&diff=8970RF:G Editing Main Page2023-06-24T02:52:51Z<p>Camo: /* Misc Notes */</p>
<hr />
<div>{{RFGEditing}}<br />
{{Under construction}}<br />
<br />
This will serve as a landing page for all resources related to [[Red Faction: Guerrilla]] editing for the '''Re-Mars-tered Edition'''.<br />
<br />
==External Links==<br />
===Community===<br />
*[https://discord.gg/factionfiles Faction Files Community Discord] - Active Red Faction series community Discord with #map-mod-development channel for community development discussion<br />
===Downloads===<br />
*[https://www.factionfiles.com/ff.php?action=files FactionFiles.com] - Custom mods, tools, patches, and reference material<br />
*[https://www.nexusmods.com/redfactionguerilla/mods/ Nexus Mods] - Custom mods<br />
*[https://www.nexusmods.com/redfactionguerrillaremarstered/mods/ Nexus Mods Re-Mars-tered] - Custom mods<br />
<br />
==Documentation==<br />
*[[RF:G Map organization]]<br />
*[[Nanoforge basics]]<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail<br />
===Core Concepts===<br />
*[[Red Faction: Guerrilla]]'s level editor is [[CLOE]], which is not publicly available.<br />
<br />
===Red Faction: Guerrilla File Formats===<br />
* <code>.xtbl</code> - XML table files are used to store properties or attributes in Red Faction: Guerrilla. Overall, their function is similar to the <code>.tbl</code> files of Red Faction and Red Faction II.<br />
* <code>.scriptx</code> - Internal script engine file, commonly used for missions and activities<br />
* <code>.dtodx</code> - Weather/lighting file for maps that controls things like fog, tint, ambient colour, eye adaption, bloom, cloud color and speed<br />
* <code>.gtodx</code> - Skybox file for maps that controls things like the sun texture, moon positions and if the horizon mountain texture is enabled<br />
* <code>.vpp_pc</code> - Packfile<br />
* <code>.rigx</code> - Rig<br />
* <code>.str2_pc</code> - Texture Packfile<br />
* <code>.rfgzone_pc</code> - Map zone<br />
* <code>.layer_pc</code> - Map zone<br />
* <code>.cpeg_pc, cvbm_pc</code> - Texture cpu file<br />
* <code>.gpeg_pc, gvbm_pc</code> - Texture gpu file<br />
* <code>.asm_pc</code> - Streaming index<br />
* <code>.csmesh_pc</code> - Static mesh cpu file<br />
* <code>.gsmesh_pc</code> - Static mesh gpu file<br />
* <code>.ccmesh_pc</code> - Character mesh cpu file<br />
* <code>.gcmesh_pc</code> - Character mesh gpu file<br />
* <code>.ccar_pc</code> - Vehicle mesh cpu file<br />
* <code>.gcar_pc</code> - Vehicle mesh gpu file<br />
* <code>.anim_pc</code> - Animation<br />
* <code>.cchk_pc</code> - Destructible object cpu file<br />
* <code>.gchk_pc</code> - Destructible object gpu file<br />
* <code>.cefct_pc</code> - Visual effect cpu file<br />
* <code>.gefct_pc</code> - Visual effect gpu file<br />
* <code>.cfmesh_pc</code> - Foliage mesh<br />
* <code>.cstch</code> - Terrain clutter mesh cpu file<br />
* <code>.gstch</code> - Terrain clutter mesh gpu file<br />
* <code>.cterrain_pc</code> - Terrain zone cpu file<br />
* <code>.gterrain_pc</code> - Terrain zone gpu file<br />
* <code>.ctmesh_pc</code> - Terrain subzone cpu file<br />
* <code>.gtmesh_pc</code> - Terrain subzone gpu file<br />
* <code>.fsmib</code> - Fullscreen map data<br />
* <code>.fxo_kg</code> - Shader<br />
* <code>.le_strings</code> - Steam localization strings<br />
* <code>.rfglocatext</code> - Localization strings<br />
* <code>.mat_pc</code> - Render material<br />
* <code>.morph_pc</code> - Animation Morph<br />
* <code>.vint_doc</code> - UI<br />
* <code>.sim_pc</code> - Cloth sim<br />
* <code>.xgs_pc</code> - Sound config<br />
* <code>.xsb_pc</code> - Soundbank<br />
* <code>.xwb_pc</code> - Wavebank<br />
* <code>.aud_pc</code> - Audio categories<br />
* <code>.vf3_pc</code> - Font<br />
* <code>.vfdvp_pc</code> - ?<br />
* <code>.rfgvp_pc</code> - ?<br />
<br />
===Red Faction: Guerrilla File Structure===<br />
<br />
\Red Faction Guerrilla Re-MARS-tered\data\<br />
<br />
The two most important files for modding most of RF:G are <code>misc.vpp_pc</code> & <code>table.vpp_pc</code><br />
<br />
* <code>activities.vpp_pc</code> - contains textures for singleplayer activities<br />
* <code>anims.vpp_pc</code> - contains animation files<br />
* <code>chunks.vpp_pc</code> - contains <code>.rfgchunkx</code> files and seems to be related to the <code>preload_chunks.xtbl</code> file, it's possible to add them to a map using the correct <code>dest_checksum</code> & <code>uid</code> numbers. Game might also spawn <code>missing_chunk</code> or <code>missing_destroyable</code> if a mesh fails to load.<br />
* <code>cloth_sim.vpp_pc</code> - contains cloth simulation files<br />
* <code>decals.vpp_pc</code> - contains decal textures<br />
* <code>dlc01_l0.vpp_pc</code> - singleplayer DLC map<br />
* <code>dlc01_l1.vpp_pc</code> - only contains a blank <code>asm_pc</code> file<br />
* <code>dlc01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer DLC map<br />
* <code>dlcp01_activities.vpp_pc</code> - contains textures for singleplayer DLC activities<br />
* <code>dlcp01_anims.vpp_pc</code> - contains animation files for singleplayer DLC<br />
* <code>dlcp01_cloth_sim.vpp_pc</code> - contains cloth simulation files for singleplayer DLC<br />
* <code>dlcp01_effects.vpp_pc</code> - contains visual effect files for singleplayer DLC, some are <code>.str2</code><br />
* <code>dlcp01_humans.vpp_pc</code> - contains textures and meshes for characters in singleplayer DLC<br />
* <code>dlcp01_interface.vpp_pc</code> - contains textures for loading screens & thumbnails in singleplayer DLC<br />
* <code>dlcp01_items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in singleplayer DLC<br />
* <code>dlc01_misc.vpp_pc</code> - contains <code>.rig_pc</code> files, the <code>.fsmib</code> file and two <code>.xtbl</code> files for singleplayer DLC<br />
* <code>dlc01_missions.vpp_pc</code> - contains textures related to singleplayer DLC missions<br />
* <code>dlcp01_personas_en_us.vpp_pc</code> - <br />
* <code>dlcp01_vehicles.vpp_pc</code> - contains textures and meshes for singleplayer DLC vehicles<br />
* <code>dlcp01_voices_en_us.vpp_pc</code> -<br />
* <code>dlcp02_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for multiplayer DLC<br />
* <code>dlcp02_misc.vpp_pc</code> - <br />
* <code>dlcp03_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for wrecking crew DLC<br />
* <code>dlcp03_misc.vpp_pc</code> -<br />
* <code>effects.vpp_pc</code> - contains visual effect files, some are <code>.str2</code><br />
* <code>effects_mp.vpp_pc</code> - contains multiplayer only visual effect files, some are <code>.str2</code><br />
* <code>humans.vpp_pc</code> - contains textures and meshes for characters in both singleplayer and multiplayer<br />
* <code>interface.vpp_pc</code> - contains textures for loading screens & thumbnails in both SP and MP and character portraits in multiplayer<br />
* <code>items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in both singleplayer & multiplayer<br />
* <code>items_mp.vpp_pc</code> - contains multiplayer only textures and meshes<br />
* <code>misc.vpp_pc</code> contains <code>.xtbl</code> files and most other file types<br />
* <code>missions.vpp_pc</code> - contains textures for singleplayer missions<br />
* <code>mp_common.vpp_pc</code> - contains textures shared between multiplayer maps<br />
* <code>mp_xxx.vpp_pc</code> - multiplayer maps, excluding <code>mp_common.vpp_pc</code><br />
* <code>mpdlc_xxx.vpp_pc</code> - DLC multiplayer maps<br />
* <code>personas_de_de.vpp_pc</code> -<br />
* <code>personas_en_us.vpp_pc</code> - <br />
* <code>personas_es_es.vpp_pc</code> - <br />
* <code>personas_fr_fr.vpp_pc</code> -<br />
* <code>personas_it_it.vpp_pc</code> -<br />
* <code>personas_ru_ru.vpp_pc</code> -<br />
* <code>rfg_cine_00a.bik_xbox2</code> -<br />
* <code>rfg_cine_01a.bik_xbox2</code> -<br />
* <code>rfg_cine_02a.bik_xbox2</code> -<br />
* <code>rfg_cine_03a.bik_xbox2</code> - <br />
* <code>rfg_cine_03b.bik_xbox2</code> - <br />
* <code>rfg_cine_04a.bik_xbox2</code> - <br />
* <code>rfg_cine_05a.bik_xbox2</code> - <br />
* <code>rfg_cine_06a.bik_xbox2</code> - <br />
* <code>skybox.vpp_pc</code> - contains textures for the skybox like the clouds<br />
* <code>sounds_r.vpp_pc</code> - contains <code>.xmb_pc</code> sound files<br />
* <code>steam.vpp_pc</code> -<br />
* <code>table.vpp_pc</code> - contains only <code>.xtbl</code> files and will overwrite <code>.xtbl</code> files in <code>misc.vpp_pc</code><br />
* <code>terr01_l0.vpp_pc</code> - singleplayer map<br />
* <code>terr01_l1.vpp_pc</code> - singleplayer map<br />
* <code>terr01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer map<br />
* <code>vehicles_r.vpp_pc</code> - contains textures and meshes for singleplayer vehicles<br />
* <code>voices_de_de.vpp_pc</code> - <br />
* <code>voices_en_us.vpp_pc</code> - <br />
* <code>voices_es_es.vpp_pc</code> - <br />
* <code>voices_fr_fr.vpp_pc</code> - <br />
* <code>voices_it_it.vpp_pc</code> - <br />
* <code>voices_ru_ru.vpp_pc</code> -<br />
* <code>wcxxx.vpp_c</code> - wrecking crew maps<br />
* <code>zonescript_dlc01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer DLC map<br />
* <code>zonescript_terr01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer map<br />
* <code>xxx.bik</code> - pre-rendered custscenes<br />
<br />
===Scriptx Functions===<br />
<br />
* [https://www.factionfiles.com/ff.php?action=scriptxfuncs .scriptx functions]<br />
<br />
===Primitive data types & limits===<br />
<br />
* Floats (floating decimal points): Max value <code>3.4028237</code> and move the decimal place right 38 times. Examples: <code>1.0, 0.0</code><br />
* Integer (whole number that could hold a zero, positive or negative value): Max value <code>2147483647</code><br />
* Boolean (truth value with two constants objects True and False , basically a toggle to enable or disable something using "true" or "false"): Examples: <code><Unlocks_Cheat>True</Unlocks_Cheat>, <Unlocks_Cheat>False</Unlocks_Cheat></code><br />
* String (represents a sequence or characters/text): Example: <code><string>OldCoot</string></code><br />
<br />
===sounds_r.vpp_pc Info===<br />
<br />
* S16 = Signed 16 bit<br />
* LE = Little endian<br />
* 2CH = 2 channels (stereo)<br />
<br />
* destruction.xwb_pc - unknown<br />
* dlc01_voc_d01offcam.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01dan.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm02.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm03.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm04.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm05.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm06.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01rfc.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01sam_pcm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01vasha_safe.xwb_pc.en_us.xwb_pc - unknown <br />
* mov_foley.xwb_pc - unknown <br />
* mov_jet_pack.xwb_pc - unknown <br />
* mov_male.xwb_pc - unknown <br />
* mov_npc_male.xwb_pc - unknown <br />
* mp_backpacks.xwb_pc - S16, LE, 2CH. Intermittent static starting ~28sec <br />
* mp_wep.xwb_pc - S16, LE, 2CH. Static at start and end <br />
* mus_briefings.xwb_pc - S16, LE, 2CH. <br />
* mus_demomaster.xwb_pc - S16, LE, 2CH. <br />
* mus_frontend.xwb_pc - S16, LE, 2CH. <br />
* mus_multiplayer.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_01.xwb_pc - S16, LE, 2CH. Static at start, may be header <br />
* mus_progression_02.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_03.xwb_pc - S16, LE, 2CH. <br />
* mus_sting.xwb_pc - S16, LE, 2CH. <br />
* obj_shared_ambient.xwb_pc - unknown<br />
* obj_shared_dth.xwb_pc - unknown <br />
* obj_shared_exp.xwb_pc - unknown<br />
* obj_shared_impact.xwb_pc - unknown <br />
* scripted_raids.xwb_pc - unknown <br />
* system.xwb_pc - S16, LE, 2CH. Mostly static, valid sound in middle <br />
* system_mp.xwb_pc - unknown <br />
* veh_civ_bus.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car1.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car2.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car3.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_flat.xwb_pc - unknown <br />
* veh_civ_flat2.xwb_pc - unknown<br />
* veh_civ_fuel.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_hauler.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_taxi.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_trash.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_walker.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_aax.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_abx.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_apc.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_atank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_htank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_mtank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_scout.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staff.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staffh2h.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_raider.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_atv.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_bull.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_dtruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_etruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_pickup.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_rover.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_roverwk.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supplyrt.xwb_pc - unknown<br />
* veh_min_wlklg.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_wlkmd.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_shared.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* walla.xwb_pc - unknown<br />
* weather.xwb_pc - S16, LE, 2CH.<br />
* wep_rfg.xwb_pc - S16, LE, 2CH. Mostly valid, some static<br />
<br />
===RfgUtil Guide===<br />
<br />
* Unpacking [Placeholder]<br />
* Repacking [Placeholder]<br />
* Command arguments [Placeholder]<br />
* Scripts [Placeholder]<br />
* Updating <code>.asm_pc</code> files [Placeholder]<br />
<br />
===Misc Notes===<br />
<br />
* When repacking <code>.vpp_pc</code> files don't compress and/or condense them if they weren't like that in the vanilla game, it will cause the game to crash. Eg: <code>items.vpp_pc</code>, <code>interface.vpp_pc</code>, map files etc. See the table below.<br />
* When repacking <code>.str2_pc</code> files ensure they are compressed and condensed.<br />
* <code>table.vpp_pc</code> overwrites changes to <code>.xtbl</code> files in <code>misc.vpp_pc</code>. The work around for this with the legacy mod manager is to rename the file however this breaks multiplayer and reduces the stability of the game. You should edit the same <code>.xtbl</code> files in both <code>misc.vpp_pc</code> & <code>table.vpp_pc</code>.<br />
<br />
{| class="wikitable"<br />
|+<br />
|-<br />
! Filename !! Alignment !! Compressed !! Condensed<br />
|-<br />
| ALL .str2 || 0 || Yes || Yes<br />
|-<br />
| MOST .vpp_pc || 2048 || No || No<br />
|-<br />
| dlc01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlcp01_misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| mp_common.vpp_pc || 2048 || Yes || No<br />
|-<br />
| steam.vpp_pc || 2048 || Yes || No<br />
|-<br />
| terr01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_dlc01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_terr01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlc01_l1.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp01_voices_en_us.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp02_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| dlcp03_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| anims.vpp_pc || 16 || Yes || Yes<br />
|-<br />
| table.vpp_pc || 64 || Yes || Yes<br />
|-<br />
| skybox.vpp_pc || 4096 || No || No<br />
|-<br />
| dlcp01_personas_en_us.vpp_pc || 4096 || No || No<br />
<br />
|}<br />
<br />
===Red Faction: Guerrilla Tools===<br />
<br />
* [https://github.com/Moneyl/RfgUtil/releases RfgUtil] - Used for unpacking most file formats and updating <code>.asm_pc</code> files<br />
* [https://github.com/Moneyl/Nanoforge/releases Nanoforge C++] - Map editor, texture editor, <code>.xtbl</code> editor and more<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/mTools.zip mTools] - Drag and drop tool to convert <code>.asm_pc</code> files to XML and vice versa<br />
* [https://github.com/rsl-dev/RSL/releases RSL] - Script Loader<br />
* [https://github.com/Moneyl/AsmTool AsmTool]- WIP Tool for modifying <code>.asm_pc</code> files used by Red Faction Guerrilla. This is meant to replace hand editing them, which is very error prone and tedious<br />
* [https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe SyncFaction] - WIP tool for automatically installing the Terraform Patch and eventually replacing the old mod manager<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5686 xdelta UI] - GUI for generating <code>.xdelta</code> (binary) patches<br />
* [http://www.ximple.cz/download.php XiMpLe XML Editor] - Lightweight GUI XML Editor that displays XML type files in a table grid views and shows what other <code>.xtbls</code> it is referencing. Very useful for understanding and editing <code>.xtbl</code> files.<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/Volition_Table_File_Editor.zip Volition Table File Editor] - GUI for editing <code>.xtbl</code> files<br />
* [https://jsonformatter.org/xml-formatter XML Formatter] - Use this to format <code>.xtbl</code> files so they are easier to read<br />
* [https://www.w3schools.com/xml/xml_validator.asp XML Validator] - Use this to validate <code>.xtbl</code> edits, any mistakes you make will crash the game<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5995 Mod Manager Re-mars-tered v1.03] - Legacy mod manager<br />
* [https://onecompiler.com/lua/3ykpyrhhb LUA Validator] - Useful for validating RSL scripts for errors, note it's safe to ignore <code>attempt to index a nil value (global 'rfg')</code><br />
<br />
===Useful Software===<br />
<br />
* [https://www.voidtools.com/ Voidtools Everything] - Locate files and folders by name instantly<br />
* [https://www.mythicsoft.com/agentransack/ Agent Ransack] - Bulk search for keywords within unpacked files<br />
* [https://notepad-plus-plus.org/downloads/ Notepad++] - Good text editor for manually editing <code>.xtbl</code> files, set language as XML<br />
<br />
==Tutorials==<br />
*[[Nanoforge xtbl editing]] - How to edit [[.xtbl]] files in Nanoforge.<br />
*[[Nanoforge Texture Editing]] - How to edit textures using Nanoforge.<br />
* XTBL Editing Guides [Placeholder]<br />
<br />
<br />
[[Category: Red Faction: Guerrilla]]<br />
[[Category: RF:G Editing]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Editing_Main_Page&diff=8969RF:G Editing Main Page2023-06-21T23:08:36Z<p>Camo: /* Tutorials */</p>
<hr />
<div>{{RFGEditing}}<br />
{{Under construction}}<br />
<br />
This will serve as a landing page for all resources related to [[Red Faction: Guerrilla]] editing for the '''Re-Mars-tered Edition'''.<br />
<br />
==External Links==<br />
===Community===<br />
*[https://discord.gg/factionfiles Faction Files Community Discord] - Active Red Faction series community Discord with #map-mod-development channel for community development discussion<br />
===Downloads===<br />
*[https://www.factionfiles.com/ff.php?action=files FactionFiles.com] - Custom mods, tools, patches, and reference material<br />
*[https://www.nexusmods.com/redfactionguerilla/mods/ Nexus Mods] - Custom mods<br />
*[https://www.nexusmods.com/redfactionguerrillaremarstered/mods/ Nexus Mods Re-Mars-tered] - Custom mods<br />
<br />
==Documentation==<br />
*[[RF:G Map organization]]<br />
*[[Nanoforge basics]]<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail<br />
===Core Concepts===<br />
*[[Red Faction: Guerrilla]]'s level editor is [[CLOE]], which is not publicly available.<br />
<br />
===Red Faction: Guerrilla File Formats===<br />
* <code>.xtbl</code> - XML table files are used to store properties or attributes in Red Faction: Guerrilla. Overall, their function is similar to the <code>.tbl</code> files of Red Faction and Red Faction II.<br />
* <code>.scriptx</code> - Internal script engine file, commonly used for missions and activities<br />
* <code>.dtodx</code> - Weather/lighting file for maps that controls things like fog, tint, ambient colour, eye adaption, bloom, cloud color and speed<br />
* <code>.gtodx</code> - Skybox file for maps that controls things like the sun texture, moon positions and if the horizon mountain texture is enabled<br />
* <code>.vpp_pc</code> - Packfile<br />
* <code>.rigx</code> - Rig<br />
* <code>.str2_pc</code> - Texture Packfile<br />
* <code>.rfgzone_pc</code> - Map zone<br />
* <code>.layer_pc</code> - Map zone<br />
* <code>.cpeg_pc, cvbm_pc</code> - Texture cpu file<br />
* <code>.gpeg_pc, gvbm_pc</code> - Texture gpu file<br />
* <code>.asm_pc</code> - Streaming index<br />
* <code>.csmesh_pc</code> - Static mesh cpu file<br />
* <code>.gsmesh_pc</code> - Static mesh gpu file<br />
* <code>.ccmesh_pc</code> - Character mesh cpu file<br />
* <code>.gcmesh_pc</code> - Character mesh gpu file<br />
* <code>.ccar_pc</code> - Vehicle mesh cpu file<br />
* <code>.gcar_pc</code> - Vehicle mesh gpu file<br />
* <code>.anim_pc</code> - Animation<br />
* <code>.cchk_pc</code> - Destructible object cpu file<br />
* <code>.gchk_pc</code> - Destructible object gpu file<br />
* <code>.cefct_pc</code> - Visual effect cpu file<br />
* <code>.gefct_pc</code> - Visual effect gpu file<br />
* <code>.cfmesh_pc</code> - Foliage mesh<br />
* <code>.cstch</code> - Terrain clutter mesh cpu file<br />
* <code>.gstch</code> - Terrain clutter mesh gpu file<br />
* <code>.cterrain_pc</code> - Terrain zone cpu file<br />
* <code>.gterrain_pc</code> - Terrain zone gpu file<br />
* <code>.ctmesh_pc</code> - Terrain subzone cpu file<br />
* <code>.gtmesh_pc</code> - Terrain subzone gpu file<br />
* <code>.fsmib</code> - Fullscreen map data<br />
* <code>.fxo_kg</code> - Shader<br />
* <code>.le_strings</code> - Steam localization strings<br />
* <code>.rfglocatext</code> - Localization strings<br />
* <code>.mat_pc</code> - Render material<br />
* <code>.morph_pc</code> - Animation Morph<br />
* <code>.vint_doc</code> - UI<br />
* <code>.sim_pc</code> - Cloth sim<br />
* <code>.xgs_pc</code> - Sound config<br />
* <code>.xsb_pc</code> - Soundbank<br />
* <code>.xwb_pc</code> - Wavebank<br />
* <code>.aud_pc</code> - Audio categories<br />
* <code>.vf3_pc</code> - Font<br />
* <code>.vfdvp_pc</code> - ?<br />
* <code>.rfgvp_pc</code> - ?<br />
<br />
===Red Faction: Guerrilla File Structure===<br />
<br />
\Red Faction Guerrilla Re-MARS-tered\data\<br />
<br />
The two most important files for modding most of RF:G are <code>misc.vpp_pc</code> & <code>table.vpp_pc</code><br />
<br />
* <code>activities.vpp_pc</code> - contains textures for singleplayer activities<br />
* <code>anims.vpp_pc</code> - contains animation files<br />
* <code>chunks.vpp_pc</code> - contains <code>.rfgchunkx</code> files and seems to be related to the <code>preload_chunks.xtbl</code> file, it's possible to add them to a map using the correct <code>dest_checksum</code> & <code>uid</code> numbers. Game might also spawn <code>missing_chunk</code> or <code>missing_destroyable</code> if a mesh fails to load.<br />
* <code>cloth_sim.vpp_pc</code> - contains cloth simulation files<br />
* <code>decals.vpp_pc</code> - contains decal textures<br />
* <code>dlc01_l0.vpp_pc</code> - singleplayer DLC map<br />
* <code>dlc01_l1.vpp_pc</code> - only contains a blank <code>asm_pc</code> file<br />
* <code>dlc01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer DLC map<br />
* <code>dlcp01_activities.vpp_pc</code> - contains textures for singleplayer DLC activities<br />
* <code>dlcp01_anims.vpp_pc</code> - contains animation files for singleplayer DLC<br />
* <code>dlcp01_cloth_sim.vpp_pc</code> - contains cloth simulation files for singleplayer DLC<br />
* <code>dlcp01_effects.vpp_pc</code> - contains visual effect files for singleplayer DLC, some are <code>.str2</code><br />
* <code>dlcp01_humans.vpp_pc</code> - contains textures and meshes for characters in singleplayer DLC<br />
* <code>dlcp01_interface.vpp_pc</code> - contains textures for loading screens & thumbnails in singleplayer DLC<br />
* <code>dlcp01_items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in singleplayer DLC<br />
* <code>dlc01_misc.vpp_pc</code> - contains <code>.rig_pc</code> files, the <code>.fsmib</code> file and two <code>.xtbl</code> files for singleplayer DLC<br />
* <code>dlc01_missions.vpp_pc</code> - contains textures related to singleplayer DLC missions<br />
* <code>dlcp01_personas_en_us.vpp_pc</code> - <br />
* <code>dlcp01_vehicles.vpp_pc</code> - contains textures and meshes for singleplayer DLC vehicles<br />
* <code>dlcp01_voices_en_us.vpp_pc</code> -<br />
* <code>dlcp02_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for multiplayer DLC<br />
* <code>dlcp02_misc.vpp_pc</code> - <br />
* <code>dlcp03_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for wrecking crew DLC<br />
* <code>dlcp03_misc.vpp_pc</code> -<br />
* <code>effects.vpp_pc</code> - contains visual effect files, some are <code>.str2</code><br />
* <code>effects_mp.vpp_pc</code> - contains multiplayer only visual effect files, some are <code>.str2</code><br />
* <code>humans.vpp_pc</code> - contains textures and meshes for characters in both singleplayer and multiplayer<br />
* <code>interface.vpp_pc</code> - contains textures for loading screens & thumbnails in both SP and MP and character portraits in multiplayer<br />
* <code>items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in both singleplayer & multiplayer<br />
* <code>items_mp.vpp_pc</code> - contains multiplayer only textures and meshes<br />
* <code>misc.vpp_pc</code> contains <code>.xtbl</code> files and most other file types<br />
* <code>missions.vpp_pc</code> - contains textures for singleplayer missions<br />
* <code>mp_common.vpp_pc</code> - contains textures shared between multiplayer maps<br />
* <code>mp_xxx.vpp_pc</code> - multiplayer maps, excluding <code>mp_common.vpp_pc</code><br />
* <code>mpdlc_xxx.vpp_pc</code> - DLC multiplayer maps<br />
* <code>personas_de_de.vpp_pc</code> -<br />
* <code>personas_en_us.vpp_pc</code> - <br />
* <code>personas_es_es.vpp_pc</code> - <br />
* <code>personas_fr_fr.vpp_pc</code> -<br />
* <code>personas_it_it.vpp_pc</code> -<br />
* <code>personas_ru_ru.vpp_pc</code> -<br />
* <code>rfg_cine_00a.bik_xbox2</code> -<br />
* <code>rfg_cine_01a.bik_xbox2</code> -<br />
* <code>rfg_cine_02a.bik_xbox2</code> -<br />
* <code>rfg_cine_03a.bik_xbox2</code> - <br />
* <code>rfg_cine_03b.bik_xbox2</code> - <br />
* <code>rfg_cine_04a.bik_xbox2</code> - <br />
* <code>rfg_cine_05a.bik_xbox2</code> - <br />
* <code>rfg_cine_06a.bik_xbox2</code> - <br />
* <code>skybox.vpp_pc</code> - contains textures for the skybox like the clouds<br />
* <code>sounds_r.vpp_pc</code> - contains <code>.xmb_pc</code> sound files<br />
* <code>steam.vpp_pc</code> -<br />
* <code>table.vpp_pc</code> - contains only <code>.xtbl</code> files and will overwrite <code>.xtbl</code> files in <code>misc.vpp_pc</code><br />
* <code>terr01_l0.vpp_pc</code> - singleplayer map<br />
* <code>terr01_l1.vpp_pc</code> - singleplayer map<br />
* <code>terr01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer map<br />
* <code>vehicles_r.vpp_pc</code> - contains textures and meshes for singleplayer vehicles<br />
* <code>voices_de_de.vpp_pc</code> - <br />
* <code>voices_en_us.vpp_pc</code> - <br />
* <code>voices_es_es.vpp_pc</code> - <br />
* <code>voices_fr_fr.vpp_pc</code> - <br />
* <code>voices_it_it.vpp_pc</code> - <br />
* <code>voices_ru_ru.vpp_pc</code> -<br />
* <code>wcxxx.vpp_c</code> - wrecking crew maps<br />
* <code>zonescript_dlc01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer DLC map<br />
* <code>zonescript_terr01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer map<br />
* <code>xxx.bik</code> - pre-rendered custscenes<br />
<br />
===Scriptx Functions===<br />
<br />
* [https://www.factionfiles.com/ff.php?action=scriptxfuncs .scriptx functions]<br />
<br />
===Primitive data types & limits===<br />
<br />
* Floats (floating decimal points): Max value <code>3.4028237</code> and move the decimal place right 38 times. Examples: <code>1.0, 0.0</code><br />
* Integer (whole number that could hold a zero, positive or negative value): Max value <code>2147483647</code><br />
* Boolean (truth value with two constants objects True and False , basically a toggle to enable or disable something using "true" or "false"): Examples: <code><Unlocks_Cheat>True</Unlocks_Cheat>, <Unlocks_Cheat>False</Unlocks_Cheat></code><br />
* String (represents a sequence or characters/text): Example: <code><string>OldCoot</string></code><br />
<br />
===sounds_r.vpp_pc Info===<br />
<br />
* S16 = Signed 16 bit<br />
* LE = Little endian<br />
* 2CH = 2 channels (stereo)<br />
<br />
* destruction.xwb_pc - unknown<br />
* dlc01_voc_d01offcam.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01dan.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm02.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm03.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm04.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm05.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm06.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01rfc.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01sam_pcm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01vasha_safe.xwb_pc.en_us.xwb_pc - unknown <br />
* mov_foley.xwb_pc - unknown <br />
* mov_jet_pack.xwb_pc - unknown <br />
* mov_male.xwb_pc - unknown <br />
* mov_npc_male.xwb_pc - unknown <br />
* mp_backpacks.xwb_pc - S16, LE, 2CH. Intermittent static starting ~28sec <br />
* mp_wep.xwb_pc - S16, LE, 2CH. Static at start and end <br />
* mus_briefings.xwb_pc - S16, LE, 2CH. <br />
* mus_demomaster.xwb_pc - S16, LE, 2CH. <br />
* mus_frontend.xwb_pc - S16, LE, 2CH. <br />
* mus_multiplayer.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_01.xwb_pc - S16, LE, 2CH. Static at start, may be header <br />
* mus_progression_02.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_03.xwb_pc - S16, LE, 2CH. <br />
* mus_sting.xwb_pc - S16, LE, 2CH. <br />
* obj_shared_ambient.xwb_pc - unknown<br />
* obj_shared_dth.xwb_pc - unknown <br />
* obj_shared_exp.xwb_pc - unknown<br />
* obj_shared_impact.xwb_pc - unknown <br />
* scripted_raids.xwb_pc - unknown <br />
* system.xwb_pc - S16, LE, 2CH. Mostly static, valid sound in middle <br />
* system_mp.xwb_pc - unknown <br />
* veh_civ_bus.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car1.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car2.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car3.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_flat.xwb_pc - unknown <br />
* veh_civ_flat2.xwb_pc - unknown<br />
* veh_civ_fuel.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_hauler.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_taxi.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_trash.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_walker.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_aax.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_abx.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_apc.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_atank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_htank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_mtank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_scout.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staff.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staffh2h.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_raider.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_atv.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_bull.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_dtruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_etruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_pickup.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_rover.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_roverwk.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supplyrt.xwb_pc - unknown<br />
* veh_min_wlklg.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_wlkmd.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_shared.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* walla.xwb_pc - unknown<br />
* weather.xwb_pc - S16, LE, 2CH.<br />
* wep_rfg.xwb_pc - S16, LE, 2CH. Mostly valid, some static<br />
<br />
===RfgUtil Guide===<br />
<br />
* Unpacking [Placeholder]<br />
* Repacking [Placeholder]<br />
* Command arguments [Placeholder]<br />
* Scripts [Placeholder]<br />
* Updating <code>.asm_pc</code> files [Placeholder]<br />
<br />
===Misc Notes===<br />
<br />
* When repacking <code>.vpp_pc</code> files don't compress and/or condense them if they weren't like that in the vanilla game, it will cause the game to crash. Eg: <code>items.vpp_pc</code>, <code>interface.vpp_pc</code>, map files etc. See the table below:<br />
* <code>table.vpp_pc</code> overwrites changes to <code>.xtbl</code> files in <code>misc.vpp_pc</code>. The work around for this with the legacy mod manager is to rename the file however this breaks multiplayer and reduces the stability of the game. You should edit the same <code>.xtbl</code> files in both <code>misc.vpp_pc</code> & <code>table.vpp_pc</code>.<br />
<br />
{| class="wikitable"<br />
|+<br />
|-<br />
! Filename !! Alignment !! Compressed !! Condensed<br />
|-<br />
| ALL .str2 || 0 || Yes || Yes<br />
|-<br />
| MOST .vpp_pc || 2048 || No || No<br />
|-<br />
| dlc01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlcp01_misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| mp_common.vpp_pc || 2048 || Yes || No<br />
|-<br />
| steam.vpp_pc || 2048 || Yes || No<br />
|-<br />
| terr01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_dlc01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_terr01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlc01_l1.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp01_voices_en_us.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp02_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| dlcp03_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| anims.vpp_pc || 16 || Yes || Yes<br />
|-<br />
| table.vpp_pc || 64 || Yes || Yes<br />
|-<br />
| skybox.vpp_pc || 4096 || No || No<br />
|-<br />
| dlcp01_personas_en_us.vpp_pc || 4096 || No || No<br />
<br />
|}<br />
<br />
===Red Faction: Guerrilla Tools===<br />
<br />
* [https://github.com/Moneyl/RfgUtil/releases RfgUtil] - Used for unpacking most file formats and updating <code>.asm_pc</code> files<br />
* [https://github.com/Moneyl/Nanoforge/releases Nanoforge C++] - Map editor, texture editor, <code>.xtbl</code> editor and more<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/mTools.zip mTools] - Drag and drop tool to convert <code>.asm_pc</code> files to XML and vice versa<br />
* [https://github.com/rsl-dev/RSL/releases RSL] - Script Loader<br />
* [https://github.com/Moneyl/AsmTool AsmTool]- WIP Tool for modifying <code>.asm_pc</code> files used by Red Faction Guerrilla. This is meant to replace hand editing them, which is very error prone and tedious<br />
* [https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe SyncFaction] - WIP tool for automatically installing the Terraform Patch and eventually replacing the old mod manager<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5686 xdelta UI] - GUI for generating <code>.xdelta</code> (binary) patches<br />
* [http://www.ximple.cz/download.php XiMpLe XML Editor] - Lightweight GUI XML Editor that displays XML type files in a table grid views and shows what other <code>.xtbls</code> it is referencing. Very useful for understanding and editing <code>.xtbl</code> files.<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/Volition_Table_File_Editor.zip Volition Table File Editor] - GUI for editing <code>.xtbl</code> files<br />
* [https://jsonformatter.org/xml-formatter XML Formatter] - Use this to format <code>.xtbl</code> files so they are easier to read<br />
* [https://www.w3schools.com/xml/xml_validator.asp XML Validator] - Use this to validate <code>.xtbl</code> edits, any mistakes you make will crash the game<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5995 Mod Manager Re-mars-tered v1.03] - Legacy mod manager<br />
* [https://onecompiler.com/lua/3ykpyrhhb LUA Validator] - Useful for validating RSL scripts for errors, note it's safe to ignore <code>attempt to index a nil value (global 'rfg')</code><br />
<br />
===Useful Software===<br />
<br />
* [https://www.voidtools.com/ Voidtools Everything] - Locate files and folders by name instantly<br />
* [https://www.mythicsoft.com/agentransack/ Agent Ransack] - Bulk search for keywords within unpacked files<br />
* [https://notepad-plus-plus.org/downloads/ Notepad++] - Good text editor for manually editing <code>.xtbl</code> files, set language as XML<br />
<br />
==Tutorials==<br />
*[[Nanoforge xtbl editing]] - How to edit [[.xtbl]] files in Nanoforge.<br />
*[[Nanoforge Texture Editing]] - How to edit textures using Nanoforge.<br />
* XTBL Editing Guides [Placeholder]<br />
<br />
<br />
[[Category: Red Faction: Guerrilla]]<br />
[[Category: RF:G Editing]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Editing_Main_Page&diff=8968RF:G Editing Main Page2023-06-21T06:04:27Z<p>Camo: /* Red Faction: Guerrilla Tools */</p>
<hr />
<div>{{RFGEditing}}<br />
{{Under construction}}<br />
<br />
This will serve as a landing page for all resources related to [[Red Faction: Guerrilla]] editing for the '''Re-Mars-tered Edition'''.<br />
<br />
==External Links==<br />
===Community===<br />
*[https://discord.gg/factionfiles Faction Files Community Discord] - Active Red Faction series community Discord with #map-mod-development channel for community development discussion<br />
===Downloads===<br />
*[https://www.factionfiles.com/ff.php?action=files FactionFiles.com] - Custom mods, tools, patches, and reference material<br />
*[https://www.nexusmods.com/redfactionguerilla/mods/ Nexus Mods] - Custom mods<br />
*[https://www.nexusmods.com/redfactionguerrillaremarstered/mods/ Nexus Mods Re-Mars-tered] - Custom mods<br />
<br />
==Documentation==<br />
*[[RF:G Map organization]]<br />
*[[Nanoforge basics]]<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail<br />
===Core Concepts===<br />
*[[Red Faction: Guerrilla]]'s level editor is [[CLOE]], which is not publicly available.<br />
<br />
===Red Faction: Guerrilla File Formats===<br />
* <code>.xtbl</code> - XML table files are used to store properties or attributes in Red Faction: Guerrilla. Overall, their function is similar to the <code>.tbl</code> files of Red Faction and Red Faction II.<br />
* <code>.scriptx</code> - Internal script engine file, commonly used for missions and activities<br />
* <code>.dtodx</code> - Weather/lighting file for maps that controls things like fog, tint, ambient colour, eye adaption, bloom, cloud color and speed<br />
* <code>.gtodx</code> - Skybox file for maps that controls things like the sun texture, moon positions and if the horizon mountain texture is enabled<br />
* <code>.vpp_pc</code> - Packfile<br />
* <code>.rigx</code> - Rig<br />
* <code>.str2_pc</code> - Texture Packfile<br />
* <code>.rfgzone_pc</code> - Map zone<br />
* <code>.layer_pc</code> - Map zone<br />
* <code>.cpeg_pc, cvbm_pc</code> - Texture cpu file<br />
* <code>.gpeg_pc, gvbm_pc</code> - Texture gpu file<br />
* <code>.asm_pc</code> - Streaming index<br />
* <code>.csmesh_pc</code> - Static mesh cpu file<br />
* <code>.gsmesh_pc</code> - Static mesh gpu file<br />
* <code>.ccmesh_pc</code> - Character mesh cpu file<br />
* <code>.gcmesh_pc</code> - Character mesh gpu file<br />
* <code>.ccar_pc</code> - Vehicle mesh cpu file<br />
* <code>.gcar_pc</code> - Vehicle mesh gpu file<br />
* <code>.anim_pc</code> - Animation<br />
* <code>.cchk_pc</code> - Destructible object cpu file<br />
* <code>.gchk_pc</code> - Destructible object gpu file<br />
* <code>.cefct_pc</code> - Visual effect cpu file<br />
* <code>.gefct_pc</code> - Visual effect gpu file<br />
* <code>.cfmesh_pc</code> - Foliage mesh<br />
* <code>.cstch</code> - Terrain clutter mesh cpu file<br />
* <code>.gstch</code> - Terrain clutter mesh gpu file<br />
* <code>.cterrain_pc</code> - Terrain zone cpu file<br />
* <code>.gterrain_pc</code> - Terrain zone gpu file<br />
* <code>.ctmesh_pc</code> - Terrain subzone cpu file<br />
* <code>.gtmesh_pc</code> - Terrain subzone gpu file<br />
* <code>.fsmib</code> - Fullscreen map data<br />
* <code>.fxo_kg</code> - Shader<br />
* <code>.le_strings</code> - Steam localization strings<br />
* <code>.rfglocatext</code> - Localization strings<br />
* <code>.mat_pc</code> - Render material<br />
* <code>.morph_pc</code> - Animation Morph<br />
* <code>.vint_doc</code> - UI<br />
* <code>.sim_pc</code> - Cloth sim<br />
* <code>.xgs_pc</code> - Sound config<br />
* <code>.xsb_pc</code> - Soundbank<br />
* <code>.xwb_pc</code> - Wavebank<br />
* <code>.aud_pc</code> - Audio categories<br />
* <code>.vf3_pc</code> - Font<br />
* <code>.vfdvp_pc</code> - ?<br />
* <code>.rfgvp_pc</code> - ?<br />
<br />
===Red Faction: Guerrilla File Structure===<br />
<br />
\Red Faction Guerrilla Re-MARS-tered\data\<br />
<br />
The two most important files for modding most of RF:G are <code>misc.vpp_pc</code> & <code>table.vpp_pc</code><br />
<br />
* <code>activities.vpp_pc</code> - contains textures for singleplayer activities<br />
* <code>anims.vpp_pc</code> - contains animation files<br />
* <code>chunks.vpp_pc</code> - contains <code>.rfgchunkx</code> files and seems to be related to the <code>preload_chunks.xtbl</code> file, it's possible to add them to a map using the correct <code>dest_checksum</code> & <code>uid</code> numbers. Game might also spawn <code>missing_chunk</code> or <code>missing_destroyable</code> if a mesh fails to load.<br />
* <code>cloth_sim.vpp_pc</code> - contains cloth simulation files<br />
* <code>decals.vpp_pc</code> - contains decal textures<br />
* <code>dlc01_l0.vpp_pc</code> - singleplayer DLC map<br />
* <code>dlc01_l1.vpp_pc</code> - only contains a blank <code>asm_pc</code> file<br />
* <code>dlc01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer DLC map<br />
* <code>dlcp01_activities.vpp_pc</code> - contains textures for singleplayer DLC activities<br />
* <code>dlcp01_anims.vpp_pc</code> - contains animation files for singleplayer DLC<br />
* <code>dlcp01_cloth_sim.vpp_pc</code> - contains cloth simulation files for singleplayer DLC<br />
* <code>dlcp01_effects.vpp_pc</code> - contains visual effect files for singleplayer DLC, some are <code>.str2</code><br />
* <code>dlcp01_humans.vpp_pc</code> - contains textures and meshes for characters in singleplayer DLC<br />
* <code>dlcp01_interface.vpp_pc</code> - contains textures for loading screens & thumbnails in singleplayer DLC<br />
* <code>dlcp01_items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in singleplayer DLC<br />
* <code>dlc01_misc.vpp_pc</code> - contains <code>.rig_pc</code> files, the <code>.fsmib</code> file and two <code>.xtbl</code> files for singleplayer DLC<br />
* <code>dlc01_missions.vpp_pc</code> - contains textures related to singleplayer DLC missions<br />
* <code>dlcp01_personas_en_us.vpp_pc</code> - <br />
* <code>dlcp01_vehicles.vpp_pc</code> - contains textures and meshes for singleplayer DLC vehicles<br />
* <code>dlcp01_voices_en_us.vpp_pc</code> -<br />
* <code>dlcp02_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for multiplayer DLC<br />
* <code>dlcp02_misc.vpp_pc</code> - <br />
* <code>dlcp03_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for wrecking crew DLC<br />
* <code>dlcp03_misc.vpp_pc</code> -<br />
* <code>effects.vpp_pc</code> - contains visual effect files, some are <code>.str2</code><br />
* <code>effects_mp.vpp_pc</code> - contains multiplayer only visual effect files, some are <code>.str2</code><br />
* <code>humans.vpp_pc</code> - contains textures and meshes for characters in both singleplayer and multiplayer<br />
* <code>interface.vpp_pc</code> - contains textures for loading screens & thumbnails in both SP and MP and character portraits in multiplayer<br />
* <code>items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in both singleplayer & multiplayer<br />
* <code>items_mp.vpp_pc</code> - contains multiplayer only textures and meshes<br />
* <code>misc.vpp_pc</code> contains <code>.xtbl</code> files and most other file types<br />
* <code>missions.vpp_pc</code> - contains textures for singleplayer missions<br />
* <code>mp_common.vpp_pc</code> - contains textures shared between multiplayer maps<br />
* <code>mp_xxx.vpp_pc</code> - multiplayer maps, excluding <code>mp_common.vpp_pc</code><br />
* <code>mpdlc_xxx.vpp_pc</code> - DLC multiplayer maps<br />
* <code>personas_de_de.vpp_pc</code> -<br />
* <code>personas_en_us.vpp_pc</code> - <br />
* <code>personas_es_es.vpp_pc</code> - <br />
* <code>personas_fr_fr.vpp_pc</code> -<br />
* <code>personas_it_it.vpp_pc</code> -<br />
* <code>personas_ru_ru.vpp_pc</code> -<br />
* <code>rfg_cine_00a.bik_xbox2</code> -<br />
* <code>rfg_cine_01a.bik_xbox2</code> -<br />
* <code>rfg_cine_02a.bik_xbox2</code> -<br />
* <code>rfg_cine_03a.bik_xbox2</code> - <br />
* <code>rfg_cine_03b.bik_xbox2</code> - <br />
* <code>rfg_cine_04a.bik_xbox2</code> - <br />
* <code>rfg_cine_05a.bik_xbox2</code> - <br />
* <code>rfg_cine_06a.bik_xbox2</code> - <br />
* <code>skybox.vpp_pc</code> - contains textures for the skybox like the clouds<br />
* <code>sounds_r.vpp_pc</code> - contains <code>.xmb_pc</code> sound files<br />
* <code>steam.vpp_pc</code> -<br />
* <code>table.vpp_pc</code> - contains only <code>.xtbl</code> files and will overwrite <code>.xtbl</code> files in <code>misc.vpp_pc</code><br />
* <code>terr01_l0.vpp_pc</code> - singleplayer map<br />
* <code>terr01_l1.vpp_pc</code> - singleplayer map<br />
* <code>terr01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer map<br />
* <code>vehicles_r.vpp_pc</code> - contains textures and meshes for singleplayer vehicles<br />
* <code>voices_de_de.vpp_pc</code> - <br />
* <code>voices_en_us.vpp_pc</code> - <br />
* <code>voices_es_es.vpp_pc</code> - <br />
* <code>voices_fr_fr.vpp_pc</code> - <br />
* <code>voices_it_it.vpp_pc</code> - <br />
* <code>voices_ru_ru.vpp_pc</code> -<br />
* <code>wcxxx.vpp_c</code> - wrecking crew maps<br />
* <code>zonescript_dlc01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer DLC map<br />
* <code>zonescript_terr01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer map<br />
* <code>xxx.bik</code> - pre-rendered custscenes<br />
<br />
===Scriptx Functions===<br />
<br />
* [https://www.factionfiles.com/ff.php?action=scriptxfuncs .scriptx functions]<br />
<br />
===Primitive data types & limits===<br />
<br />
* Floats (floating decimal points): Max value <code>3.4028237</code> and move the decimal place right 38 times. Examples: <code>1.0, 0.0</code><br />
* Integer (whole number that could hold a zero, positive or negative value): Max value <code>2147483647</code><br />
* Boolean (truth value with two constants objects True and False , basically a toggle to enable or disable something using "true" or "false"): Examples: <code><Unlocks_Cheat>True</Unlocks_Cheat>, <Unlocks_Cheat>False</Unlocks_Cheat></code><br />
* String (represents a sequence or characters/text): Example: <code><string>OldCoot</string></code><br />
<br />
===sounds_r.vpp_pc Info===<br />
<br />
* S16 = Signed 16 bit<br />
* LE = Little endian<br />
* 2CH = 2 channels (stereo)<br />
<br />
* destruction.xwb_pc - unknown<br />
* dlc01_voc_d01offcam.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01dan.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm02.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm03.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm04.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm05.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm06.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01rfc.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01sam_pcm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01vasha_safe.xwb_pc.en_us.xwb_pc - unknown <br />
* mov_foley.xwb_pc - unknown <br />
* mov_jet_pack.xwb_pc - unknown <br />
* mov_male.xwb_pc - unknown <br />
* mov_npc_male.xwb_pc - unknown <br />
* mp_backpacks.xwb_pc - S16, LE, 2CH. Intermittent static starting ~28sec <br />
* mp_wep.xwb_pc - S16, LE, 2CH. Static at start and end <br />
* mus_briefings.xwb_pc - S16, LE, 2CH. <br />
* mus_demomaster.xwb_pc - S16, LE, 2CH. <br />
* mus_frontend.xwb_pc - S16, LE, 2CH. <br />
* mus_multiplayer.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_01.xwb_pc - S16, LE, 2CH. Static at start, may be header <br />
* mus_progression_02.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_03.xwb_pc - S16, LE, 2CH. <br />
* mus_sting.xwb_pc - S16, LE, 2CH. <br />
* obj_shared_ambient.xwb_pc - unknown<br />
* obj_shared_dth.xwb_pc - unknown <br />
* obj_shared_exp.xwb_pc - unknown<br />
* obj_shared_impact.xwb_pc - unknown <br />
* scripted_raids.xwb_pc - unknown <br />
* system.xwb_pc - S16, LE, 2CH. Mostly static, valid sound in middle <br />
* system_mp.xwb_pc - unknown <br />
* veh_civ_bus.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car1.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car2.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car3.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_flat.xwb_pc - unknown <br />
* veh_civ_flat2.xwb_pc - unknown<br />
* veh_civ_fuel.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_hauler.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_taxi.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_trash.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_walker.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_aax.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_abx.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_apc.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_atank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_htank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_mtank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_scout.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staff.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staffh2h.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_raider.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_atv.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_bull.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_dtruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_etruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_pickup.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_rover.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_roverwk.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supplyrt.xwb_pc - unknown<br />
* veh_min_wlklg.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_wlkmd.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_shared.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* walla.xwb_pc - unknown<br />
* weather.xwb_pc - S16, LE, 2CH.<br />
* wep_rfg.xwb_pc - S16, LE, 2CH. Mostly valid, some static<br />
<br />
===RfgUtil Guide===<br />
<br />
* Unpacking [Placeholder]<br />
* Repacking [Placeholder]<br />
* Command arguments [Placeholder]<br />
* Scripts [Placeholder]<br />
* Updating <code>.asm_pc</code> files [Placeholder]<br />
<br />
===Misc Notes===<br />
<br />
* When repacking <code>.vpp_pc</code> files don't compress and/or condense them if they weren't like that in the vanilla game, it will cause the game to crash. Eg: <code>items.vpp_pc</code>, <code>interface.vpp_pc</code>, map files etc. See the table below:<br />
* <code>table.vpp_pc</code> overwrites changes to <code>.xtbl</code> files in <code>misc.vpp_pc</code>. The work around for this with the legacy mod manager is to rename the file however this breaks multiplayer and reduces the stability of the game. You should edit the same <code>.xtbl</code> files in both <code>misc.vpp_pc</code> & <code>table.vpp_pc</code>.<br />
<br />
{| class="wikitable"<br />
|+<br />
|-<br />
! Filename !! Alignment !! Compressed !! Condensed<br />
|-<br />
| ALL .str2 || 0 || Yes || Yes<br />
|-<br />
| MOST .vpp_pc || 2048 || No || No<br />
|-<br />
| dlc01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlcp01_misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| mp_common.vpp_pc || 2048 || Yes || No<br />
|-<br />
| steam.vpp_pc || 2048 || Yes || No<br />
|-<br />
| terr01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_dlc01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_terr01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlc01_l1.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp01_voices_en_us.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp02_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| dlcp03_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| anims.vpp_pc || 16 || Yes || Yes<br />
|-<br />
| table.vpp_pc || 64 || Yes || Yes<br />
|-<br />
| skybox.vpp_pc || 4096 || No || No<br />
|-<br />
| dlcp01_personas_en_us.vpp_pc || 4096 || No || No<br />
<br />
|}<br />
<br />
===Red Faction: Guerrilla Tools===<br />
<br />
* [https://github.com/Moneyl/RfgUtil/releases RfgUtil] - Used for unpacking most file formats and updating <code>.asm_pc</code> files<br />
* [https://github.com/Moneyl/Nanoforge/releases Nanoforge C++] - Map editor, texture editor, <code>.xtbl</code> editor and more<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/mTools.zip mTools] - Drag and drop tool to convert <code>.asm_pc</code> files to XML and vice versa<br />
* [https://github.com/rsl-dev/RSL/releases RSL] - Script Loader<br />
* [https://github.com/Moneyl/AsmTool AsmTool]- WIP Tool for modifying <code>.asm_pc</code> files used by Red Faction Guerrilla. This is meant to replace hand editing them, which is very error prone and tedious<br />
* [https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe SyncFaction] - WIP tool for automatically installing the Terraform Patch and eventually replacing the old mod manager<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5686 xdelta UI] - GUI for generating <code>.xdelta</code> (binary) patches<br />
* [http://www.ximple.cz/download.php XiMpLe XML Editor] - Lightweight GUI XML Editor that displays XML type files in a table grid views and shows what other <code>.xtbls</code> it is referencing. Very useful for understanding and editing <code>.xtbl</code> files.<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/Volition_Table_File_Editor.zip Volition Table File Editor] - GUI for editing <code>.xtbl</code> files<br />
* [https://jsonformatter.org/xml-formatter XML Formatter] - Use this to format <code>.xtbl</code> files so they are easier to read<br />
* [https://www.w3schools.com/xml/xml_validator.asp XML Validator] - Use this to validate <code>.xtbl</code> edits, any mistakes you make will crash the game<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5995 Mod Manager Re-mars-tered v1.03] - Legacy mod manager<br />
* [https://onecompiler.com/lua/3ykpyrhhb LUA Validator] - Useful for validating RSL scripts for errors, note it's safe to ignore <code>attempt to index a nil value (global 'rfg')</code><br />
<br />
===Useful Software===<br />
<br />
* [https://www.voidtools.com/ Voidtools Everything] - Locate files and folders by name instantly<br />
* [https://www.mythicsoft.com/agentransack/ Agent Ransack] - Bulk search for keywords within unpacked files<br />
* [https://notepad-plus-plus.org/downloads/ Notepad++] - Good text editor for manually editing <code>.xtbl</code> files, set language as XML<br />
<br />
==Tutorials==<br />
*[[Nanoforge basics]] - Introduction to Nanoforge and its features.<br />
*[[Nanoforge xtbl editing]] - How to edit [[.xtbl]] files in Nanoforge.<br />
*[[Nanoforge Texture Editing]] - How to edit textures using Nanoforge.<br />
* XTBL Editing Guides [Placeholder]<br />
<br />
<br />
[[Category: Red Faction: Guerrilla]]<br />
[[Category: RF:G Editing]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Editing_Main_Page&diff=8967RF:G Editing Main Page2023-06-21T05:44:05Z<p>Camo: /* Red Faction: Guerrilla Tools */</p>
<hr />
<div>{{RFGEditing}}<br />
{{Under construction}}<br />
<br />
This will serve as a landing page for all resources related to [[Red Faction: Guerrilla]] editing for the '''Re-Mars-tered Edition'''.<br />
<br />
==External Links==<br />
===Community===<br />
*[https://discord.gg/factionfiles Faction Files Community Discord] - Active Red Faction series community Discord with #map-mod-development channel for community development discussion<br />
===Downloads===<br />
*[https://www.factionfiles.com/ff.php?action=files FactionFiles.com] - Custom mods, tools, patches, and reference material<br />
*[https://www.nexusmods.com/redfactionguerilla/mods/ Nexus Mods] - Custom mods<br />
*[https://www.nexusmods.com/redfactionguerrillaremarstered/mods/ Nexus Mods Re-Mars-tered] - Custom mods<br />
<br />
==Documentation==<br />
*[[RF:G Map organization]]<br />
*[[Nanoforge basics]]<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail<br />
===Core Concepts===<br />
*[[Red Faction: Guerrilla]]'s level editor is [[CLOE]], which is not publicly available.<br />
<br />
===Red Faction: Guerrilla File Formats===<br />
* <code>.xtbl</code> - XML table files are used to store properties or attributes in Red Faction: Guerrilla. Overall, their function is similar to the <code>.tbl</code> files of Red Faction and Red Faction II.<br />
* <code>.scriptx</code> - Internal script engine file, commonly used for missions and activities<br />
* <code>.dtodx</code> - Weather/lighting file for maps that controls things like fog, tint, ambient colour, eye adaption, bloom, cloud color and speed<br />
* <code>.gtodx</code> - Skybox file for maps that controls things like the sun texture, moon positions and if the horizon mountain texture is enabled<br />
* <code>.vpp_pc</code> - Packfile<br />
* <code>.rigx</code> - Rig<br />
* <code>.str2_pc</code> - Texture Packfile<br />
* <code>.rfgzone_pc</code> - Map zone<br />
* <code>.layer_pc</code> - Map zone<br />
* <code>.cpeg_pc, cvbm_pc</code> - Texture cpu file<br />
* <code>.gpeg_pc, gvbm_pc</code> - Texture gpu file<br />
* <code>.asm_pc</code> - Streaming index<br />
* <code>.csmesh_pc</code> - Static mesh cpu file<br />
* <code>.gsmesh_pc</code> - Static mesh gpu file<br />
* <code>.ccmesh_pc</code> - Character mesh cpu file<br />
* <code>.gcmesh_pc</code> - Character mesh gpu file<br />
* <code>.ccar_pc</code> - Vehicle mesh cpu file<br />
* <code>.gcar_pc</code> - Vehicle mesh gpu file<br />
* <code>.anim_pc</code> - Animation<br />
* <code>.cchk_pc</code> - Destructible object cpu file<br />
* <code>.gchk_pc</code> - Destructible object gpu file<br />
* <code>.cefct_pc</code> - Visual effect cpu file<br />
* <code>.gefct_pc</code> - Visual effect gpu file<br />
* <code>.cfmesh_pc</code> - Foliage mesh<br />
* <code>.cstch</code> - Terrain clutter mesh cpu file<br />
* <code>.gstch</code> - Terrain clutter mesh gpu file<br />
* <code>.cterrain_pc</code> - Terrain zone cpu file<br />
* <code>.gterrain_pc</code> - Terrain zone gpu file<br />
* <code>.ctmesh_pc</code> - Terrain subzone cpu file<br />
* <code>.gtmesh_pc</code> - Terrain subzone gpu file<br />
* <code>.fsmib</code> - Fullscreen map data<br />
* <code>.fxo_kg</code> - Shader<br />
* <code>.le_strings</code> - Steam localization strings<br />
* <code>.rfglocatext</code> - Localization strings<br />
* <code>.mat_pc</code> - Render material<br />
* <code>.morph_pc</code> - Animation Morph<br />
* <code>.vint_doc</code> - UI<br />
* <code>.sim_pc</code> - Cloth sim<br />
* <code>.xgs_pc</code> - Sound config<br />
* <code>.xsb_pc</code> - Soundbank<br />
* <code>.xwb_pc</code> - Wavebank<br />
* <code>.aud_pc</code> - Audio categories<br />
* <code>.vf3_pc</code> - Font<br />
* <code>.vfdvp_pc</code> - ?<br />
* <code>.rfgvp_pc</code> - ?<br />
<br />
===Red Faction: Guerrilla File Structure===<br />
<br />
\Red Faction Guerrilla Re-MARS-tered\data\<br />
<br />
The two most important files for modding most of RF:G are <code>misc.vpp_pc</code> & <code>table.vpp_pc</code><br />
<br />
* <code>activities.vpp_pc</code> - contains textures for singleplayer activities<br />
* <code>anims.vpp_pc</code> - contains animation files<br />
* <code>chunks.vpp_pc</code> - contains <code>.rfgchunkx</code> files and seems to be related to the <code>preload_chunks.xtbl</code> file, it's possible to add them to a map using the correct <code>dest_checksum</code> & <code>uid</code> numbers. Game might also spawn <code>missing_chunk</code> or <code>missing_destroyable</code> if a mesh fails to load.<br />
* <code>cloth_sim.vpp_pc</code> - contains cloth simulation files<br />
* <code>decals.vpp_pc</code> - contains decal textures<br />
* <code>dlc01_l0.vpp_pc</code> - singleplayer DLC map<br />
* <code>dlc01_l1.vpp_pc</code> - only contains a blank <code>asm_pc</code> file<br />
* <code>dlc01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer DLC map<br />
* <code>dlcp01_activities.vpp_pc</code> - contains textures for singleplayer DLC activities<br />
* <code>dlcp01_anims.vpp_pc</code> - contains animation files for singleplayer DLC<br />
* <code>dlcp01_cloth_sim.vpp_pc</code> - contains cloth simulation files for singleplayer DLC<br />
* <code>dlcp01_effects.vpp_pc</code> - contains visual effect files for singleplayer DLC, some are <code>.str2</code><br />
* <code>dlcp01_humans.vpp_pc</code> - contains textures and meshes for characters in singleplayer DLC<br />
* <code>dlcp01_interface.vpp_pc</code> - contains textures for loading screens & thumbnails in singleplayer DLC<br />
* <code>dlcp01_items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in singleplayer DLC<br />
* <code>dlc01_misc.vpp_pc</code> - contains <code>.rig_pc</code> files, the <code>.fsmib</code> file and two <code>.xtbl</code> files for singleplayer DLC<br />
* <code>dlc01_missions.vpp_pc</code> - contains textures related to singleplayer DLC missions<br />
* <code>dlcp01_personas_en_us.vpp_pc</code> - <br />
* <code>dlcp01_vehicles.vpp_pc</code> - contains textures and meshes for singleplayer DLC vehicles<br />
* <code>dlcp01_voices_en_us.vpp_pc</code> -<br />
* <code>dlcp02_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for multiplayer DLC<br />
* <code>dlcp02_misc.vpp_pc</code> - <br />
* <code>dlcp03_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for wrecking crew DLC<br />
* <code>dlcp03_misc.vpp_pc</code> -<br />
* <code>effects.vpp_pc</code> - contains visual effect files, some are <code>.str2</code><br />
* <code>effects_mp.vpp_pc</code> - contains multiplayer only visual effect files, some are <code>.str2</code><br />
* <code>humans.vpp_pc</code> - contains textures and meshes for characters in both singleplayer and multiplayer<br />
* <code>interface.vpp_pc</code> - contains textures for loading screens & thumbnails in both SP and MP and character portraits in multiplayer<br />
* <code>items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in both singleplayer & multiplayer<br />
* <code>items_mp.vpp_pc</code> - contains multiplayer only textures and meshes<br />
* <code>misc.vpp_pc</code> contains <code>.xtbl</code> files and most other file types<br />
* <code>missions.vpp_pc</code> - contains textures for singleplayer missions<br />
* <code>mp_common.vpp_pc</code> - contains textures shared between multiplayer maps<br />
* <code>mp_xxx.vpp_pc</code> - multiplayer maps, excluding <code>mp_common.vpp_pc</code><br />
* <code>mpdlc_xxx.vpp_pc</code> - DLC multiplayer maps<br />
* <code>personas_de_de.vpp_pc</code> -<br />
* <code>personas_en_us.vpp_pc</code> - <br />
* <code>personas_es_es.vpp_pc</code> - <br />
* <code>personas_fr_fr.vpp_pc</code> -<br />
* <code>personas_it_it.vpp_pc</code> -<br />
* <code>personas_ru_ru.vpp_pc</code> -<br />
* <code>rfg_cine_00a.bik_xbox2</code> -<br />
* <code>rfg_cine_01a.bik_xbox2</code> -<br />
* <code>rfg_cine_02a.bik_xbox2</code> -<br />
* <code>rfg_cine_03a.bik_xbox2</code> - <br />
* <code>rfg_cine_03b.bik_xbox2</code> - <br />
* <code>rfg_cine_04a.bik_xbox2</code> - <br />
* <code>rfg_cine_05a.bik_xbox2</code> - <br />
* <code>rfg_cine_06a.bik_xbox2</code> - <br />
* <code>skybox.vpp_pc</code> - contains textures for the skybox like the clouds<br />
* <code>sounds_r.vpp_pc</code> - contains <code>.xmb_pc</code> sound files<br />
* <code>steam.vpp_pc</code> -<br />
* <code>table.vpp_pc</code> - contains only <code>.xtbl</code> files and will overwrite <code>.xtbl</code> files in <code>misc.vpp_pc</code><br />
* <code>terr01_l0.vpp_pc</code> - singleplayer map<br />
* <code>terr01_l1.vpp_pc</code> - singleplayer map<br />
* <code>terr01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer map<br />
* <code>vehicles_r.vpp_pc</code> - contains textures and meshes for singleplayer vehicles<br />
* <code>voices_de_de.vpp_pc</code> - <br />
* <code>voices_en_us.vpp_pc</code> - <br />
* <code>voices_es_es.vpp_pc</code> - <br />
* <code>voices_fr_fr.vpp_pc</code> - <br />
* <code>voices_it_it.vpp_pc</code> - <br />
* <code>voices_ru_ru.vpp_pc</code> -<br />
* <code>wcxxx.vpp_c</code> - wrecking crew maps<br />
* <code>zonescript_dlc01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer DLC map<br />
* <code>zonescript_terr01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer map<br />
* <code>xxx.bik</code> - pre-rendered custscenes<br />
<br />
===Scriptx Functions===<br />
<br />
* [https://www.factionfiles.com/ff.php?action=scriptxfuncs .scriptx functions]<br />
<br />
===Primitive data types & limits===<br />
<br />
* Floats (floating decimal points): Max value <code>3.4028237</code> and move the decimal place right 38 times. Examples: <code>1.0, 0.0</code><br />
* Integer (whole number that could hold a zero, positive or negative value): Max value <code>2147483647</code><br />
* Boolean (truth value with two constants objects True and False , basically a toggle to enable or disable something using "true" or "false"): Examples: <code><Unlocks_Cheat>True</Unlocks_Cheat>, <Unlocks_Cheat>False</Unlocks_Cheat></code><br />
* String (represents a sequence or characters/text): Example: <code><string>OldCoot</string></code><br />
<br />
===sounds_r.vpp_pc Info===<br />
<br />
* S16 = Signed 16 bit<br />
* LE = Little endian<br />
* 2CH = 2 channels (stereo)<br />
<br />
* destruction.xwb_pc - unknown<br />
* dlc01_voc_d01offcam.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01dan.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm02.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm03.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm04.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm05.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm06.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01rfc.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01sam_pcm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01vasha_safe.xwb_pc.en_us.xwb_pc - unknown <br />
* mov_foley.xwb_pc - unknown <br />
* mov_jet_pack.xwb_pc - unknown <br />
* mov_male.xwb_pc - unknown <br />
* mov_npc_male.xwb_pc - unknown <br />
* mp_backpacks.xwb_pc - S16, LE, 2CH. Intermittent static starting ~28sec <br />
* mp_wep.xwb_pc - S16, LE, 2CH. Static at start and end <br />
* mus_briefings.xwb_pc - S16, LE, 2CH. <br />
* mus_demomaster.xwb_pc - S16, LE, 2CH. <br />
* mus_frontend.xwb_pc - S16, LE, 2CH. <br />
* mus_multiplayer.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_01.xwb_pc - S16, LE, 2CH. Static at start, may be header <br />
* mus_progression_02.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_03.xwb_pc - S16, LE, 2CH. <br />
* mus_sting.xwb_pc - S16, LE, 2CH. <br />
* obj_shared_ambient.xwb_pc - unknown<br />
* obj_shared_dth.xwb_pc - unknown <br />
* obj_shared_exp.xwb_pc - unknown<br />
* obj_shared_impact.xwb_pc - unknown <br />
* scripted_raids.xwb_pc - unknown <br />
* system.xwb_pc - S16, LE, 2CH. Mostly static, valid sound in middle <br />
* system_mp.xwb_pc - unknown <br />
* veh_civ_bus.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car1.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car2.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car3.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_flat.xwb_pc - unknown <br />
* veh_civ_flat2.xwb_pc - unknown<br />
* veh_civ_fuel.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_hauler.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_taxi.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_trash.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_walker.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_aax.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_abx.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_apc.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_atank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_htank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_mtank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_scout.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staff.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staffh2h.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_raider.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_atv.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_bull.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_dtruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_etruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_pickup.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_rover.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_roverwk.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supplyrt.xwb_pc - unknown<br />
* veh_min_wlklg.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_wlkmd.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_shared.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* walla.xwb_pc - unknown<br />
* weather.xwb_pc - S16, LE, 2CH.<br />
* wep_rfg.xwb_pc - S16, LE, 2CH. Mostly valid, some static<br />
<br />
===RfgUtil Guide===<br />
<br />
* Unpacking [Placeholder]<br />
* Repacking [Placeholder]<br />
* Command arguments [Placeholder]<br />
* Scripts [Placeholder]<br />
* Updating <code>.asm_pc</code> files [Placeholder]<br />
<br />
===Misc Notes===<br />
<br />
* When repacking <code>.vpp_pc</code> files don't compress and/or condense them if they weren't like that in the vanilla game, it will cause the game to crash. Eg: <code>items.vpp_pc</code>, <code>interface.vpp_pc</code>, map files etc. See the table below:<br />
* <code>table.vpp_pc</code> overwrites changes to <code>.xtbl</code> files in <code>misc.vpp_pc</code>. The work around for this with the legacy mod manager is to rename the file however this breaks multiplayer and reduces the stability of the game. You should edit the same <code>.xtbl</code> files in both <code>misc.vpp_pc</code> & <code>table.vpp_pc</code>.<br />
<br />
{| class="wikitable"<br />
|+<br />
|-<br />
! Filename !! Alignment !! Compressed !! Condensed<br />
|-<br />
| ALL .str2 || 0 || Yes || Yes<br />
|-<br />
| MOST .vpp_pc || 2048 || No || No<br />
|-<br />
| dlc01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlcp01_misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| mp_common.vpp_pc || 2048 || Yes || No<br />
|-<br />
| steam.vpp_pc || 2048 || Yes || No<br />
|-<br />
| terr01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_dlc01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_terr01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlc01_l1.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp01_voices_en_us.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp02_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| dlcp03_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| anims.vpp_pc || 16 || Yes || Yes<br />
|-<br />
| table.vpp_pc || 64 || Yes || Yes<br />
|-<br />
| skybox.vpp_pc || 4096 || No || No<br />
|-<br />
| dlcp01_personas_en_us.vpp_pc || 4096 || No || No<br />
<br />
|}<br />
<br />
===Red Faction: Guerrilla Tools===<br />
<br />
* [https://github.com/Moneyl/RfgUtil/releases RfgUtil] - Used for unpacking most file formats and updating <code>.asm_pc</code> files<br />
* [https://github.com/Moneyl/Nanoforge/releases Nanoforge C++] - Map editor, texture editor, <code>.xtbl</code> editor and more<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/mTools.zip mTools] - Drag and drop tool to convert <code>.asm_pc</code> files to XML and vice versa<br />
* [https://github.com/rsl-dev/RSL/releases RSL] - Script Loader<br />
* [https://github.com/Moneyl/AsmTool AsmTool]- WIP Tool for modifying <code>.asm_pc</code> files used by Red Faction Guerrilla. This is meant to replace hand editing them, which is very error prone and tedious<br />
* [https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe SyncFaction] - WIP tool for automatically installing the Terraform Patch and eventually replacing the old mod manager<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5686 xdelta UI] - GUI for generating <code>.xdelta</code> (binary) patches<br />
* [https://www.w3schools.com/xml/xml_validator.asp XML Validator] - Use this to validate <code>.xtbl</code> edits, any mistakes you make will crash the game<br />
* [https://jsonformatter.org/xml-formatter XML Formatter] - Use this to format <code>.xtbl</code> files so they are easier to read<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5995 Mod Manager Re-mars-tered v1.03] - Legacy mod manager<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/Volition_Table_File_Editor.zip Volition Table File Editor] - GUI for editing <code>.xtbl</code> files<br />
* [https://onecompiler.com/lua/3ykpyrhhb LUA Validator] - Useful for validating RSL scripts for errors, note it's safe to ignore <code>attempt to index a nil value (global 'rfg')</code><br />
* [http://www.ximple.cz/download.php XiMpLe XML Editor] - Lightweight XML Editor that displays XML type files in a table grid views and shows what other <code>.xtbls</code> it is referencing. Very useful for understanding and editing <code>.xtbl</code> files.<br />
<br />
===Useful Software===<br />
<br />
* [https://www.voidtools.com/ Voidtools Everything] - Locate files and folders by name instantly<br />
* [https://www.mythicsoft.com/agentransack/ Agent Ransack] - Bulk search for keywords within unpacked files<br />
* [https://notepad-plus-plus.org/downloads/ Notepad++] - Good text editor for manually editing <code>.xtbl</code> files, set language as XML<br />
<br />
==Tutorials==<br />
*[[Nanoforge basics]] - Introduction to Nanoforge and its features.<br />
*[[Nanoforge xtbl editing]] - How to edit [[.xtbl]] files in Nanoforge.<br />
*[[Nanoforge Texture Editing]] - How to edit textures using Nanoforge.<br />
* XTBL Editing Guides [Placeholder]<br />
<br />
<br />
[[Category: Red Faction: Guerrilla]]<br />
[[Category: RF:G Editing]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Editing_Main_Page&diff=8966RF:G Editing Main Page2023-06-21T05:43:16Z<p>Camo: /* Red Faction: Guerrilla Tools */</p>
<hr />
<div>{{RFGEditing}}<br />
{{Under construction}}<br />
<br />
This will serve as a landing page for all resources related to [[Red Faction: Guerrilla]] editing for the '''Re-Mars-tered Edition'''.<br />
<br />
==External Links==<br />
===Community===<br />
*[https://discord.gg/factionfiles Faction Files Community Discord] - Active Red Faction series community Discord with #map-mod-development channel for community development discussion<br />
===Downloads===<br />
*[https://www.factionfiles.com/ff.php?action=files FactionFiles.com] - Custom mods, tools, patches, and reference material<br />
*[https://www.nexusmods.com/redfactionguerilla/mods/ Nexus Mods] - Custom mods<br />
*[https://www.nexusmods.com/redfactionguerrillaremarstered/mods/ Nexus Mods Re-Mars-tered] - Custom mods<br />
<br />
==Documentation==<br />
*[[RF:G Map organization]]<br />
*[[Nanoforge basics]]<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail<br />
===Core Concepts===<br />
*[[Red Faction: Guerrilla]]'s level editor is [[CLOE]], which is not publicly available.<br />
<br />
===Red Faction: Guerrilla File Formats===<br />
* <code>.xtbl</code> - XML table files are used to store properties or attributes in Red Faction: Guerrilla. Overall, their function is similar to the <code>.tbl</code> files of Red Faction and Red Faction II.<br />
* <code>.scriptx</code> - Internal script engine file, commonly used for missions and activities<br />
* <code>.dtodx</code> - Weather/lighting file for maps that controls things like fog, tint, ambient colour, eye adaption, bloom, cloud color and speed<br />
* <code>.gtodx</code> - Skybox file for maps that controls things like the sun texture, moon positions and if the horizon mountain texture is enabled<br />
* <code>.vpp_pc</code> - Packfile<br />
* <code>.rigx</code> - Rig<br />
* <code>.str2_pc</code> - Texture Packfile<br />
* <code>.rfgzone_pc</code> - Map zone<br />
* <code>.layer_pc</code> - Map zone<br />
* <code>.cpeg_pc, cvbm_pc</code> - Texture cpu file<br />
* <code>.gpeg_pc, gvbm_pc</code> - Texture gpu file<br />
* <code>.asm_pc</code> - Streaming index<br />
* <code>.csmesh_pc</code> - Static mesh cpu file<br />
* <code>.gsmesh_pc</code> - Static mesh gpu file<br />
* <code>.ccmesh_pc</code> - Character mesh cpu file<br />
* <code>.gcmesh_pc</code> - Character mesh gpu file<br />
* <code>.ccar_pc</code> - Vehicle mesh cpu file<br />
* <code>.gcar_pc</code> - Vehicle mesh gpu file<br />
* <code>.anim_pc</code> - Animation<br />
* <code>.cchk_pc</code> - Destructible object cpu file<br />
* <code>.gchk_pc</code> - Destructible object gpu file<br />
* <code>.cefct_pc</code> - Visual effect cpu file<br />
* <code>.gefct_pc</code> - Visual effect gpu file<br />
* <code>.cfmesh_pc</code> - Foliage mesh<br />
* <code>.cstch</code> - Terrain clutter mesh cpu file<br />
* <code>.gstch</code> - Terrain clutter mesh gpu file<br />
* <code>.cterrain_pc</code> - Terrain zone cpu file<br />
* <code>.gterrain_pc</code> - Terrain zone gpu file<br />
* <code>.ctmesh_pc</code> - Terrain subzone cpu file<br />
* <code>.gtmesh_pc</code> - Terrain subzone gpu file<br />
* <code>.fsmib</code> - Fullscreen map data<br />
* <code>.fxo_kg</code> - Shader<br />
* <code>.le_strings</code> - Steam localization strings<br />
* <code>.rfglocatext</code> - Localization strings<br />
* <code>.mat_pc</code> - Render material<br />
* <code>.morph_pc</code> - Animation Morph<br />
* <code>.vint_doc</code> - UI<br />
* <code>.sim_pc</code> - Cloth sim<br />
* <code>.xgs_pc</code> - Sound config<br />
* <code>.xsb_pc</code> - Soundbank<br />
* <code>.xwb_pc</code> - Wavebank<br />
* <code>.aud_pc</code> - Audio categories<br />
* <code>.vf3_pc</code> - Font<br />
* <code>.vfdvp_pc</code> - ?<br />
* <code>.rfgvp_pc</code> - ?<br />
<br />
===Red Faction: Guerrilla File Structure===<br />
<br />
\Red Faction Guerrilla Re-MARS-tered\data\<br />
<br />
The two most important files for modding most of RF:G are <code>misc.vpp_pc</code> & <code>table.vpp_pc</code><br />
<br />
* <code>activities.vpp_pc</code> - contains textures for singleplayer activities<br />
* <code>anims.vpp_pc</code> - contains animation files<br />
* <code>chunks.vpp_pc</code> - contains <code>.rfgchunkx</code> files and seems to be related to the <code>preload_chunks.xtbl</code> file, it's possible to add them to a map using the correct <code>dest_checksum</code> & <code>uid</code> numbers. Game might also spawn <code>missing_chunk</code> or <code>missing_destroyable</code> if a mesh fails to load.<br />
* <code>cloth_sim.vpp_pc</code> - contains cloth simulation files<br />
* <code>decals.vpp_pc</code> - contains decal textures<br />
* <code>dlc01_l0.vpp_pc</code> - singleplayer DLC map<br />
* <code>dlc01_l1.vpp_pc</code> - only contains a blank <code>asm_pc</code> file<br />
* <code>dlc01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer DLC map<br />
* <code>dlcp01_activities.vpp_pc</code> - contains textures for singleplayer DLC activities<br />
* <code>dlcp01_anims.vpp_pc</code> - contains animation files for singleplayer DLC<br />
* <code>dlcp01_cloth_sim.vpp_pc</code> - contains cloth simulation files for singleplayer DLC<br />
* <code>dlcp01_effects.vpp_pc</code> - contains visual effect files for singleplayer DLC, some are <code>.str2</code><br />
* <code>dlcp01_humans.vpp_pc</code> - contains textures and meshes for characters in singleplayer DLC<br />
* <code>dlcp01_interface.vpp_pc</code> - contains textures for loading screens & thumbnails in singleplayer DLC<br />
* <code>dlcp01_items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in singleplayer DLC<br />
* <code>dlc01_misc.vpp_pc</code> - contains <code>.rig_pc</code> files, the <code>.fsmib</code> file and two <code>.xtbl</code> files for singleplayer DLC<br />
* <code>dlc01_missions.vpp_pc</code> - contains textures related to singleplayer DLC missions<br />
* <code>dlcp01_personas_en_us.vpp_pc</code> - <br />
* <code>dlcp01_vehicles.vpp_pc</code> - contains textures and meshes for singleplayer DLC vehicles<br />
* <code>dlcp01_voices_en_us.vpp_pc</code> -<br />
* <code>dlcp02_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for multiplayer DLC<br />
* <code>dlcp02_misc.vpp_pc</code> - <br />
* <code>dlcp03_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for wrecking crew DLC<br />
* <code>dlcp03_misc.vpp_pc</code> -<br />
* <code>effects.vpp_pc</code> - contains visual effect files, some are <code>.str2</code><br />
* <code>effects_mp.vpp_pc</code> - contains multiplayer only visual effect files, some are <code>.str2</code><br />
* <code>humans.vpp_pc</code> - contains textures and meshes for characters in both singleplayer and multiplayer<br />
* <code>interface.vpp_pc</code> - contains textures for loading screens & thumbnails in both SP and MP and character portraits in multiplayer<br />
* <code>items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in both singleplayer & multiplayer<br />
* <code>items_mp.vpp_pc</code> - contains multiplayer only textures and meshes<br />
* <code>misc.vpp_pc</code> contains <code>.xtbl</code> files and most other file types<br />
* <code>missions.vpp_pc</code> - contains textures for singleplayer missions<br />
* <code>mp_common.vpp_pc</code> - contains textures shared between multiplayer maps<br />
* <code>mp_xxx.vpp_pc</code> - multiplayer maps, excluding <code>mp_common.vpp_pc</code><br />
* <code>mpdlc_xxx.vpp_pc</code> - DLC multiplayer maps<br />
* <code>personas_de_de.vpp_pc</code> -<br />
* <code>personas_en_us.vpp_pc</code> - <br />
* <code>personas_es_es.vpp_pc</code> - <br />
* <code>personas_fr_fr.vpp_pc</code> -<br />
* <code>personas_it_it.vpp_pc</code> -<br />
* <code>personas_ru_ru.vpp_pc</code> -<br />
* <code>rfg_cine_00a.bik_xbox2</code> -<br />
* <code>rfg_cine_01a.bik_xbox2</code> -<br />
* <code>rfg_cine_02a.bik_xbox2</code> -<br />
* <code>rfg_cine_03a.bik_xbox2</code> - <br />
* <code>rfg_cine_03b.bik_xbox2</code> - <br />
* <code>rfg_cine_04a.bik_xbox2</code> - <br />
* <code>rfg_cine_05a.bik_xbox2</code> - <br />
* <code>rfg_cine_06a.bik_xbox2</code> - <br />
* <code>skybox.vpp_pc</code> - contains textures for the skybox like the clouds<br />
* <code>sounds_r.vpp_pc</code> - contains <code>.xmb_pc</code> sound files<br />
* <code>steam.vpp_pc</code> -<br />
* <code>table.vpp_pc</code> - contains only <code>.xtbl</code> files and will overwrite <code>.xtbl</code> files in <code>misc.vpp_pc</code><br />
* <code>terr01_l0.vpp_pc</code> - singleplayer map<br />
* <code>terr01_l1.vpp_pc</code> - singleplayer map<br />
* <code>terr01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer map<br />
* <code>vehicles_r.vpp_pc</code> - contains textures and meshes for singleplayer vehicles<br />
* <code>voices_de_de.vpp_pc</code> - <br />
* <code>voices_en_us.vpp_pc</code> - <br />
* <code>voices_es_es.vpp_pc</code> - <br />
* <code>voices_fr_fr.vpp_pc</code> - <br />
* <code>voices_it_it.vpp_pc</code> - <br />
* <code>voices_ru_ru.vpp_pc</code> -<br />
* <code>wcxxx.vpp_c</code> - wrecking crew maps<br />
* <code>zonescript_dlc01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer DLC map<br />
* <code>zonescript_terr01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer map<br />
* <code>xxx.bik</code> - pre-rendered custscenes<br />
<br />
===Scriptx Functions===<br />
<br />
* [https://www.factionfiles.com/ff.php?action=scriptxfuncs .scriptx functions]<br />
<br />
===Primitive data types & limits===<br />
<br />
* Floats (floating decimal points): Max value <code>3.4028237</code> and move the decimal place right 38 times. Examples: <code>1.0, 0.0</code><br />
* Integer (whole number that could hold a zero, positive or negative value): Max value <code>2147483647</code><br />
* Boolean (truth value with two constants objects True and False , basically a toggle to enable or disable something using "true" or "false"): Examples: <code><Unlocks_Cheat>True</Unlocks_Cheat>, <Unlocks_Cheat>False</Unlocks_Cheat></code><br />
* String (represents a sequence or characters/text): Example: <code><string>OldCoot</string></code><br />
<br />
===sounds_r.vpp_pc Info===<br />
<br />
* S16 = Signed 16 bit<br />
* LE = Little endian<br />
* 2CH = 2 channels (stereo)<br />
<br />
* destruction.xwb_pc - unknown<br />
* dlc01_voc_d01offcam.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01dan.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm02.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm03.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm04.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm05.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm06.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01rfc.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01sam_pcm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01vasha_safe.xwb_pc.en_us.xwb_pc - unknown <br />
* mov_foley.xwb_pc - unknown <br />
* mov_jet_pack.xwb_pc - unknown <br />
* mov_male.xwb_pc - unknown <br />
* mov_npc_male.xwb_pc - unknown <br />
* mp_backpacks.xwb_pc - S16, LE, 2CH. Intermittent static starting ~28sec <br />
* mp_wep.xwb_pc - S16, LE, 2CH. Static at start and end <br />
* mus_briefings.xwb_pc - S16, LE, 2CH. <br />
* mus_demomaster.xwb_pc - S16, LE, 2CH. <br />
* mus_frontend.xwb_pc - S16, LE, 2CH. <br />
* mus_multiplayer.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_01.xwb_pc - S16, LE, 2CH. Static at start, may be header <br />
* mus_progression_02.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_03.xwb_pc - S16, LE, 2CH. <br />
* mus_sting.xwb_pc - S16, LE, 2CH. <br />
* obj_shared_ambient.xwb_pc - unknown<br />
* obj_shared_dth.xwb_pc - unknown <br />
* obj_shared_exp.xwb_pc - unknown<br />
* obj_shared_impact.xwb_pc - unknown <br />
* scripted_raids.xwb_pc - unknown <br />
* system.xwb_pc - S16, LE, 2CH. Mostly static, valid sound in middle <br />
* system_mp.xwb_pc - unknown <br />
* veh_civ_bus.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car1.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car2.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car3.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_flat.xwb_pc - unknown <br />
* veh_civ_flat2.xwb_pc - unknown<br />
* veh_civ_fuel.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_hauler.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_taxi.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_trash.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_walker.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_aax.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_abx.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_apc.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_atank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_htank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_mtank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_scout.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staff.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staffh2h.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_raider.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_atv.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_bull.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_dtruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_etruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_pickup.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_rover.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_roverwk.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supplyrt.xwb_pc - unknown<br />
* veh_min_wlklg.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_wlkmd.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_shared.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* walla.xwb_pc - unknown<br />
* weather.xwb_pc - S16, LE, 2CH.<br />
* wep_rfg.xwb_pc - S16, LE, 2CH. Mostly valid, some static<br />
<br />
===RfgUtil Guide===<br />
<br />
* Unpacking [Placeholder]<br />
* Repacking [Placeholder]<br />
* Command arguments [Placeholder]<br />
* Scripts [Placeholder]<br />
* Updating <code>.asm_pc</code> files [Placeholder]<br />
<br />
===Misc Notes===<br />
<br />
* When repacking <code>.vpp_pc</code> files don't compress and/or condense them if they weren't like that in the vanilla game, it will cause the game to crash. Eg: <code>items.vpp_pc</code>, <code>interface.vpp_pc</code>, map files etc. See the table below:<br />
* <code>table.vpp_pc</code> overwrites changes to <code>.xtbl</code> files in <code>misc.vpp_pc</code>. The work around for this with the legacy mod manager is to rename the file however this breaks multiplayer and reduces the stability of the game. You should edit the same <code>.xtbl</code> files in both <code>misc.vpp_pc</code> & <code>table.vpp_pc</code>.<br />
<br />
{| class="wikitable"<br />
|+<br />
|-<br />
! Filename !! Alignment !! Compressed !! Condensed<br />
|-<br />
| ALL .str2 || 0 || Yes || Yes<br />
|-<br />
| MOST .vpp_pc || 2048 || No || No<br />
|-<br />
| dlc01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlcp01_misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| mp_common.vpp_pc || 2048 || Yes || No<br />
|-<br />
| steam.vpp_pc || 2048 || Yes || No<br />
|-<br />
| terr01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_dlc01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_terr01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlc01_l1.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp01_voices_en_us.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp02_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| dlcp03_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| anims.vpp_pc || 16 || Yes || Yes<br />
|-<br />
| table.vpp_pc || 64 || Yes || Yes<br />
|-<br />
| skybox.vpp_pc || 4096 || No || No<br />
|-<br />
| dlcp01_personas_en_us.vpp_pc || 4096 || No || No<br />
<br />
|}<br />
<br />
===Red Faction: Guerrilla Tools===<br />
<br />
* [https://github.com/Moneyl/RfgUtil/releases RfgUtil] - Used for unpacking most file formats and updating <code>.asm_pc</code> files<br />
* [https://github.com/Moneyl/Nanoforge/releases Nanoforge C++] - Map editor, texture editor, <code>.xtbl</code> editor and more<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/mTools.zip mTools] - Drag and drop tool to convert <code>.asm_pc</code> files to XML and vice versa<br />
* [https://github.com/rsl-dev/RSL/releases RSL] - Script Loader<br />
* [https://github.com/Moneyl/AsmTool AsmTool]- WIP Tool for modifying <code>.asm_pc</code> files used by Red Faction Guerrilla. This is meant to replace hand editing them, which is very error prone and tedious<br />
* [https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe SyncFaction] - WIP tool for automatically installing the Terraform Patch and eventually replacing the old mod manager<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5686 xdelta UI] - GUI for generating <code>.xdelta</code> (binary) patches<br />
* [https://www.w3schools.com/xml/xml_validator.asp XML Validator] - Use this to validate <code>.xtbl</code> edits, any mistakes you make will crash the game<br />
* [https://jsonformatter.org/xml-formatter XML Formatter] - Use this to format <code>.xtbl</code> files so they are easier to read<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5995 Mod Manager Re-mars-tered v1.03] - Legacy mod manager<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/Volition_Table_File_Editor.zip Volition Table File Editor] - GUI for editing <code>.xtbl</code> files<br />
* [https://onecompiler.com/lua/3ykpyrhhb LUA Validator] - Useful for validating RSL scripts for errors, note it's safe to ignore <code>attempt to index a nil value (global 'rfg')</code><br />
* [http://www.ximple.cz/download.php XiMpLe XML Editor] - Lightweight XML Editor that displays XML type files in a table grid views and shows what other files the file is referencing. Very useful for understanding and editing <code>.xtbl</code> files.<br />
<br />
===Useful Software===<br />
<br />
* [https://www.voidtools.com/ Voidtools Everything] - Locate files and folders by name instantly<br />
* [https://www.mythicsoft.com/agentransack/ Agent Ransack] - Bulk search for keywords within unpacked files<br />
* [https://notepad-plus-plus.org/downloads/ Notepad++] - Good text editor for manually editing <code>.xtbl</code> files, set language as XML<br />
<br />
==Tutorials==<br />
*[[Nanoforge basics]] - Introduction to Nanoforge and its features.<br />
*[[Nanoforge xtbl editing]] - How to edit [[.xtbl]] files in Nanoforge.<br />
*[[Nanoforge Texture Editing]] - How to edit textures using Nanoforge.<br />
* XTBL Editing Guides [Placeholder]<br />
<br />
<br />
[[Category: Red Faction: Guerrilla]]<br />
[[Category: RF:G Editing]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=Nanoforge_basics&diff=8965Nanoforge basics2023-06-21T05:08:38Z<p>Camo: /* Bagman Objective Spawn */</p>
<hr />
<div>{{RFGEditing}}<br />
{{Under construction}}<br />
<br />
This page goes over how to install Nanoforge and it's basic features. This article only goes over the basics of each feature. See the other guides for more detailed explanations.<br />
<br />
==Installation==<br />
===Download===<br />
Nanoforge releases are posted on [https://github.com/Moneyl/Nanoforge/releases github]. Multiple releases will be listed. You should always download the most recent release. To download it, look for the <code>▸Assets</code> button(1), click it, and download the first zip file listed under it(2).<br />
<br />
[[File:NanoforgeDownloadStepsAnnotated.png|frameless|768px]]<br />
<br />
===Install===<br />
*Unpack the zip file you downloaded anywhere and run Nanoforge.exe<br />
*You should now see the start screen. On the left side it has the data path and the recent projects list. On the right it has the changelog. Nanoforge with attempt to auto detect your RFG install. If it says that your data path is invalid click the <code>Browse...</code> button and select your RFG data folder.<br />
<br />
==Features==<br />
This section gives a quick rundown of each of Nanoforge's features.<br />
<br />
===Projects===<br />
Nanoforge uses projects to track edits made to game files. The idea is to use a single project per mod. You only need to create a project if you're editing files. You don't need one to view and export files. To create a new project click <code>New project</code> in the start page or <code>File > New project...</code> on the main menu bar. Fill out all the info on the popup and click <code>Create</code>. Below are each of the fields to fill in:<br />
*Name: The name of the project. Used to name the project file and as the name in any modinfo.xml files it generates.<br />
*Path: Path to the folder that the project should be created in.<br />
*Description: (Optional) Description of what the mod is. Used in the description field of modinfo.xml.<br />
*Author: (Optional) Author(s) of the mod. Used in the author filed of modinfo.xml.<br />
*Create project folder: If unchecked then the project files are placed directly in the folder chosen for path. If checked a folder with the entered name will be created in that folder.<br />
<br />
===File explorer===<br />
The file explorer lets you view the contents of vpp_pc and str2_pc files without extracting them manually. You can double click supported file formats like textures to open them. If you single click a vpp_pc or str2_pc file it will expand to show it's contents. Extra info about the file will be shown in the properties panel for some files when single clicking them.<br />
<br />
[[File:Nanoforge ProjectCreationExample3.png|frameless|256px]]<br />
<br />
====Search====<br />
You can use the search bar to limit which files are shown in the file explorer. By default it will only show files with names that contain the search term. You can also use some special characters to specialize your search behavior:<br />
*Start your search with *: Will only show files with names that end with whatever comes after *<br />
*End your search with *: Will only show files with names that start with whatever comes before *<br />
<br />
If you prefer regex you can check the regex search option. Note that the regex search option is much slower than the default one.<br />
<br />
===Properties panel===<br />
The properties panel sometimes will show additional info about files selected in the file explorer. It also may be used by other UI panels to show additional info. For example, it can list object properties when viewing territories (see map viewing section below).<br />
<br />
[[File:Nanoforge_PropertiesPanel2.png|frameless|256px]]<br />
<br />
===Textures===<br />
You can open texture files by double clicking them in the file explorer. Textures are split into two files. Either a cpeg_pc and gpeg_pc file pair or a cvbm_pc and gvbm_pc file pair. You can double click any of these to open a texture. A single RFG texture file can contain multiple textures, which we'll refer to as subtextures. Info about the selected subtexture will be shown below the subtexture list.<br />
<br />
[[File:Nanoforge_TextureDocument.png|frameless|768px]]<br />
<br />
Above is an example of what you might see if you open a texture file. On the sidebar to the left there a few things, in order:<br />
*The subtexture list. Click on one to see more info about it below.<br />
*Texture info. This is info about the selected subtexture.<br />
*Header info. This is general info about the cpeg/cvbm file.<br />
<br />
====Exporting textures====<br />
Textures can be exported to files you can edit with common image editors like Paint.NET, GIMP, or Photoshop. Currently textures can only be exported as .dds files. You can export single subtextures by right clicking one of them and clicking <code>Export...</code>. You can export all subtextures at once with the <code>Export all...</code> button.<br />
<br />
====Editing textures====<br />
Textures can be edited by imported textures you've edited externally. Currently it can only import .dds files. You do this by right clicking a subtexture, clicking <code>Replace...</code> and selecting the file you want to replace the subtexture with. Once you do this it's critical that you press the <code>Save</code> button above the subtexture list to save your edit. This edit will be automatically saved to your current project when you click <code>Save</code>. See [[Nanoforge Texture Editing]] for more info.<br />
<br />
===Meshes===<br />
Nanoforge supports viewing and exporting .csmesh_pc (static mesh) and .ccmesh_pc (character mesh) files. Just like textures, meshes consist of two files. Every csmesh_pc file is paired with a gsmesh_pc file, and every ccmesh_pc file is paired with a gcmesh_pc file. You can click any of them to open a mesh. When you open a mesh you'll first see a blank space. Meshes are loaded on a background thread so it may take a few seconds for the mesh to be loaded and for it's textures to show up. Before its textures are found or if the textures cant be found you might see textures from previously loaded meshes applied to the mesh.<br />
<br />
[[File:Nanoforge_MeshDocument.png|frameless|512px]]<br />
<br />
Above is what you might see if you open a mesh file. There's a few parts of the UI to note, in order:<br />
* The camera button. This lets you control camera settings like speed and location. You can move the camera by holding down the right mouse button and using WASD to move around. If this doesn't work try left clicking on the mesh 3D view. Only the most recently selected mesh reacts to camera controls so if you have several open it'll only move one camera.<br />
* The scene button. This has some rendering settings for the mesh such as scale and lighting color/intensity.<br />
* The info button. This shows some additional info about the mesh such as vertex format, and the LOD slider for meshes with multiple levels of detail.<br />
* The export button. This lets you export the mesh and it's textures to a .obj file, which can be imported into tools like blender.<br />
* The status bar. This shows the loading status and percentage. It will show <code>Done! ✓</code> once loading is complete.<br />
<br />
====Exporting meshes====<br />
To export a mesh:<br />
* Wait for it to finish loading. The status bar will show <code>Done! ✓</code> and 100%.<br />
* Click the export button. Top left of the document, button furthest to the right.<br />
* Select a folder to export the mesh and it's textures to and click <code>Export</code>.<br />
<br />
A single gltf file and the meshes textures will be exported. Each lod level is labelled in the gltf under their own subnode. Currently these gltf files don't look right as is when imported into Blender. This is because GLTF uses a different rendering model than RFG. Typically meshes have a diffuse, specular, and normal texture. Their names end with _d, _s, and _n respectively. You'll need to make the following changes to the textures in the Blender shading tab:<br />
* Diffuse -> Set color space to linear, attach texture color to "Base Color" on the BSDF<br />
* Specular -> Set color space to linear, attach texture color to "Specular" on the BSDF<br />
* Normal -> Set color space to SRGB, attach texture color to "Normal" on the BSDF<br />
<br />
In the near future an extension will be made to automatically patch the shader graph.<br />
<br />
====Camera movement====<br />
To move the camera hold down the right mouse button over the 3D view and use WASD to move around. Holding down shift while moving will cause the camera to move faster. Pressing Q and E will move the camera directly up and directly down respectively.<br />
<br />
===Mod packaging===<br />
Once you're done editing textures you can use Nanoforge to repack the editing files and generate a modinfo.xml for you. To do this, simply click <code>File > Package mod</code> on the main menu bar. Once it's done go to the "Output" folder inside your project folder to see the modinfo.xml and any files that it relies on. These are ready for use with the re-mars-tered mod manager.<br />
<br />
===Map view===<br />
Nanoforge has partial support for viewing maps like the main campaign map. We'll be referring to them as territories as that's how RFG groups together many zones. See [[RF:G Map organization]] for more details on how RFG maps are structured. To open a territory via <code>Tools > Open territory</code> on the main menu bar. Terr01 is the main campaign map territory. A new document should appear when you open a new territory. Camera movement is the same as the mesh viewer. See [[#Camera_movement|camera movement]]. Terrain is loaded in the background so you'll see separate blocks of terrain pop into view as they load. Bounding boxes are drawn for zone objects. With a territory open you should see new information on the zone panel and the zone objects panel. You can dock panels by clicking and dragging on their titles. It's recommended that you dock the zone object list below the zone list so you can see both at once.<br />
<br />
Below is an annotated image of information you can view about territories plus descriptions for each annotation.<br />
<br />
[[File:Nanoforge_W3p0erDiTj.jpg|frameless|1024px]]<br />
<br />
* First, in the top left is the zone list. Territories are made up of one or more zones which in turn have many zone objects. Click a zone to see its object in the zone objects panel (bottom left). By default the zone with the most objects is selected. In this case that's <code>04_06</code>. Note that each zone corresponds to a rfgzone_pc file. So, for example, <code>04_06</code> is really terr01_04_06.rfgzone_pc.<br />
* Next, bottom left is the zone objects list. This lists the objects inside the selected zone. Click an object to see its properties in the properties panel. Some objects have child objects, denoted by having a triangle in front of their name which you can click to expand them. You can filter objects by type inside the filters header. By default some very common objects like navpoints are hidden.<br />
* Finally, in the top right is the properties panel. This shows the properties of the selected zone object.<br />
<br />
==Object Flags==<br />
* Flag 0 (Persistent): Unknown, any objects with this flag have a separate copy stored in a second <code>rfgzone_pc</code> file with its name prefixed with <code>p__.</code> So, for example, Crescent has two <code>rfgzone_pc</code> files. <code>mp_crescent.rfgzone_pc</code> and <code>p_mp_crescent.rfgzone_pc</code>. The objects with the persistent flag are stored in both zone files, while objects without that flag are only stored in <code>mp_crescent.rfgzone_pc</code>. It's consistently used on player spawns, on most siege objectives and on most <code>rfg_movers</code> on Siege maps. It's recommended you don't enable or disable this flag on maps if you're using the Terraform Patch as it contains fixes for missing objects that incorrectly used this flag or were missing it; doing so will cause objects to vanish.<br />
* Flag 1: Unknown<br />
* Flag 2: Unknown <br />
* Flag 3: Unknown; might be related to how the game saves/loads map data from save files (requires more investigation)<br />
* Flag 4: Unknown; seems to always get converted to the runtime flag <code>streaming_fixed</code>, most <code>rfg_movers</code> and <code>general_movers</code> have this flag. If you're using the Terraform Patch it's recommended you don't disable this flag as it applies it to all objects since it was used most of the time and objects missing it were assumed to be an error by Volition. (They also made mistakes with the gamemode and persistent flags)<br />
* Flag 5: Unknown; seems to get converted to the runtime flag <code>force_full_save</code><br />
* Flag 6: Unknown<br />
* Flag 7: Unknown<br />
* Flag 8: Spawns in Anarchy<br />
* Flag 9: Spawns in Team Anarchy<br />
* Flag 10: Spawns in CTF<br />
* Flag 11: Spawns in Siege<br />
* Flag 12: Spawns in Damage Control<br />
* Flag 13: Spawns in Bagman<br />
* Flag 14: Spawns in Team Bagman<br />
* Flag 15: Spawns in Demolition<br />
<br />
==Chunk Flags==<br />
* Applies to <code>rfg_movers</code> & <code>general_movers</code>.<br />
* When editing their properties in the inspector it's possible to change the <code>chunk_flags</code>.<br />
* You can also use <code>gameplay_properties.xtbl</code> to apply these flags and change <code>gameplay_props</code>. If you're using the Terraform Patch a new <code>gameplay_prop</code> named <code>Invulnerable</code> is added which also can be used to make objects indestructible.<br />
* Eg: <code>dynamic_link invulnerable</code> will make the object indestructible. Full list of flags below:<br />
* child_gives_control: Unknown.<br />
* building: Unknown.<br />
* dynamic_link: Unknown.<br />
* world_anchor: Unknown.<br />
* no_cover: Might be where EDF can't take cover behind objects.<br />
* propaganda: EDF propaganda billboards you destroy for the achievement in singleplayer have this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows to track the players progress and reduce EDF control of the sector.<br />
* kiosk: <code>tech_kiosk_EDF_A</code> has this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows its a special object that plays propaganda videos.<br />
* touch_terrain: Unknown, no <code>gameplay_properties.xtbl</code> entries use this flag and it's missing from the table description.<br />
* supply_crate: EDF crates you destroy for the achievement in singleplayer have this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows to track the players progress.<br />
* mining: Ores you mine for salvage and the achievement in singleplayer have this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows to track the players progress.<br />
* one_of_many: Unknown, <code>windmill_0708</code>, <code>0102smokestack_86</code> & <code>0102smokestack_86_child</code> have this flag in <code>gameplay_properties.xtbl</code>. Might be related to one of the side activities where you have to destroy multiple targets.<br />
* plume_on_death: Unknown.<br />
* invulnerable: Makes an object indestructible.<br />
* inherit_damaga_pct: Unknown.<br />
* regrow_on_stream: Unknown.<br />
* casts_drop_shadow: Object will cast drop shadows.<br />
* disable_collapse_effect: Unknown.<br />
* force_dynamic: Unknown.<br />
* show_on_map: Most objects in <code>gameplay_properties.xtbl</code>. Most likely means the object will show on the minimap in singleplayer.<br />
* regenerate: Unknown.<br />
* casts_shadow: Object will cast a shadow map.<br />
<br />
==Object Info==<br />
* <code>obj_zone</code> = Defines the wind speed, terrain file name & <code>spawn_resource_data</code>. If you move its location the terrain will no longer have collision.<br />
* <code>MPST</code> = Multiplayer siege target.<br />
* <code>MPDCT</code> = Multiplayer damage control target.<br />
* <code>shape_cutter</code> = Causes object to start off with initial damage, used on damage control targets or maps like crash site, ruins & remnant where they put a hole in the wall.<br />
* <code>spawn_node</code> = Camera view at start of match and end of game. If a map doesn't have a least one of these it will crash.<br />
* <code>spectator_camera</code> = Camera view exclusively for players using the spectator mode, recommended to just ignore adding them and use <code>spawn_nodes</code> instead.<br />
* <code>trigger_region</code> = Killbox that can be set to a mine or cliff.<br />
* <code>rfg_mover</code> = Buildings, backpack racks & more.<br />
* <code>general_mover</code> = Explosive barrels and the <code>backpack_effect_attach.cchk_pc</code> objects for example.<br />
* <code>player_start</code> = Spawn point, can be set to Neutral, EDF or Guerilla.<br />
* <code>item</code> = In multiplayer the bag for bagman is set to <code>item_type</code> "multi_object_bagman_flag" and references <code>items_3d.xtbl</code>.<br />
* <code>weapon</code> = Weapon spawn, <code>weapon_type</code> determines which weapon will spawn and references <code>weapons.xtbl</code>.<br />
* <code>object_effect</code> = Visual effect, eg the fire on Nordic Bonus.<br />
* <code>multi_object_marker</code> = Multiple uses, in multiplayer the <code>marker_type</code> can be set to <code>Backpack rack</code>, <code>Spawn node</code>, <code>Flag capture zone</code>, <code>King of the Hill target</code>, <code>Siege target</code> & <code>Spectator camera</code>.<br />
* <code>cover_node</code> =<br />
* <code>navpoint</code> = Probably where NPCs can navigate, similar to navmeshes in other games.<br />
* <code>object_action_node</code> = <br />
* <code>object_squad_spawn_node</code> = Probably where squads spawn and references various <code>squads.xtbl</code> files.<br />
* <code>object_path_road</code> = Probably where NPCs can drive vehicles.<br />
* <code>object_guard_node</code> =<br />
* <code>object_vehicle_spawn_node</code> = Probably where vehicles can spawn like walkers found around the SP map.<br />
* <code>object_bounding_box</code> = Seems to be only be used in singleplayer, unknown why.<br />
* <code>object_activity_spawn</code> = Probably where you can start a side activity like demolition master for example.<br />
* <code>object_house_arrest_node</code> = Related to the house arrest side activity.<br />
* <code>object_patrol</code> = Probably where EDF patrol.<br />
* <code>object_dummy</code> =<br />
* <code>object_mission_start_node</code> = Probably where you can start a main mission.<br />
* <code>object_restricted_area</code> = Probably where the EDF will attack on sight and you will get an alert level in SP.<br />
* <code>backpack_effect_attach.cchk_pc</code> = Seems to be for attaching the backpack to the player when they spawn, DO NOT TOUCH IT ALL OR THE MAP WILL CRASH WHEN SPAWNING.<br />
<br />
==Object Properties==<br />
* <code>gameplay_props</code> references <code>gameplay_properties.xtbl</code>.<br />
* <code>backpack_type</code> references <code>mp_backpacks.xtbl</code>.<br />
* <code>weapon_type</code> references <code>weapons.xtbl</code>.<br />
* <code>item_type</code> references <code>items_3d.xtbl</code>.<br />
* <code>spawn_resource_data</code> references <code>spawn_resource.xtbl</code>.<br />
* <code>ambient_spawn</code> references <code>ambient_spawn_info.xtbl</code> or <code>dlc01_ambient_spawn_info.xtbl</code>.<br />
* <code>visual</code> references <code>effects.xtbl</code>.<br />
* <code>sound</code> references <code>foley.xtbl</code> (not included in the game for some reason) however there is <code>dlc01_foley.xtbl</code>.<br />
<br />
==Spawn Points==<br />
* <code>mp_team</code> can be set to <code>Neutral</code>, <code>EDF</code> or <code>Guerilla</code>.<br />
* When making a CTF map and you don't want players spawning at the opposing base ensure you disable the Flag <code>Spawn in CTF</code> for any Neutral spawn points.<br />
* Unknown if the <code>respawn</code> and <code>initial_spawn</code> booleans do anything in multiplayer.<br />
* <code>indoor</code> boolean is probably left over from Saints Row since all of RF:G is technically outdoors and no spawn points use this boolean.<br />
* <code>checkpoint_respawn</code> & <code>activity_respawn</code> are only used in singleplayer.<br />
* Foward X axis (blue line) determines player spawn direction.<br />
<br />
==Spawn Nodes==<br />
* Camera views at the start of match or when a player dies and is spectating.<br />
* Foward X axis (blue line) determines player camera direction & view.<br />
* If a map doesn't have at least one <code>Spawn node</code> it will crash when loading.<br />
<br />
==Spectator Cameras==<br />
* Believed to be similar to a <code>Spawn node</code> but used exclusively by players using the spectator option in matchmaking. Recommended to just ignore adding these since the community only plays custom games and adding <code>Spawn nodes</code> to your map will serve the same purpose.<br />
* Foward X axis (blue line) determines player camera direction & view.<br />
* These camera views are also shared with <code>Spawn nodes</code> at start of match or when a player dies and is spectating.<br />
<br />
==Mover Types==<br />
* Applies to <code>rfg_movers</code><br />
* When editing their properties it's possible to change the <code>mtype</code> field to the corresponding numbers<br />
* Fixed = 0 (default)<br />
* Normal = 1 (unknown)<br />
* Lite = 2 (unknown)<br />
* Ultra Lite = 3 (unknown)<br />
* World Only = 4 (no collision but you can still destroy it with a hammer for example)<br />
* No Collision = 5 (no collision)<br />
<br />
==Damage Control Targets==<br />
# Deep clone <code>MPDCT_MAPNAME_XXX</code>.<br />
# Move </code>MPDCT_MAPNAME_XXX</code> to the location of your choosing.<br />
# In object properties for the parent change <code>display_name</code> to whatever you want your new damage control objective to be called.<br />
# If you're making a map that doesn't already have a damage control target you can open it in another tab and use the deep clone feature. If you're using the Terraform Patch the majority of Wrecking Crew maps will already have the asset along with all Siege maps.<br />
# It's also possible to have only <code>1</code> target & more than <code>3</code>. The limit before the game will crash is a total of <code>6</code> targets when tested solo. The limit might be lower when played with other people but needs to be tested more.<br />
# It's also possible that using the same <code>display_name</code> name for each target can introduce instability.<br />
# The only valid value for the <code>mp_team</code> property is <code>Neutral</code>. If you change the team to <code>EDF</code> or <code>Guerilla</code> and disable the <code>shape_cutter</code> child so the target starts off intact it will belong to that team but not score any points until it's destroyed and repaired.<br />
# You can disable the <code>shape_cutter</code> child so the target starts off intact instead of destroyed like it is by default.<br />
# Any object can be used for a target if you add the <code>multi_object_marker</code>, <code>shape_cutter</code> and offset them correctly from the parent. See Stratosphere if using the Terraform Patch for how to do this; shipping containers are the targets added on that map in the patch.<br />
<br />
==Siege Targets==<br />
# Open a siege map in one tab, open a regular map with the same objects in another tab.<br />
# Deep clone the siege target to the regular map.<br />
# Move the added siege target to the exact same location as the existing matching object on the regular map.<br />
# Disable all the gamemode flags for the added siege target except for "Spawn in Siege" including its children.<br />
# Delete all the children of the siege targets (usually spawns that will be outside the map since they were deep cloned from the siege map), after they are all deleted make sure to "orphan children" of the child to ensure it doesn't have ghost children. <br />
# Disable the <code>Spawn in siege</code> flag on the matching original map object.<br />
# You need to update <code>mp_levels.xtbl</code> so the map is selectable in siege.<br />
# Ensure the siege target and its child have the persistent flag.<br />
# The <code>priority</code> property for the <code>Siege target</code> child determines which siege objects are unlocked to destroy, eg if you set it to <code>1</code> it would be the first target the attackers can destroy, you can have multiple targets unlocked by using the same number and if you wanted to have targets unlocked one at a time you would use <code>1</code>, <code>2</code>, <code>3</code> and so on. If you use a value of <code>4294967295</code> they are also unlocked at the same time.<br />
# You must use an existing string in the game for the <code>display_name</code> property on the child or the map will crash.<br />
# If you mess up the offset of the child the map will crash.<br />
<br />
==Backpack Racks==<br />
* Make sure you deep clone them when adding new racks, the child <code>Backpack rack</code> is required for it to work properly.<br />
* Ensure that when moving the rack to a new location you only move the parent (the child will follow and be offset correctly), they will be named <code>Jetpack</code> for example if you're using the Terraform Patch.<br />
* When editing the child <code>backpack_type</code> determines which backpack will spawn, most are the same as their in game names with the exception of Firepower <code>Commando</code> & Concussion <code>Shockwave</code>. These names are from <code>mp_backpacks.xtbl</code>.<br />
* When editing the child you can change the number of backpacks on a rack, edit <code>num_backpacks</code> and change it from a value ranging from <code>0-3</code>, although <code>0</code> would mean the rack is empty and useless.<br />
* When editing the child it's possible to make it team exclusive, this means only the EDF or Red Faction can pickup backpacks from that rack during team game modes. Edit <code>mp_team</code> and enter either <code>EDF</code> or <code>Guerilla</code>. In game that rack will have a green glow around it if your team can use it.<br />
* The <code>random_backpacks</code> boolean in the object properties for the <code>Backpack rack</code> child doesn't seem to do anything.<br />
* It's possible to make Backpack Racks destructable by changing <code>gameplay_props</code> to <code>Default</code>. During team game modes teams can fight for control by destroying racks and repairing them so only their team can use them. Racks you're able to use will glow green and racks you can't will glow red if you're using the Terraform Patch.<br />
* The maximum number of Backpack Racks you can have on a map before it causes issues is <code>25</code>.<br />
<br />
==Capture the Flag targets==<br />
* The EDF and Red Faction have their own unique flag stand placed near their team spawns on regular multiplayer maps.<br />
* Make sure you use deep cloning and only move the parent when placing or moving them so the child is offset correctly.<br />
* Objects are called <code>edf_flag_stand.cchk_pc</code> & <code>guerrilla_flag_stand.cchk_pc</code>.<br />
* If you attempt to add more than two stands to a map, the extras will not work as capture points and only the asset will appear.<br />
* <code>Neutral</code> is not a valid value for <code>mp_team</code>.<br />
<br />
==Bagman Objective Spawn==<br />
* Object is an <code>item</code> type referencing <code>items.3d_xtbl</code>.<br />
* Ignore the varying bounding box sizes when positioning the bag spawn, the XYZ axis position is what matters (the red, blue & green lines).<br />
* The <code>respawn</code> boolean doesn't do what you expect, the bag will still return to the original spawn point regardless if it's enabled or not.<br />
* You can't place more than one bag on a map normally, only one will spawn. However you can have different bag locations in Bagman and Team Bagman by using the gamemode flags.<br />
<br />
==Weapon Spawns==<br />
* You should clone other weapons to add new ones, if you make them from scratch and don't get the bounding box correct for certain weapons it can cause duplicate weapon spawns in some cases.<br />
* <code>weapon_type</code> determines which weapon will spawn and references <code>weapons.xtbl</code>.<br />
* The <code>preplaced</code> boolean needs more testing but you can disable weapons in certain game modes by disabling the game mode flags anyway.<br />
* The <code>respawns</code> boolean will cause the weapon to not re-spawn again during a match after it has been picked up for the first time.<br />
* Ensure the bounding box is slightly above the ground/floor when positioning weapons.<br />
<br />
==Trigger Regions==<br />
* In multiplayer & singleplayer these are used to prevent the player from going out of bounds.<br />
* <code>region_kill_type</code> can be set to a <code>cliff</code> or a <code>mine</code>. A cliff will cause the player to fall to their death, while a mine will explode and kill the player; this is also reflected in the killfeed message in multiplayer.<br />
* In singleplayer the <code>trigger_flags</code> can be changed so the trigger isn't enabled during missions and/or activities. Eg. <code>not_in_mission</code> will disable it during a main mission, <code>not_in_activity</code> would disable it during a side activity and <code>not_in_mission not_in_activity</code> would disable it during both.<br />
* The <code>enabled</code> boolean allows mappers to enable/disable the region.<br />
* The <code>trigger_shape</code> can be set to a <code>box</code> or <code>sphere</code>. However Nanoforge cannot render spherical bounding boxes yet.<br />
* <code>outer_radius</code> might control the size of the region, but this is untested.<br />
<br />
==Object Effects==<br />
* Plays an effect such as smoke, fire, explosion, sparks, etc. Also can play sounds if the effect has one in <code>effects.xtbl</code> and the sound string is used.<br />
* <code>sound_alr</code> = Unknown. <br />
* <code>sound</code> = The name of the sound in <code>effects.xtbl</code><br />
* <code>visual</code> = The name of the effect in <code>effects.xtbl</code><br />
* <code>looping</code> = Controls if the effect will play once or continuously.<br />
<br />
==Shape Cutters==<br />
* Used to damage or cut holes into destructible objects ahead of time.<br />
* <code>outer_radius</code> might control the size of the cutter, but this is untested.<br />
<br />
==Maps with names different from their in-game names==<br />
* wc1 - Complex<br />
* wc2 - Watchtower<br />
* wc3 - Scrapheap<br />
* wc4 - Vista<br />
* wc5 - Fortress<br />
* wc6 - Factory<br />
* wc7 - Gulch<br />
* wc8 - Cascade<br />
* wc9 - Transmission<br />
* wc10 - Pipeline<br />
* wcdlc1 - Ruins<br />
* wcdlc2 - Repercussion<br />
* wcdlc3 - Imperial<br />
* wcdlc4 - Expansion<br />
* wcdlc5 - Frost<br />
* wcdlc6 - Abandoned<br />
* wcdlc7 - Stratosphere <br />
* wcdlc8 - Invasion<br />
* wcdlc9 - Nordic Bonus<br />
* mpcx_crossover - Doubletime<br />
* mpcx_assembly - Outpost <br />
* mpdlc_landbridge - Equilibrium<br />
* mpdlc_islands - Haven<br />
* mpdlc_minibase - Complex<br />
* mpdlc_overhang - Gradient<br />
* mpdlc_ruins - Remnant<br />
<br />
==Maps with similar terrain==<br />
* Crash Site/Complex/Nordic Bonus<br />
* Rift/Factory<br />
* Remnant/Ruins<br />
* Broadside/Invasion<br />
* Wasteland/Gulch<br />
* Outpost/Framework<br />
* Radial/Transmission<br />
* Sand Pit/Division/Watchtower<br />
* Tutorial Area/Pipeline<br />
* Pinnacle/Fortress<br />
<br />
==Misc Notes==<br />
* Deep clone objects if you want to keep the children of an object and use regular clone if you just want to clone the parent. Only move the parent when deep cloning and the children will follow and be offset correctly.<br />
* If you see anything that looks like XML inside <code>layer_pc</code> or <code>rfgzone_pc</code> files you can ignore that as we're 99% sure it's junk from their file packer reusing memory without zeroing it out.<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail.<br />
<br />
===Localization strings===<br />
While Nanoforge is only in English at the moment it can view localized strings used by RFG. RFG uses placeholder strings in many xtbls which are replaced with their localization at runtime. These are shown automatically in the xtbl editor. You can also view a list of all localized strings via <code>Tools > Localization > View localized strings</code>. You can search by placeholder by checking "Search by identifier". You must fully enter the identifier without typos for this to work since it's comparing it to a hash of the identifier stored in the games localization files.<br />
<br />
[[File:Nanoforge_LocalizedStringList0.png|frameless|768px]]<br />
<br />
===Scriptx viewer===<br />
RFG uses an xml based scripting system called scriptx for some mission logic. The viewer is an attempt at making it easier to read scriptx files which can be difficult to understand. It's a low priority feature so it likely won't see changes for a while but was enabled in case it's useful to people editing scriptx files. You still need to edit them by hand but it can help make it clearer what a script is doing. You can access it via <code>View > Scriptx Viewer (WIP)</code>.<br />
<br />
[[File:Nanoforge_ScriptxViewer0.png|frameless|768px]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Editing_Main_Page&diff=8964RF:G Editing Main Page2023-06-21T04:31:52Z<p>Camo: /* Tutorials */</p>
<hr />
<div>{{RFGEditing}}<br />
{{Under construction}}<br />
<br />
This will serve as a landing page for all resources related to [[Red Faction: Guerrilla]] editing for the '''Re-Mars-tered Edition'''.<br />
<br />
==External Links==<br />
===Community===<br />
*[https://discord.gg/factionfiles Faction Files Community Discord] - Active Red Faction series community Discord with #map-mod-development channel for community development discussion<br />
===Downloads===<br />
*[https://www.factionfiles.com/ff.php?action=files FactionFiles.com] - Custom mods, tools, patches, and reference material<br />
*[https://www.nexusmods.com/redfactionguerilla/mods/ Nexus Mods] - Custom mods<br />
*[https://www.nexusmods.com/redfactionguerrillaremarstered/mods/ Nexus Mods Re-Mars-tered] - Custom mods<br />
<br />
==Documentation==<br />
*[[RF:G Map organization]]<br />
*[[Nanoforge basics]]<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail<br />
===Core Concepts===<br />
*[[Red Faction: Guerrilla]]'s level editor is [[CLOE]], which is not publicly available.<br />
<br />
===Red Faction: Guerrilla File Formats===<br />
* <code>.xtbl</code> - XML table files are used to store properties or attributes in Red Faction: Guerrilla. Overall, their function is similar to the <code>.tbl</code> files of Red Faction and Red Faction II.<br />
* <code>.scriptx</code> - Internal script engine file, commonly used for missions and activities<br />
* <code>.dtodx</code> - Weather/lighting file for maps that controls things like fog, tint, ambient colour, eye adaption, bloom, cloud color and speed<br />
* <code>.gtodx</code> - Skybox file for maps that controls things like the sun texture, moon positions and if the horizon mountain texture is enabled<br />
* <code>.vpp_pc</code> - Packfile<br />
* <code>.rigx</code> - Rig<br />
* <code>.str2_pc</code> - Texture Packfile<br />
* <code>.rfgzone_pc</code> - Map zone<br />
* <code>.layer_pc</code> - Map zone<br />
* <code>.cpeg_pc, cvbm_pc</code> - Texture cpu file<br />
* <code>.gpeg_pc, gvbm_pc</code> - Texture gpu file<br />
* <code>.asm_pc</code> - Streaming index<br />
* <code>.csmesh_pc</code> - Static mesh cpu file<br />
* <code>.gsmesh_pc</code> - Static mesh gpu file<br />
* <code>.ccmesh_pc</code> - Character mesh cpu file<br />
* <code>.gcmesh_pc</code> - Character mesh gpu file<br />
* <code>.ccar_pc</code> - Vehicle mesh cpu file<br />
* <code>.gcar_pc</code> - Vehicle mesh gpu file<br />
* <code>.anim_pc</code> - Animation<br />
* <code>.cchk_pc</code> - Destructible object cpu file<br />
* <code>.gchk_pc</code> - Destructible object gpu file<br />
* <code>.cefct_pc</code> - Visual effect cpu file<br />
* <code>.gefct_pc</code> - Visual effect gpu file<br />
* <code>.cfmesh_pc</code> - Foliage mesh<br />
* <code>.cstch</code> - Terrain clutter mesh cpu file<br />
* <code>.gstch</code> - Terrain clutter mesh gpu file<br />
* <code>.cterrain_pc</code> - Terrain zone cpu file<br />
* <code>.gterrain_pc</code> - Terrain zone gpu file<br />
* <code>.ctmesh_pc</code> - Terrain subzone cpu file<br />
* <code>.gtmesh_pc</code> - Terrain subzone gpu file<br />
* <code>.fsmib</code> - Fullscreen map data<br />
* <code>.fxo_kg</code> - Shader<br />
* <code>.le_strings</code> - Steam localization strings<br />
* <code>.rfglocatext</code> - Localization strings<br />
* <code>.mat_pc</code> - Render material<br />
* <code>.morph_pc</code> - Animation Morph<br />
* <code>.vint_doc</code> - UI<br />
* <code>.sim_pc</code> - Cloth sim<br />
* <code>.xgs_pc</code> - Sound config<br />
* <code>.xsb_pc</code> - Soundbank<br />
* <code>.xwb_pc</code> - Wavebank<br />
* <code>.aud_pc</code> - Audio categories<br />
* <code>.vf3_pc</code> - Font<br />
* <code>.vfdvp_pc</code> - ?<br />
* <code>.rfgvp_pc</code> - ?<br />
<br />
===Red Faction: Guerrilla File Structure===<br />
<br />
\Red Faction Guerrilla Re-MARS-tered\data\<br />
<br />
The two most important files for modding most of RF:G are <code>misc.vpp_pc</code> & <code>table.vpp_pc</code><br />
<br />
* <code>activities.vpp_pc</code> - contains textures for singleplayer activities<br />
* <code>anims.vpp_pc</code> - contains animation files<br />
* <code>chunks.vpp_pc</code> - contains <code>.rfgchunkx</code> files and seems to be related to the <code>preload_chunks.xtbl</code> file, it's possible to add them to a map using the correct <code>dest_checksum</code> & <code>uid</code> numbers. Game might also spawn <code>missing_chunk</code> or <code>missing_destroyable</code> if a mesh fails to load.<br />
* <code>cloth_sim.vpp_pc</code> - contains cloth simulation files<br />
* <code>decals.vpp_pc</code> - contains decal textures<br />
* <code>dlc01_l0.vpp_pc</code> - singleplayer DLC map<br />
* <code>dlc01_l1.vpp_pc</code> - only contains a blank <code>asm_pc</code> file<br />
* <code>dlc01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer DLC map<br />
* <code>dlcp01_activities.vpp_pc</code> - contains textures for singleplayer DLC activities<br />
* <code>dlcp01_anims.vpp_pc</code> - contains animation files for singleplayer DLC<br />
* <code>dlcp01_cloth_sim.vpp_pc</code> - contains cloth simulation files for singleplayer DLC<br />
* <code>dlcp01_effects.vpp_pc</code> - contains visual effect files for singleplayer DLC, some are <code>.str2</code><br />
* <code>dlcp01_humans.vpp_pc</code> - contains textures and meshes for characters in singleplayer DLC<br />
* <code>dlcp01_interface.vpp_pc</code> - contains textures for loading screens & thumbnails in singleplayer DLC<br />
* <code>dlcp01_items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in singleplayer DLC<br />
* <code>dlc01_misc.vpp_pc</code> - contains <code>.rig_pc</code> files, the <code>.fsmib</code> file and two <code>.xtbl</code> files for singleplayer DLC<br />
* <code>dlc01_missions.vpp_pc</code> - contains textures related to singleplayer DLC missions<br />
* <code>dlcp01_personas_en_us.vpp_pc</code> - <br />
* <code>dlcp01_vehicles.vpp_pc</code> - contains textures and meshes for singleplayer DLC vehicles<br />
* <code>dlcp01_voices_en_us.vpp_pc</code> -<br />
* <code>dlcp02_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for multiplayer DLC<br />
* <code>dlcp02_misc.vpp_pc</code> - <br />
* <code>dlcp03_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for wrecking crew DLC<br />
* <code>dlcp03_misc.vpp_pc</code> -<br />
* <code>effects.vpp_pc</code> - contains visual effect files, some are <code>.str2</code><br />
* <code>effects_mp.vpp_pc</code> - contains multiplayer only visual effect files, some are <code>.str2</code><br />
* <code>humans.vpp_pc</code> - contains textures and meshes for characters in both singleplayer and multiplayer<br />
* <code>interface.vpp_pc</code> - contains textures for loading screens & thumbnails in both SP and MP and character portraits in multiplayer<br />
* <code>items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in both singleplayer & multiplayer<br />
* <code>items_mp.vpp_pc</code> - contains multiplayer only textures and meshes<br />
* <code>misc.vpp_pc</code> contains <code>.xtbl</code> files and most other file types<br />
* <code>missions.vpp_pc</code> - contains textures for singleplayer missions<br />
* <code>mp_common.vpp_pc</code> - contains textures shared between multiplayer maps<br />
* <code>mp_xxx.vpp_pc</code> - multiplayer maps, excluding <code>mp_common.vpp_pc</code><br />
* <code>mpdlc_xxx.vpp_pc</code> - DLC multiplayer maps<br />
* <code>personas_de_de.vpp_pc</code> -<br />
* <code>personas_en_us.vpp_pc</code> - <br />
* <code>personas_es_es.vpp_pc</code> - <br />
* <code>personas_fr_fr.vpp_pc</code> -<br />
* <code>personas_it_it.vpp_pc</code> -<br />
* <code>personas_ru_ru.vpp_pc</code> -<br />
* <code>rfg_cine_00a.bik_xbox2</code> -<br />
* <code>rfg_cine_01a.bik_xbox2</code> -<br />
* <code>rfg_cine_02a.bik_xbox2</code> -<br />
* <code>rfg_cine_03a.bik_xbox2</code> - <br />
* <code>rfg_cine_03b.bik_xbox2</code> - <br />
* <code>rfg_cine_04a.bik_xbox2</code> - <br />
* <code>rfg_cine_05a.bik_xbox2</code> - <br />
* <code>rfg_cine_06a.bik_xbox2</code> - <br />
* <code>skybox.vpp_pc</code> - contains textures for the skybox like the clouds<br />
* <code>sounds_r.vpp_pc</code> - contains <code>.xmb_pc</code> sound files<br />
* <code>steam.vpp_pc</code> -<br />
* <code>table.vpp_pc</code> - contains only <code>.xtbl</code> files and will overwrite <code>.xtbl</code> files in <code>misc.vpp_pc</code><br />
* <code>terr01_l0.vpp_pc</code> - singleplayer map<br />
* <code>terr01_l1.vpp_pc</code> - singleplayer map<br />
* <code>terr01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer map<br />
* <code>vehicles_r.vpp_pc</code> - contains textures and meshes for singleplayer vehicles<br />
* <code>voices_de_de.vpp_pc</code> - <br />
* <code>voices_en_us.vpp_pc</code> - <br />
* <code>voices_es_es.vpp_pc</code> - <br />
* <code>voices_fr_fr.vpp_pc</code> - <br />
* <code>voices_it_it.vpp_pc</code> - <br />
* <code>voices_ru_ru.vpp_pc</code> -<br />
* <code>wcxxx.vpp_c</code> - wrecking crew maps<br />
* <code>zonescript_dlc01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer DLC map<br />
* <code>zonescript_terr01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer map<br />
* <code>xxx.bik</code> - pre-rendered custscenes<br />
<br />
===Scriptx Functions===<br />
<br />
* [https://www.factionfiles.com/ff.php?action=scriptxfuncs .scriptx functions]<br />
<br />
===Primitive data types & limits===<br />
<br />
* Floats (floating decimal points): Max value <code>3.4028237</code> and move the decimal place right 38 times. Examples: <code>1.0, 0.0</code><br />
* Integer (whole number that could hold a zero, positive or negative value): Max value <code>2147483647</code><br />
* Boolean (truth value with two constants objects True and False , basically a toggle to enable or disable something using "true" or "false"): Examples: <code><Unlocks_Cheat>True</Unlocks_Cheat>, <Unlocks_Cheat>False</Unlocks_Cheat></code><br />
* String (represents a sequence or characters/text): Example: <code><string>OldCoot</string></code><br />
<br />
===sounds_r.vpp_pc Info===<br />
<br />
* S16 = Signed 16 bit<br />
* LE = Little endian<br />
* 2CH = 2 channels (stereo)<br />
<br />
* destruction.xwb_pc - unknown<br />
* dlc01_voc_d01offcam.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01dan.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm02.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm03.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm04.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm05.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm06.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01rfc.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01sam_pcm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01vasha_safe.xwb_pc.en_us.xwb_pc - unknown <br />
* mov_foley.xwb_pc - unknown <br />
* mov_jet_pack.xwb_pc - unknown <br />
* mov_male.xwb_pc - unknown <br />
* mov_npc_male.xwb_pc - unknown <br />
* mp_backpacks.xwb_pc - S16, LE, 2CH. Intermittent static starting ~28sec <br />
* mp_wep.xwb_pc - S16, LE, 2CH. Static at start and end <br />
* mus_briefings.xwb_pc - S16, LE, 2CH. <br />
* mus_demomaster.xwb_pc - S16, LE, 2CH. <br />
* mus_frontend.xwb_pc - S16, LE, 2CH. <br />
* mus_multiplayer.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_01.xwb_pc - S16, LE, 2CH. Static at start, may be header <br />
* mus_progression_02.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_03.xwb_pc - S16, LE, 2CH. <br />
* mus_sting.xwb_pc - S16, LE, 2CH. <br />
* obj_shared_ambient.xwb_pc - unknown<br />
* obj_shared_dth.xwb_pc - unknown <br />
* obj_shared_exp.xwb_pc - unknown<br />
* obj_shared_impact.xwb_pc - unknown <br />
* scripted_raids.xwb_pc - unknown <br />
* system.xwb_pc - S16, LE, 2CH. Mostly static, valid sound in middle <br />
* system_mp.xwb_pc - unknown <br />
* veh_civ_bus.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car1.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car2.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car3.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_flat.xwb_pc - unknown <br />
* veh_civ_flat2.xwb_pc - unknown<br />
* veh_civ_fuel.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_hauler.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_taxi.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_trash.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_walker.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_aax.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_abx.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_apc.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_atank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_htank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_mtank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_scout.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staff.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staffh2h.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_raider.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_atv.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_bull.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_dtruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_etruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_pickup.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_rover.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_roverwk.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supplyrt.xwb_pc - unknown<br />
* veh_min_wlklg.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_wlkmd.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_shared.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* walla.xwb_pc - unknown<br />
* weather.xwb_pc - S16, LE, 2CH.<br />
* wep_rfg.xwb_pc - S16, LE, 2CH. Mostly valid, some static<br />
<br />
===RfgUtil Guide===<br />
<br />
* Unpacking [Placeholder]<br />
* Repacking [Placeholder]<br />
* Command arguments [Placeholder]<br />
* Scripts [Placeholder]<br />
* Updating <code>.asm_pc</code> files [Placeholder]<br />
<br />
===Misc Notes===<br />
<br />
* When repacking <code>.vpp_pc</code> files don't compress and/or condense them if they weren't like that in the vanilla game, it will cause the game to crash. Eg: <code>items.vpp_pc</code>, <code>interface.vpp_pc</code>, map files etc. See the table below:<br />
* <code>table.vpp_pc</code> overwrites changes to <code>.xtbl</code> files in <code>misc.vpp_pc</code>. The work around for this with the legacy mod manager is to rename the file however this breaks multiplayer and reduces the stability of the game. You should edit the same <code>.xtbl</code> files in both <code>misc.vpp_pc</code> & <code>table.vpp_pc</code>.<br />
<br />
{| class="wikitable"<br />
|+<br />
|-<br />
! Filename !! Alignment !! Compressed !! Condensed<br />
|-<br />
| ALL .str2 || 0 || Yes || Yes<br />
|-<br />
| MOST .vpp_pc || 2048 || No || No<br />
|-<br />
| dlc01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlcp01_misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| mp_common.vpp_pc || 2048 || Yes || No<br />
|-<br />
| steam.vpp_pc || 2048 || Yes || No<br />
|-<br />
| terr01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_dlc01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_terr01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlc01_l1.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp01_voices_en_us.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp02_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| dlcp03_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| anims.vpp_pc || 16 || Yes || Yes<br />
|-<br />
| table.vpp_pc || 64 || Yes || Yes<br />
|-<br />
| skybox.vpp_pc || 4096 || No || No<br />
|-<br />
| dlcp01_personas_en_us.vpp_pc || 4096 || No || No<br />
<br />
|}<br />
<br />
===Red Faction: Guerrilla Tools===<br />
<br />
* [https://github.com/Moneyl/RfgUtil/releases RfgUtil] - Used for unpacking most file formats and updating <code>.asm_pc</code> files<br />
* [https://github.com/Moneyl/Nanoforge/releases Nanoforge C++] - Map editor, texture editor, <code>.xtbl</code> editor and more<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/mTools.zip mTools] - Drag and drop tool to convert <code>.asm_pc</code> files to XML and vice versa<br />
* [https://github.com/rsl-dev/RSL/releases RSL] - Script Loader<br />
* [https://github.com/Moneyl/AsmTool AsmTool]- WIP Tool for modifying <code>.asm_pc</code> files used by Red Faction Guerrilla. This is meant to replace hand editing them, which is very error prone and tedious<br />
* [https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe SyncFaction] - WIP tool for automatically installing the Terraform Patch and eventually replacing the old mod manager<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5686 xdelta UI] - GUI for generating <code>.xdelta</code> (binary) patches<br />
* [https://www.w3schools.com/xml/xml_validator.asp XML Validator] - Use this to validate <code>.xtbl</code> edits, any mistakes you make will crash the game<br />
* [https://jsonformatter.org/xml-formatter XML Formatter] - Use this to format <code>.xtbl</code> files so they are easier to read<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5995 Mod Manager Re-mars-tered v1.03] - Legacy mod manager<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/Volition_Table_File_Editor.zip Volition Table File Editor] - GUI for editing <code>.xtbl</code> files<br />
* [https://onecompiler.com/lua/3ykpyrhhb LUA Validator] - Useful for validating RSL scripts for errors, note it's safe to ignore <code>attempt to index a nil value (global 'rfg')</code><br />
<br />
===Useful Software===<br />
<br />
* [https://www.voidtools.com/ Voidtools Everything] - Locate files and folders by name instantly<br />
* [https://www.mythicsoft.com/agentransack/ Agent Ransack] - Bulk search for keywords within unpacked files<br />
* [https://notepad-plus-plus.org/downloads/ Notepad++] - Good text editor for manually editing <code>.xtbl</code> files, set language as XML<br />
<br />
==Tutorials==<br />
*[[Nanoforge basics]] - Introduction to Nanoforge and its features.<br />
*[[Nanoforge xtbl editing]] - How to edit [[.xtbl]] files in Nanoforge.<br />
*[[Nanoforge Texture Editing]] - How to edit textures using Nanoforge.<br />
* XTBL Editing Guides [Placeholder]<br />
<br />
<br />
[[Category: Red Faction: Guerrilla]]<br />
[[Category: RF:G Editing]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=Nanoforge_basics&diff=8963Nanoforge basics2023-06-21T04:29:00Z<p>Camo: /* Shape Cutters */</p>
<hr />
<div>{{RFGEditing}}<br />
{{Under construction}}<br />
<br />
This page goes over how to install Nanoforge and it's basic features. This article only goes over the basics of each feature. See the other guides for more detailed explanations.<br />
<br />
==Installation==<br />
===Download===<br />
Nanoforge releases are posted on [https://github.com/Moneyl/Nanoforge/releases github]. Multiple releases will be listed. You should always download the most recent release. To download it, look for the <code>▸Assets</code> button(1), click it, and download the first zip file listed under it(2).<br />
<br />
[[File:NanoforgeDownloadStepsAnnotated.png|frameless|768px]]<br />
<br />
===Install===<br />
*Unpack the zip file you downloaded anywhere and run Nanoforge.exe<br />
*You should now see the start screen. On the left side it has the data path and the recent projects list. On the right it has the changelog. Nanoforge with attempt to auto detect your RFG install. If it says that your data path is invalid click the <code>Browse...</code> button and select your RFG data folder.<br />
<br />
==Features==<br />
This section gives a quick rundown of each of Nanoforge's features.<br />
<br />
===Projects===<br />
Nanoforge uses projects to track edits made to game files. The idea is to use a single project per mod. You only need to create a project if you're editing files. You don't need one to view and export files. To create a new project click <code>New project</code> in the start page or <code>File > New project...</code> on the main menu bar. Fill out all the info on the popup and click <code>Create</code>. Below are each of the fields to fill in:<br />
*Name: The name of the project. Used to name the project file and as the name in any modinfo.xml files it generates.<br />
*Path: Path to the folder that the project should be created in.<br />
*Description: (Optional) Description of what the mod is. Used in the description field of modinfo.xml.<br />
*Author: (Optional) Author(s) of the mod. Used in the author filed of modinfo.xml.<br />
*Create project folder: If unchecked then the project files are placed directly in the folder chosen for path. If checked a folder with the entered name will be created in that folder.<br />
<br />
===File explorer===<br />
The file explorer lets you view the contents of vpp_pc and str2_pc files without extracting them manually. You can double click supported file formats like textures to open them. If you single click a vpp_pc or str2_pc file it will expand to show it's contents. Extra info about the file will be shown in the properties panel for some files when single clicking them.<br />
<br />
[[File:Nanoforge ProjectCreationExample3.png|frameless|256px]]<br />
<br />
====Search====<br />
You can use the search bar to limit which files are shown in the file explorer. By default it will only show files with names that contain the search term. You can also use some special characters to specialize your search behavior:<br />
*Start your search with *: Will only show files with names that end with whatever comes after *<br />
*End your search with *: Will only show files with names that start with whatever comes before *<br />
<br />
If you prefer regex you can check the regex search option. Note that the regex search option is much slower than the default one.<br />
<br />
===Properties panel===<br />
The properties panel sometimes will show additional info about files selected in the file explorer. It also may be used by other UI panels to show additional info. For example, it can list object properties when viewing territories (see map viewing section below).<br />
<br />
[[File:Nanoforge_PropertiesPanel2.png|frameless|256px]]<br />
<br />
===Textures===<br />
You can open texture files by double clicking them in the file explorer. Textures are split into two files. Either a cpeg_pc and gpeg_pc file pair or a cvbm_pc and gvbm_pc file pair. You can double click any of these to open a texture. A single RFG texture file can contain multiple textures, which we'll refer to as subtextures. Info about the selected subtexture will be shown below the subtexture list.<br />
<br />
[[File:Nanoforge_TextureDocument.png|frameless|768px]]<br />
<br />
Above is an example of what you might see if you open a texture file. On the sidebar to the left there a few things, in order:<br />
*The subtexture list. Click on one to see more info about it below.<br />
*Texture info. This is info about the selected subtexture.<br />
*Header info. This is general info about the cpeg/cvbm file.<br />
<br />
====Exporting textures====<br />
Textures can be exported to files you can edit with common image editors like Paint.NET, GIMP, or Photoshop. Currently textures can only be exported as .dds files. You can export single subtextures by right clicking one of them and clicking <code>Export...</code>. You can export all subtextures at once with the <code>Export all...</code> button.<br />
<br />
====Editing textures====<br />
Textures can be edited by imported textures you've edited externally. Currently it can only import .dds files. You do this by right clicking a subtexture, clicking <code>Replace...</code> and selecting the file you want to replace the subtexture with. Once you do this it's critical that you press the <code>Save</code> button above the subtexture list to save your edit. This edit will be automatically saved to your current project when you click <code>Save</code>. See [[Nanoforge Texture Editing]] for more info.<br />
<br />
===Meshes===<br />
Nanoforge supports viewing and exporting .csmesh_pc (static mesh) and .ccmesh_pc (character mesh) files. Just like textures, meshes consist of two files. Every csmesh_pc file is paired with a gsmesh_pc file, and every ccmesh_pc file is paired with a gcmesh_pc file. You can click any of them to open a mesh. When you open a mesh you'll first see a blank space. Meshes are loaded on a background thread so it may take a few seconds for the mesh to be loaded and for it's textures to show up. Before its textures are found or if the textures cant be found you might see textures from previously loaded meshes applied to the mesh.<br />
<br />
[[File:Nanoforge_MeshDocument.png|frameless|512px]]<br />
<br />
Above is what you might see if you open a mesh file. There's a few parts of the UI to note, in order:<br />
* The camera button. This lets you control camera settings like speed and location. You can move the camera by holding down the right mouse button and using WASD to move around. If this doesn't work try left clicking on the mesh 3D view. Only the most recently selected mesh reacts to camera controls so if you have several open it'll only move one camera.<br />
* The scene button. This has some rendering settings for the mesh such as scale and lighting color/intensity.<br />
* The info button. This shows some additional info about the mesh such as vertex format, and the LOD slider for meshes with multiple levels of detail.<br />
* The export button. This lets you export the mesh and it's textures to a .obj file, which can be imported into tools like blender.<br />
* The status bar. This shows the loading status and percentage. It will show <code>Done! ✓</code> once loading is complete.<br />
<br />
====Exporting meshes====<br />
To export a mesh:<br />
* Wait for it to finish loading. The status bar will show <code>Done! ✓</code> and 100%.<br />
* Click the export button. Top left of the document, button furthest to the right.<br />
* Select a folder to export the mesh and it's textures to and click <code>Export</code>.<br />
<br />
A single gltf file and the meshes textures will be exported. Each lod level is labelled in the gltf under their own subnode. Currently these gltf files don't look right as is when imported into Blender. This is because GLTF uses a different rendering model than RFG. Typically meshes have a diffuse, specular, and normal texture. Their names end with _d, _s, and _n respectively. You'll need to make the following changes to the textures in the Blender shading tab:<br />
* Diffuse -> Set color space to linear, attach texture color to "Base Color" on the BSDF<br />
* Specular -> Set color space to linear, attach texture color to "Specular" on the BSDF<br />
* Normal -> Set color space to SRGB, attach texture color to "Normal" on the BSDF<br />
<br />
In the near future an extension will be made to automatically patch the shader graph.<br />
<br />
====Camera movement====<br />
To move the camera hold down the right mouse button over the 3D view and use WASD to move around. Holding down shift while moving will cause the camera to move faster. Pressing Q and E will move the camera directly up and directly down respectively.<br />
<br />
===Mod packaging===<br />
Once you're done editing textures you can use Nanoforge to repack the editing files and generate a modinfo.xml for you. To do this, simply click <code>File > Package mod</code> on the main menu bar. Once it's done go to the "Output" folder inside your project folder to see the modinfo.xml and any files that it relies on. These are ready for use with the re-mars-tered mod manager.<br />
<br />
===Map view===<br />
Nanoforge has partial support for viewing maps like the main campaign map. We'll be referring to them as territories as that's how RFG groups together many zones. See [[RF:G Map organization]] for more details on how RFG maps are structured. To open a territory via <code>Tools > Open territory</code> on the main menu bar. Terr01 is the main campaign map territory. A new document should appear when you open a new territory. Camera movement is the same as the mesh viewer. See [[#Camera_movement|camera movement]]. Terrain is loaded in the background so you'll see separate blocks of terrain pop into view as they load. Bounding boxes are drawn for zone objects. With a territory open you should see new information on the zone panel and the zone objects panel. You can dock panels by clicking and dragging on their titles. It's recommended that you dock the zone object list below the zone list so you can see both at once.<br />
<br />
Below is an annotated image of information you can view about territories plus descriptions for each annotation.<br />
<br />
[[File:Nanoforge_W3p0erDiTj.jpg|frameless|1024px]]<br />
<br />
* First, in the top left is the zone list. Territories are made up of one or more zones which in turn have many zone objects. Click a zone to see its object in the zone objects panel (bottom left). By default the zone with the most objects is selected. In this case that's <code>04_06</code>. Note that each zone corresponds to a rfgzone_pc file. So, for example, <code>04_06</code> is really terr01_04_06.rfgzone_pc.<br />
* Next, bottom left is the zone objects list. This lists the objects inside the selected zone. Click an object to see its properties in the properties panel. Some objects have child objects, denoted by having a triangle in front of their name which you can click to expand them. You can filter objects by type inside the filters header. By default some very common objects like navpoints are hidden.<br />
* Finally, in the top right is the properties panel. This shows the properties of the selected zone object.<br />
<br />
==Object Flags==<br />
* Flag 0 (Persistent): Unknown, any objects with this flag have a separate copy stored in a second <code>rfgzone_pc</code> file with its name prefixed with <code>p__.</code> So, for example, Crescent has two <code>rfgzone_pc</code> files. <code>mp_crescent.rfgzone_pc</code> and <code>p_mp_crescent.rfgzone_pc</code>. The objects with the persistent flag are stored in both zone files, while objects without that flag are only stored in <code>mp_crescent.rfgzone_pc</code>. It's consistently used on player spawns, on most siege objectives and on most <code>rfg_movers</code> on Siege maps. It's recommended you don't enable or disable this flag on maps if you're using the Terraform Patch as it contains fixes for missing objects that incorrectly used this flag or were missing it; doing so will cause objects to vanish.<br />
* Flag 1: Unknown<br />
* Flag 2: Unknown <br />
* Flag 3: Unknown; might be related to how the game saves/loads map data from save files (requires more investigation)<br />
* Flag 4: Unknown; seems to always get converted to the runtime flag <code>streaming_fixed</code>, most <code>rfg_movers</code> and <code>general_movers</code> have this flag. If you're using the Terraform Patch it's recommended you don't disable this flag as it applies it to all objects since it was used most of the time and objects missing it were assumed to be an error by Volition. (They also made mistakes with the gamemode and persistent flags)<br />
* Flag 5: Unknown; seems to get converted to the runtime flag <code>force_full_save</code><br />
* Flag 6: Unknown<br />
* Flag 7: Unknown<br />
* Flag 8: Spawns in Anarchy<br />
* Flag 9: Spawns in Team Anarchy<br />
* Flag 10: Spawns in CTF<br />
* Flag 11: Spawns in Siege<br />
* Flag 12: Spawns in Damage Control<br />
* Flag 13: Spawns in Bagman<br />
* Flag 14: Spawns in Team Bagman<br />
* Flag 15: Spawns in Demolition<br />
<br />
==Chunk Flags==<br />
* Applies to <code>rfg_movers</code> & <code>general_movers</code>.<br />
* When editing their properties in the inspector it's possible to change the <code>chunk_flags</code>.<br />
* You can also use <code>gameplay_properties.xtbl</code> to apply these flags and change <code>gameplay_props</code>. If you're using the Terraform Patch a new <code>gameplay_prop</code> named <code>Invulnerable</code> is added which also can be used to make objects indestructible.<br />
* Eg: <code>dynamic_link invulnerable</code> will make the object indestructible. Full list of flags below:<br />
* child_gives_control: Unknown.<br />
* building: Unknown.<br />
* dynamic_link: Unknown.<br />
* world_anchor: Unknown.<br />
* no_cover: Might be where EDF can't take cover behind objects.<br />
* propaganda: EDF propaganda billboards you destroy for the achievement in singleplayer have this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows to track the players progress and reduce EDF control of the sector.<br />
* kiosk: <code>tech_kiosk_EDF_A</code> has this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows its a special object that plays propaganda videos.<br />
* touch_terrain: Unknown, no <code>gameplay_properties.xtbl</code> entries use this flag and it's missing from the table description.<br />
* supply_crate: EDF crates you destroy for the achievement in singleplayer have this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows to track the players progress.<br />
* mining: Ores you mine for salvage and the achievement in singleplayer have this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows to track the players progress.<br />
* one_of_many: Unknown, <code>windmill_0708</code>, <code>0102smokestack_86</code> & <code>0102smokestack_86_child</code> have this flag in <code>gameplay_properties.xtbl</code>. Might be related to one of the side activities where you have to destroy multiple targets.<br />
* plume_on_death: Unknown.<br />
* invulnerable: Makes an object indestructible.<br />
* inherit_damaga_pct: Unknown.<br />
* regrow_on_stream: Unknown.<br />
* casts_drop_shadow: Object will cast drop shadows.<br />
* disable_collapse_effect: Unknown.<br />
* force_dynamic: Unknown.<br />
* show_on_map: Most objects in <code>gameplay_properties.xtbl</code>. Most likely means the object will show on the minimap in singleplayer.<br />
* regenerate: Unknown.<br />
* casts_shadow: Object will cast a shadow map.<br />
<br />
==Object Info==<br />
* <code>obj_zone</code> = Defines the wind speed, terrain file name & <code>spawn_resource_data</code>. If you move its location the terrain will no longer have collision.<br />
* <code>MPST</code> = Multiplayer siege target.<br />
* <code>MPDCT</code> = Multiplayer damage control target.<br />
* <code>shape_cutter</code> = Causes object to start off with initial damage, used on damage control targets or maps like crash site, ruins & remnant where they put a hole in the wall.<br />
* <code>spawn_node</code> = Camera view at start of match and end of game. If a map doesn't have a least one of these it will crash.<br />
* <code>spectator_camera</code> = Camera view exclusively for players using the spectator mode, recommended to just ignore adding them and use <code>spawn_nodes</code> instead.<br />
* <code>trigger_region</code> = Killbox that can be set to a mine or cliff.<br />
* <code>rfg_mover</code> = Buildings, backpack racks & more.<br />
* <code>general_mover</code> = Explosive barrels and the <code>backpack_effect_attach.cchk_pc</code> objects for example.<br />
* <code>player_start</code> = Spawn point, can be set to Neutral, EDF or Guerilla.<br />
* <code>item</code> = In multiplayer the bag for bagman is set to <code>item_type</code> "multi_object_bagman_flag" and references <code>items_3d.xtbl</code>.<br />
* <code>weapon</code> = Weapon spawn, <code>weapon_type</code> determines which weapon will spawn and references <code>weapons.xtbl</code>.<br />
* <code>object_effect</code> = Visual effect, eg the fire on Nordic Bonus.<br />
* <code>multi_object_marker</code> = Multiple uses, in multiplayer the <code>marker_type</code> can be set to <code>Backpack rack</code>, <code>Spawn node</code>, <code>Flag capture zone</code>, <code>King of the Hill target</code>, <code>Siege target</code> & <code>Spectator camera</code>.<br />
* <code>cover_node</code> =<br />
* <code>navpoint</code> = Probably where NPCs can navigate, similar to navmeshes in other games.<br />
* <code>object_action_node</code> = <br />
* <code>object_squad_spawn_node</code> = Probably where squads spawn and references various <code>squads.xtbl</code> files.<br />
* <code>object_path_road</code> = Probably where NPCs can drive vehicles.<br />
* <code>object_guard_node</code> =<br />
* <code>object_vehicle_spawn_node</code> = Probably where vehicles can spawn like walkers found around the SP map.<br />
* <code>object_bounding_box</code> = Seems to be only be used in singleplayer, unknown why.<br />
* <code>object_activity_spawn</code> = Probably where you can start a side activity like demolition master for example.<br />
* <code>object_house_arrest_node</code> = Related to the house arrest side activity.<br />
* <code>object_patrol</code> = Probably where EDF patrol.<br />
* <code>object_dummy</code> =<br />
* <code>object_mission_start_node</code> = Probably where you can start a main mission.<br />
* <code>object_restricted_area</code> = Probably where the EDF will attack on sight and you will get an alert level in SP.<br />
* <code>backpack_effect_attach.cchk_pc</code> = Seems to be for attaching the backpack to the player when they spawn, DO NOT TOUCH IT ALL OR THE MAP WILL CRASH WHEN SPAWNING.<br />
<br />
==Object Properties==<br />
* <code>gameplay_props</code> references <code>gameplay_properties.xtbl</code>.<br />
* <code>backpack_type</code> references <code>mp_backpacks.xtbl</code>.<br />
* <code>weapon_type</code> references <code>weapons.xtbl</code>.<br />
* <code>item_type</code> references <code>items_3d.xtbl</code>.<br />
* <code>spawn_resource_data</code> references <code>spawn_resource.xtbl</code>.<br />
* <code>ambient_spawn</code> references <code>ambient_spawn_info.xtbl</code> or <code>dlc01_ambient_spawn_info.xtbl</code>.<br />
* <code>visual</code> references <code>effects.xtbl</code>.<br />
* <code>sound</code> references <code>foley.xtbl</code> (not included in the game for some reason) however there is <code>dlc01_foley.xtbl</code>.<br />
<br />
==Spawn Points==<br />
* <code>mp_team</code> can be set to <code>Neutral</code>, <code>EDF</code> or <code>Guerilla</code>.<br />
* When making a CTF map and you don't want players spawning at the opposing base ensure you disable the Flag <code>Spawn in CTF</code> for any Neutral spawn points.<br />
* Unknown if the <code>respawn</code> and <code>initial_spawn</code> booleans do anything in multiplayer.<br />
* <code>indoor</code> boolean is probably left over from Saints Row since all of RF:G is technically outdoors and no spawn points use this boolean.<br />
* <code>checkpoint_respawn</code> & <code>activity_respawn</code> are only used in singleplayer.<br />
* Foward X axis (blue line) determines player spawn direction.<br />
<br />
==Spawn Nodes==<br />
* Camera views at the start of match or when a player dies and is spectating.<br />
* Foward X axis (blue line) determines player camera direction & view.<br />
* If a map doesn't have at least one <code>Spawn node</code> it will crash when loading.<br />
<br />
==Spectator Cameras==<br />
* Believed to be similar to a <code>Spawn node</code> but used exclusively by players using the spectator option in matchmaking. Recommended to just ignore adding these since the community only plays custom games and adding <code>Spawn nodes</code> to your map will serve the same purpose.<br />
* Foward X axis (blue line) determines player camera direction & view.<br />
* These camera views are also shared with <code>Spawn nodes</code> at start of match or when a player dies and is spectating.<br />
<br />
==Mover Types==<br />
* Applies to <code>rfg_movers</code><br />
* When editing their properties it's possible to change the <code>mtype</code> field to the corresponding numbers<br />
* Fixed = 0 (default)<br />
* Normal = 1 (unknown)<br />
* Lite = 2 (unknown)<br />
* Ultra Lite = 3 (unknown)<br />
* World Only = 4 (no collision but you can still destroy it with a hammer for example)<br />
* No Collision = 5 (no collision)<br />
<br />
==Damage Control Targets==<br />
# Deep clone <code>MPDCT_MAPNAME_XXX</code>.<br />
# Move </code>MPDCT_MAPNAME_XXX</code> to the location of your choosing.<br />
# In object properties for the parent change <code>display_name</code> to whatever you want your new damage control objective to be called.<br />
# If you're making a map that doesn't already have a damage control target you can open it in another tab and use the deep clone feature. If you're using the Terraform Patch the majority of Wrecking Crew maps will already have the asset along with all Siege maps.<br />
# It's also possible to have only <code>1</code> target & more than <code>3</code>. The limit before the game will crash is a total of <code>6</code> targets when tested solo. The limit might be lower when played with other people but needs to be tested more.<br />
# It's also possible that using the same <code>display_name</code> name for each target can introduce instability.<br />
# The only valid value for the <code>mp_team</code> property is <code>Neutral</code>. If you change the team to <code>EDF</code> or <code>Guerilla</code> and disable the <code>shape_cutter</code> child so the target starts off intact it will belong to that team but not score any points until it's destroyed and repaired.<br />
# You can disable the <code>shape_cutter</code> child so the target starts off intact instead of destroyed like it is by default.<br />
# Any object can be used for a target if you add the <code>multi_object_marker</code>, <code>shape_cutter</code> and offset them correctly from the parent. See Stratosphere if using the Terraform Patch for how to do this; shipping containers are the targets added on that map in the patch.<br />
<br />
==Siege Targets==<br />
# Open a siege map in one tab, open a regular map with the same objects in another tab.<br />
# Deep clone the siege target to the regular map.<br />
# Move the added siege target to the exact same location as the existing matching object on the regular map.<br />
# Disable all the gamemode flags for the added siege target except for "Spawn in Siege" including its children.<br />
# Delete all the children of the siege targets (usually spawns that will be outside the map since they were deep cloned from the siege map), after they are all deleted make sure to "orphan children" of the child to ensure it doesn't have ghost children. <br />
# Disable the <code>Spawn in siege</code> flag on the matching original map object.<br />
# You need to update <code>mp_levels.xtbl</code> so the map is selectable in siege.<br />
# Ensure the siege target and its child have the persistent flag.<br />
# The <code>priority</code> property for the <code>Siege target</code> child determines which siege objects are unlocked to destroy, eg if you set it to <code>1</code> it would be the first target the attackers can destroy, you can have multiple targets unlocked by using the same number and if you wanted to have targets unlocked one at a time you would use <code>1</code>, <code>2</code>, <code>3</code> and so on. If you use a value of <code>4294967295</code> they are also unlocked at the same time.<br />
# You must use an existing string in the game for the <code>display_name</code> property on the child or the map will crash.<br />
# If you mess up the offset of the child the map will crash.<br />
<br />
==Backpack Racks==<br />
* Make sure you deep clone them when adding new racks, the child <code>Backpack rack</code> is required for it to work properly.<br />
* Ensure that when moving the rack to a new location you only move the parent (the child will follow and be offset correctly), they will be named <code>Jetpack</code> for example if you're using the Terraform Patch.<br />
* When editing the child <code>backpack_type</code> determines which backpack will spawn, most are the same as their in game names with the exception of Firepower <code>Commando</code> & Concussion <code>Shockwave</code>. These names are from <code>mp_backpacks.xtbl</code>.<br />
* When editing the child you can change the number of backpacks on a rack, edit <code>num_backpacks</code> and change it from a value ranging from <code>0-3</code>, although <code>0</code> would mean the rack is empty and useless.<br />
* When editing the child it's possible to make it team exclusive, this means only the EDF or Red Faction can pickup backpacks from that rack during team game modes. Edit <code>mp_team</code> and enter either <code>EDF</code> or <code>Guerilla</code>. In game that rack will have a green glow around it if your team can use it.<br />
* The <code>random_backpacks</code> boolean in the object properties for the <code>Backpack rack</code> child doesn't seem to do anything.<br />
* It's possible to make Backpack Racks destructable by changing <code>gameplay_props</code> to <code>Default</code>. During team game modes teams can fight for control by destroying racks and repairing them so only their team can use them. Racks you're able to use will glow green and racks you can't will glow red if you're using the Terraform Patch.<br />
* The maximum number of Backpack Racks you can have on a map before it causes issues is <code>25</code>.<br />
<br />
==Capture the Flag targets==<br />
* The EDF and Red Faction have their own unique flag stand placed near their team spawns on regular multiplayer maps.<br />
* Make sure you use deep cloning and only move the parent when placing or moving them so the child is offset correctly.<br />
* Objects are called <code>edf_flag_stand.cchk_pc</code> & <code>guerrilla_flag_stand.cchk_pc</code>.<br />
* If you attempt to add more than two stands to a map, the extras will not work as capture points and only the asset will appear.<br />
* <code>Neutral</code> is not a valid value for <code>mp_team</code>.<br />
<br />
==Bagman Objective Spawn==<br />
* Object is an <code>item</code> type referencing <code>items.3d_xtbl</code>.<br />
* Ignore the varying bounding box sizes when positioning the bag spawn, the XYZ axis position is what matters (the red, blue & green lines).<br />
* The <code>respawn</code> boolean doesn't do what you expect, the bag will still return to the original spawn point regardless if it's enabled or not.<br />
* You can't place more than one bag on a map, only one will spawn.<br />
* You can have different bag locations in Bagman and Team Bagman by using the gamemode flags.<br />
<br />
==Weapon Spawns==<br />
* You should clone other weapons to add new ones, if you make them from scratch and don't get the bounding box correct for certain weapons it can cause duplicate weapon spawns in some cases.<br />
* <code>weapon_type</code> determines which weapon will spawn and references <code>weapons.xtbl</code>.<br />
* The <code>preplaced</code> boolean needs more testing but you can disable weapons in certain game modes by disabling the game mode flags anyway.<br />
* The <code>respawns</code> boolean will cause the weapon to not re-spawn again during a match after it has been picked up for the first time.<br />
* Ensure the bounding box is slightly above the ground/floor when positioning weapons.<br />
<br />
==Trigger Regions==<br />
* In multiplayer & singleplayer these are used to prevent the player from going out of bounds.<br />
* <code>region_kill_type</code> can be set to a <code>cliff</code> or a <code>mine</code>. A cliff will cause the player to fall to their death, while a mine will explode and kill the player; this is also reflected in the killfeed message in multiplayer.<br />
* In singleplayer the <code>trigger_flags</code> can be changed so the trigger isn't enabled during missions and/or activities. Eg. <code>not_in_mission</code> will disable it during a main mission, <code>not_in_activity</code> would disable it during a side activity and <code>not_in_mission not_in_activity</code> would disable it during both.<br />
* The <code>enabled</code> boolean allows mappers to enable/disable the region.<br />
* The <code>trigger_shape</code> can be set to a <code>box</code> or <code>sphere</code>. However Nanoforge cannot render spherical bounding boxes yet.<br />
* <code>outer_radius</code> might control the size of the region, but this is untested.<br />
<br />
==Object Effects==<br />
* Plays an effect such as smoke, fire, explosion, sparks, etc. Also can play sounds if the effect has one in <code>effects.xtbl</code> and the sound string is used.<br />
* <code>sound_alr</code> = Unknown. <br />
* <code>sound</code> = The name of the sound in <code>effects.xtbl</code><br />
* <code>visual</code> = The name of the effect in <code>effects.xtbl</code><br />
* <code>looping</code> = Controls if the effect will play once or continuously.<br />
<br />
==Shape Cutters==<br />
* Used to damage or cut holes into destructible objects ahead of time.<br />
* <code>outer_radius</code> might control the size of the cutter, but this is untested.<br />
<br />
==Maps with names different from their in-game names==<br />
* wc1 - Complex<br />
* wc2 - Watchtower<br />
* wc3 - Scrapheap<br />
* wc4 - Vista<br />
* wc5 - Fortress<br />
* wc6 - Factory<br />
* wc7 - Gulch<br />
* wc8 - Cascade<br />
* wc9 - Transmission<br />
* wc10 - Pipeline<br />
* wcdlc1 - Ruins<br />
* wcdlc2 - Repercussion<br />
* wcdlc3 - Imperial<br />
* wcdlc4 - Expansion<br />
* wcdlc5 - Frost<br />
* wcdlc6 - Abandoned<br />
* wcdlc7 - Stratosphere <br />
* wcdlc8 - Invasion<br />
* wcdlc9 - Nordic Bonus<br />
* mpcx_crossover - Doubletime<br />
* mpcx_assembly - Outpost <br />
* mpdlc_landbridge - Equilibrium<br />
* mpdlc_islands - Haven<br />
* mpdlc_minibase - Complex<br />
* mpdlc_overhang - Gradient<br />
* mpdlc_ruins - Remnant<br />
<br />
==Maps with similar terrain==<br />
* Crash Site/Complex/Nordic Bonus<br />
* Rift/Factory<br />
* Remnant/Ruins<br />
* Broadside/Invasion<br />
* Wasteland/Gulch<br />
* Outpost/Framework<br />
* Radial/Transmission<br />
* Sand Pit/Division/Watchtower<br />
* Tutorial Area/Pipeline<br />
* Pinnacle/Fortress<br />
<br />
==Misc Notes==<br />
* Deep clone objects if you want to keep the children of an object and use regular clone if you just want to clone the parent. Only move the parent when deep cloning and the children will follow and be offset correctly.<br />
* If you see anything that looks like XML inside <code>layer_pc</code> or <code>rfgzone_pc</code> files you can ignore that as we're 99% sure it's junk from their file packer reusing memory without zeroing it out.<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail.<br />
<br />
===Localization strings===<br />
While Nanoforge is only in English at the moment it can view localized strings used by RFG. RFG uses placeholder strings in many xtbls which are replaced with their localization at runtime. These are shown automatically in the xtbl editor. You can also view a list of all localized strings via <code>Tools > Localization > View localized strings</code>. You can search by placeholder by checking "Search by identifier". You must fully enter the identifier without typos for this to work since it's comparing it to a hash of the identifier stored in the games localization files.<br />
<br />
[[File:Nanoforge_LocalizedStringList0.png|frameless|768px]]<br />
<br />
===Scriptx viewer===<br />
RFG uses an xml based scripting system called scriptx for some mission logic. The viewer is an attempt at making it easier to read scriptx files which can be difficult to understand. It's a low priority feature so it likely won't see changes for a while but was enabled in case it's useful to people editing scriptx files. You still need to edit them by hand but it can help make it clearer what a script is doing. You can access it via <code>View > Scriptx Viewer (WIP)</code>.<br />
<br />
[[File:Nanoforge_ScriptxViewer0.png|frameless|768px]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=Nanoforge_basics&diff=8962Nanoforge basics2023-06-21T04:28:39Z<p>Camo: /* Trigger Regions */</p>
<hr />
<div>{{RFGEditing}}<br />
{{Under construction}}<br />
<br />
This page goes over how to install Nanoforge and it's basic features. This article only goes over the basics of each feature. See the other guides for more detailed explanations.<br />
<br />
==Installation==<br />
===Download===<br />
Nanoforge releases are posted on [https://github.com/Moneyl/Nanoforge/releases github]. Multiple releases will be listed. You should always download the most recent release. To download it, look for the <code>▸Assets</code> button(1), click it, and download the first zip file listed under it(2).<br />
<br />
[[File:NanoforgeDownloadStepsAnnotated.png|frameless|768px]]<br />
<br />
===Install===<br />
*Unpack the zip file you downloaded anywhere and run Nanoforge.exe<br />
*You should now see the start screen. On the left side it has the data path and the recent projects list. On the right it has the changelog. Nanoforge with attempt to auto detect your RFG install. If it says that your data path is invalid click the <code>Browse...</code> button and select your RFG data folder.<br />
<br />
==Features==<br />
This section gives a quick rundown of each of Nanoforge's features.<br />
<br />
===Projects===<br />
Nanoforge uses projects to track edits made to game files. The idea is to use a single project per mod. You only need to create a project if you're editing files. You don't need one to view and export files. To create a new project click <code>New project</code> in the start page or <code>File > New project...</code> on the main menu bar. Fill out all the info on the popup and click <code>Create</code>. Below are each of the fields to fill in:<br />
*Name: The name of the project. Used to name the project file and as the name in any modinfo.xml files it generates.<br />
*Path: Path to the folder that the project should be created in.<br />
*Description: (Optional) Description of what the mod is. Used in the description field of modinfo.xml.<br />
*Author: (Optional) Author(s) of the mod. Used in the author filed of modinfo.xml.<br />
*Create project folder: If unchecked then the project files are placed directly in the folder chosen for path. If checked a folder with the entered name will be created in that folder.<br />
<br />
===File explorer===<br />
The file explorer lets you view the contents of vpp_pc and str2_pc files without extracting them manually. You can double click supported file formats like textures to open them. If you single click a vpp_pc or str2_pc file it will expand to show it's contents. Extra info about the file will be shown in the properties panel for some files when single clicking them.<br />
<br />
[[File:Nanoforge ProjectCreationExample3.png|frameless|256px]]<br />
<br />
====Search====<br />
You can use the search bar to limit which files are shown in the file explorer. By default it will only show files with names that contain the search term. You can also use some special characters to specialize your search behavior:<br />
*Start your search with *: Will only show files with names that end with whatever comes after *<br />
*End your search with *: Will only show files with names that start with whatever comes before *<br />
<br />
If you prefer regex you can check the regex search option. Note that the regex search option is much slower than the default one.<br />
<br />
===Properties panel===<br />
The properties panel sometimes will show additional info about files selected in the file explorer. It also may be used by other UI panels to show additional info. For example, it can list object properties when viewing territories (see map viewing section below).<br />
<br />
[[File:Nanoforge_PropertiesPanel2.png|frameless|256px]]<br />
<br />
===Textures===<br />
You can open texture files by double clicking them in the file explorer. Textures are split into two files. Either a cpeg_pc and gpeg_pc file pair or a cvbm_pc and gvbm_pc file pair. You can double click any of these to open a texture. A single RFG texture file can contain multiple textures, which we'll refer to as subtextures. Info about the selected subtexture will be shown below the subtexture list.<br />
<br />
[[File:Nanoforge_TextureDocument.png|frameless|768px]]<br />
<br />
Above is an example of what you might see if you open a texture file. On the sidebar to the left there a few things, in order:<br />
*The subtexture list. Click on one to see more info about it below.<br />
*Texture info. This is info about the selected subtexture.<br />
*Header info. This is general info about the cpeg/cvbm file.<br />
<br />
====Exporting textures====<br />
Textures can be exported to files you can edit with common image editors like Paint.NET, GIMP, or Photoshop. Currently textures can only be exported as .dds files. You can export single subtextures by right clicking one of them and clicking <code>Export...</code>. You can export all subtextures at once with the <code>Export all...</code> button.<br />
<br />
====Editing textures====<br />
Textures can be edited by imported textures you've edited externally. Currently it can only import .dds files. You do this by right clicking a subtexture, clicking <code>Replace...</code> and selecting the file you want to replace the subtexture with. Once you do this it's critical that you press the <code>Save</code> button above the subtexture list to save your edit. This edit will be automatically saved to your current project when you click <code>Save</code>. See [[Nanoforge Texture Editing]] for more info.<br />
<br />
===Meshes===<br />
Nanoforge supports viewing and exporting .csmesh_pc (static mesh) and .ccmesh_pc (character mesh) files. Just like textures, meshes consist of two files. Every csmesh_pc file is paired with a gsmesh_pc file, and every ccmesh_pc file is paired with a gcmesh_pc file. You can click any of them to open a mesh. When you open a mesh you'll first see a blank space. Meshes are loaded on a background thread so it may take a few seconds for the mesh to be loaded and for it's textures to show up. Before its textures are found or if the textures cant be found you might see textures from previously loaded meshes applied to the mesh.<br />
<br />
[[File:Nanoforge_MeshDocument.png|frameless|512px]]<br />
<br />
Above is what you might see if you open a mesh file. There's a few parts of the UI to note, in order:<br />
* The camera button. This lets you control camera settings like speed and location. You can move the camera by holding down the right mouse button and using WASD to move around. If this doesn't work try left clicking on the mesh 3D view. Only the most recently selected mesh reacts to camera controls so if you have several open it'll only move one camera.<br />
* The scene button. This has some rendering settings for the mesh such as scale and lighting color/intensity.<br />
* The info button. This shows some additional info about the mesh such as vertex format, and the LOD slider for meshes with multiple levels of detail.<br />
* The export button. This lets you export the mesh and it's textures to a .obj file, which can be imported into tools like blender.<br />
* The status bar. This shows the loading status and percentage. It will show <code>Done! ✓</code> once loading is complete.<br />
<br />
====Exporting meshes====<br />
To export a mesh:<br />
* Wait for it to finish loading. The status bar will show <code>Done! ✓</code> and 100%.<br />
* Click the export button. Top left of the document, button furthest to the right.<br />
* Select a folder to export the mesh and it's textures to and click <code>Export</code>.<br />
<br />
A single gltf file and the meshes textures will be exported. Each lod level is labelled in the gltf under their own subnode. Currently these gltf files don't look right as is when imported into Blender. This is because GLTF uses a different rendering model than RFG. Typically meshes have a diffuse, specular, and normal texture. Their names end with _d, _s, and _n respectively. You'll need to make the following changes to the textures in the Blender shading tab:<br />
* Diffuse -> Set color space to linear, attach texture color to "Base Color" on the BSDF<br />
* Specular -> Set color space to linear, attach texture color to "Specular" on the BSDF<br />
* Normal -> Set color space to SRGB, attach texture color to "Normal" on the BSDF<br />
<br />
In the near future an extension will be made to automatically patch the shader graph.<br />
<br />
====Camera movement====<br />
To move the camera hold down the right mouse button over the 3D view and use WASD to move around. Holding down shift while moving will cause the camera to move faster. Pressing Q and E will move the camera directly up and directly down respectively.<br />
<br />
===Mod packaging===<br />
Once you're done editing textures you can use Nanoforge to repack the editing files and generate a modinfo.xml for you. To do this, simply click <code>File > Package mod</code> on the main menu bar. Once it's done go to the "Output" folder inside your project folder to see the modinfo.xml and any files that it relies on. These are ready for use with the re-mars-tered mod manager.<br />
<br />
===Map view===<br />
Nanoforge has partial support for viewing maps like the main campaign map. We'll be referring to them as territories as that's how RFG groups together many zones. See [[RF:G Map organization]] for more details on how RFG maps are structured. To open a territory via <code>Tools > Open territory</code> on the main menu bar. Terr01 is the main campaign map territory. A new document should appear when you open a new territory. Camera movement is the same as the mesh viewer. See [[#Camera_movement|camera movement]]. Terrain is loaded in the background so you'll see separate blocks of terrain pop into view as they load. Bounding boxes are drawn for zone objects. With a territory open you should see new information on the zone panel and the zone objects panel. You can dock panels by clicking and dragging on their titles. It's recommended that you dock the zone object list below the zone list so you can see both at once.<br />
<br />
Below is an annotated image of information you can view about territories plus descriptions for each annotation.<br />
<br />
[[File:Nanoforge_W3p0erDiTj.jpg|frameless|1024px]]<br />
<br />
* First, in the top left is the zone list. Territories are made up of one or more zones which in turn have many zone objects. Click a zone to see its object in the zone objects panel (bottom left). By default the zone with the most objects is selected. In this case that's <code>04_06</code>. Note that each zone corresponds to a rfgzone_pc file. So, for example, <code>04_06</code> is really terr01_04_06.rfgzone_pc.<br />
* Next, bottom left is the zone objects list. This lists the objects inside the selected zone. Click an object to see its properties in the properties panel. Some objects have child objects, denoted by having a triangle in front of their name which you can click to expand them. You can filter objects by type inside the filters header. By default some very common objects like navpoints are hidden.<br />
* Finally, in the top right is the properties panel. This shows the properties of the selected zone object.<br />
<br />
==Object Flags==<br />
* Flag 0 (Persistent): Unknown, any objects with this flag have a separate copy stored in a second <code>rfgzone_pc</code> file with its name prefixed with <code>p__.</code> So, for example, Crescent has two <code>rfgzone_pc</code> files. <code>mp_crescent.rfgzone_pc</code> and <code>p_mp_crescent.rfgzone_pc</code>. The objects with the persistent flag are stored in both zone files, while objects without that flag are only stored in <code>mp_crescent.rfgzone_pc</code>. It's consistently used on player spawns, on most siege objectives and on most <code>rfg_movers</code> on Siege maps. It's recommended you don't enable or disable this flag on maps if you're using the Terraform Patch as it contains fixes for missing objects that incorrectly used this flag or were missing it; doing so will cause objects to vanish.<br />
* Flag 1: Unknown<br />
* Flag 2: Unknown <br />
* Flag 3: Unknown; might be related to how the game saves/loads map data from save files (requires more investigation)<br />
* Flag 4: Unknown; seems to always get converted to the runtime flag <code>streaming_fixed</code>, most <code>rfg_movers</code> and <code>general_movers</code> have this flag. If you're using the Terraform Patch it's recommended you don't disable this flag as it applies it to all objects since it was used most of the time and objects missing it were assumed to be an error by Volition. (They also made mistakes with the gamemode and persistent flags)<br />
* Flag 5: Unknown; seems to get converted to the runtime flag <code>force_full_save</code><br />
* Flag 6: Unknown<br />
* Flag 7: Unknown<br />
* Flag 8: Spawns in Anarchy<br />
* Flag 9: Spawns in Team Anarchy<br />
* Flag 10: Spawns in CTF<br />
* Flag 11: Spawns in Siege<br />
* Flag 12: Spawns in Damage Control<br />
* Flag 13: Spawns in Bagman<br />
* Flag 14: Spawns in Team Bagman<br />
* Flag 15: Spawns in Demolition<br />
<br />
==Chunk Flags==<br />
* Applies to <code>rfg_movers</code> & <code>general_movers</code>.<br />
* When editing their properties in the inspector it's possible to change the <code>chunk_flags</code>.<br />
* You can also use <code>gameplay_properties.xtbl</code> to apply these flags and change <code>gameplay_props</code>. If you're using the Terraform Patch a new <code>gameplay_prop</code> named <code>Invulnerable</code> is added which also can be used to make objects indestructible.<br />
* Eg: <code>dynamic_link invulnerable</code> will make the object indestructible. Full list of flags below:<br />
* child_gives_control: Unknown.<br />
* building: Unknown.<br />
* dynamic_link: Unknown.<br />
* world_anchor: Unknown.<br />
* no_cover: Might be where EDF can't take cover behind objects.<br />
* propaganda: EDF propaganda billboards you destroy for the achievement in singleplayer have this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows to track the players progress and reduce EDF control of the sector.<br />
* kiosk: <code>tech_kiosk_EDF_A</code> has this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows its a special object that plays propaganda videos.<br />
* touch_terrain: Unknown, no <code>gameplay_properties.xtbl</code> entries use this flag and it's missing from the table description.<br />
* supply_crate: EDF crates you destroy for the achievement in singleplayer have this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows to track the players progress.<br />
* mining: Ores you mine for salvage and the achievement in singleplayer have this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows to track the players progress.<br />
* one_of_many: Unknown, <code>windmill_0708</code>, <code>0102smokestack_86</code> & <code>0102smokestack_86_child</code> have this flag in <code>gameplay_properties.xtbl</code>. Might be related to one of the side activities where you have to destroy multiple targets.<br />
* plume_on_death: Unknown.<br />
* invulnerable: Makes an object indestructible.<br />
* inherit_damaga_pct: Unknown.<br />
* regrow_on_stream: Unknown.<br />
* casts_drop_shadow: Object will cast drop shadows.<br />
* disable_collapse_effect: Unknown.<br />
* force_dynamic: Unknown.<br />
* show_on_map: Most objects in <code>gameplay_properties.xtbl</code>. Most likely means the object will show on the minimap in singleplayer.<br />
* regenerate: Unknown.<br />
* casts_shadow: Object will cast a shadow map.<br />
<br />
==Object Info==<br />
* <code>obj_zone</code> = Defines the wind speed, terrain file name & <code>spawn_resource_data</code>. If you move its location the terrain will no longer have collision.<br />
* <code>MPST</code> = Multiplayer siege target.<br />
* <code>MPDCT</code> = Multiplayer damage control target.<br />
* <code>shape_cutter</code> = Causes object to start off with initial damage, used on damage control targets or maps like crash site, ruins & remnant where they put a hole in the wall.<br />
* <code>spawn_node</code> = Camera view at start of match and end of game. If a map doesn't have a least one of these it will crash.<br />
* <code>spectator_camera</code> = Camera view exclusively for players using the spectator mode, recommended to just ignore adding them and use <code>spawn_nodes</code> instead.<br />
* <code>trigger_region</code> = Killbox that can be set to a mine or cliff.<br />
* <code>rfg_mover</code> = Buildings, backpack racks & more.<br />
* <code>general_mover</code> = Explosive barrels and the <code>backpack_effect_attach.cchk_pc</code> objects for example.<br />
* <code>player_start</code> = Spawn point, can be set to Neutral, EDF or Guerilla.<br />
* <code>item</code> = In multiplayer the bag for bagman is set to <code>item_type</code> "multi_object_bagman_flag" and references <code>items_3d.xtbl</code>.<br />
* <code>weapon</code> = Weapon spawn, <code>weapon_type</code> determines which weapon will spawn and references <code>weapons.xtbl</code>.<br />
* <code>object_effect</code> = Visual effect, eg the fire on Nordic Bonus.<br />
* <code>multi_object_marker</code> = Multiple uses, in multiplayer the <code>marker_type</code> can be set to <code>Backpack rack</code>, <code>Spawn node</code>, <code>Flag capture zone</code>, <code>King of the Hill target</code>, <code>Siege target</code> & <code>Spectator camera</code>.<br />
* <code>cover_node</code> =<br />
* <code>navpoint</code> = Probably where NPCs can navigate, similar to navmeshes in other games.<br />
* <code>object_action_node</code> = <br />
* <code>object_squad_spawn_node</code> = Probably where squads spawn and references various <code>squads.xtbl</code> files.<br />
* <code>object_path_road</code> = Probably where NPCs can drive vehicles.<br />
* <code>object_guard_node</code> =<br />
* <code>object_vehicle_spawn_node</code> = Probably where vehicles can spawn like walkers found around the SP map.<br />
* <code>object_bounding_box</code> = Seems to be only be used in singleplayer, unknown why.<br />
* <code>object_activity_spawn</code> = Probably where you can start a side activity like demolition master for example.<br />
* <code>object_house_arrest_node</code> = Related to the house arrest side activity.<br />
* <code>object_patrol</code> = Probably where EDF patrol.<br />
* <code>object_dummy</code> =<br />
* <code>object_mission_start_node</code> = Probably where you can start a main mission.<br />
* <code>object_restricted_area</code> = Probably where the EDF will attack on sight and you will get an alert level in SP.<br />
* <code>backpack_effect_attach.cchk_pc</code> = Seems to be for attaching the backpack to the player when they spawn, DO NOT TOUCH IT ALL OR THE MAP WILL CRASH WHEN SPAWNING.<br />
<br />
==Object Properties==<br />
* <code>gameplay_props</code> references <code>gameplay_properties.xtbl</code>.<br />
* <code>backpack_type</code> references <code>mp_backpacks.xtbl</code>.<br />
* <code>weapon_type</code> references <code>weapons.xtbl</code>.<br />
* <code>item_type</code> references <code>items_3d.xtbl</code>.<br />
* <code>spawn_resource_data</code> references <code>spawn_resource.xtbl</code>.<br />
* <code>ambient_spawn</code> references <code>ambient_spawn_info.xtbl</code> or <code>dlc01_ambient_spawn_info.xtbl</code>.<br />
* <code>visual</code> references <code>effects.xtbl</code>.<br />
* <code>sound</code> references <code>foley.xtbl</code> (not included in the game for some reason) however there is <code>dlc01_foley.xtbl</code>.<br />
<br />
==Spawn Points==<br />
* <code>mp_team</code> can be set to <code>Neutral</code>, <code>EDF</code> or <code>Guerilla</code>.<br />
* When making a CTF map and you don't want players spawning at the opposing base ensure you disable the Flag <code>Spawn in CTF</code> for any Neutral spawn points.<br />
* Unknown if the <code>respawn</code> and <code>initial_spawn</code> booleans do anything in multiplayer.<br />
* <code>indoor</code> boolean is probably left over from Saints Row since all of RF:G is technically outdoors and no spawn points use this boolean.<br />
* <code>checkpoint_respawn</code> & <code>activity_respawn</code> are only used in singleplayer.<br />
* Foward X axis (blue line) determines player spawn direction.<br />
<br />
==Spawn Nodes==<br />
* Camera views at the start of match or when a player dies and is spectating.<br />
* Foward X axis (blue line) determines player camera direction & view.<br />
* If a map doesn't have at least one <code>Spawn node</code> it will crash when loading.<br />
<br />
==Spectator Cameras==<br />
* Believed to be similar to a <code>Spawn node</code> but used exclusively by players using the spectator option in matchmaking. Recommended to just ignore adding these since the community only plays custom games and adding <code>Spawn nodes</code> to your map will serve the same purpose.<br />
* Foward X axis (blue line) determines player camera direction & view.<br />
* These camera views are also shared with <code>Spawn nodes</code> at start of match or when a player dies and is spectating.<br />
<br />
==Mover Types==<br />
* Applies to <code>rfg_movers</code><br />
* When editing their properties it's possible to change the <code>mtype</code> field to the corresponding numbers<br />
* Fixed = 0 (default)<br />
* Normal = 1 (unknown)<br />
* Lite = 2 (unknown)<br />
* Ultra Lite = 3 (unknown)<br />
* World Only = 4 (no collision but you can still destroy it with a hammer for example)<br />
* No Collision = 5 (no collision)<br />
<br />
==Damage Control Targets==<br />
# Deep clone <code>MPDCT_MAPNAME_XXX</code>.<br />
# Move </code>MPDCT_MAPNAME_XXX</code> to the location of your choosing.<br />
# In object properties for the parent change <code>display_name</code> to whatever you want your new damage control objective to be called.<br />
# If you're making a map that doesn't already have a damage control target you can open it in another tab and use the deep clone feature. If you're using the Terraform Patch the majority of Wrecking Crew maps will already have the asset along with all Siege maps.<br />
# It's also possible to have only <code>1</code> target & more than <code>3</code>. The limit before the game will crash is a total of <code>6</code> targets when tested solo. The limit might be lower when played with other people but needs to be tested more.<br />
# It's also possible that using the same <code>display_name</code> name for each target can introduce instability.<br />
# The only valid value for the <code>mp_team</code> property is <code>Neutral</code>. If you change the team to <code>EDF</code> or <code>Guerilla</code> and disable the <code>shape_cutter</code> child so the target starts off intact it will belong to that team but not score any points until it's destroyed and repaired.<br />
# You can disable the <code>shape_cutter</code> child so the target starts off intact instead of destroyed like it is by default.<br />
# Any object can be used for a target if you add the <code>multi_object_marker</code>, <code>shape_cutter</code> and offset them correctly from the parent. See Stratosphere if using the Terraform Patch for how to do this; shipping containers are the targets added on that map in the patch.<br />
<br />
==Siege Targets==<br />
# Open a siege map in one tab, open a regular map with the same objects in another tab.<br />
# Deep clone the siege target to the regular map.<br />
# Move the added siege target to the exact same location as the existing matching object on the regular map.<br />
# Disable all the gamemode flags for the added siege target except for "Spawn in Siege" including its children.<br />
# Delete all the children of the siege targets (usually spawns that will be outside the map since they were deep cloned from the siege map), after they are all deleted make sure to "orphan children" of the child to ensure it doesn't have ghost children. <br />
# Disable the <code>Spawn in siege</code> flag on the matching original map object.<br />
# You need to update <code>mp_levels.xtbl</code> so the map is selectable in siege.<br />
# Ensure the siege target and its child have the persistent flag.<br />
# The <code>priority</code> property for the <code>Siege target</code> child determines which siege objects are unlocked to destroy, eg if you set it to <code>1</code> it would be the first target the attackers can destroy, you can have multiple targets unlocked by using the same number and if you wanted to have targets unlocked one at a time you would use <code>1</code>, <code>2</code>, <code>3</code> and so on. If you use a value of <code>4294967295</code> they are also unlocked at the same time.<br />
# You must use an existing string in the game for the <code>display_name</code> property on the child or the map will crash.<br />
# If you mess up the offset of the child the map will crash.<br />
<br />
==Backpack Racks==<br />
* Make sure you deep clone them when adding new racks, the child <code>Backpack rack</code> is required for it to work properly.<br />
* Ensure that when moving the rack to a new location you only move the parent (the child will follow and be offset correctly), they will be named <code>Jetpack</code> for example if you're using the Terraform Patch.<br />
* When editing the child <code>backpack_type</code> determines which backpack will spawn, most are the same as their in game names with the exception of Firepower <code>Commando</code> & Concussion <code>Shockwave</code>. These names are from <code>mp_backpacks.xtbl</code>.<br />
* When editing the child you can change the number of backpacks on a rack, edit <code>num_backpacks</code> and change it from a value ranging from <code>0-3</code>, although <code>0</code> would mean the rack is empty and useless.<br />
* When editing the child it's possible to make it team exclusive, this means only the EDF or Red Faction can pickup backpacks from that rack during team game modes. Edit <code>mp_team</code> and enter either <code>EDF</code> or <code>Guerilla</code>. In game that rack will have a green glow around it if your team can use it.<br />
* The <code>random_backpacks</code> boolean in the object properties for the <code>Backpack rack</code> child doesn't seem to do anything.<br />
* It's possible to make Backpack Racks destructable by changing <code>gameplay_props</code> to <code>Default</code>. During team game modes teams can fight for control by destroying racks and repairing them so only their team can use them. Racks you're able to use will glow green and racks you can't will glow red if you're using the Terraform Patch.<br />
* The maximum number of Backpack Racks you can have on a map before it causes issues is <code>25</code>.<br />
<br />
==Capture the Flag targets==<br />
* The EDF and Red Faction have their own unique flag stand placed near their team spawns on regular multiplayer maps.<br />
* Make sure you use deep cloning and only move the parent when placing or moving them so the child is offset correctly.<br />
* Objects are called <code>edf_flag_stand.cchk_pc</code> & <code>guerrilla_flag_stand.cchk_pc</code>.<br />
* If you attempt to add more than two stands to a map, the extras will not work as capture points and only the asset will appear.<br />
* <code>Neutral</code> is not a valid value for <code>mp_team</code>.<br />
<br />
==Bagman Objective Spawn==<br />
* Object is an <code>item</code> type referencing <code>items.3d_xtbl</code>.<br />
* Ignore the varying bounding box sizes when positioning the bag spawn, the XYZ axis position is what matters (the red, blue & green lines).<br />
* The <code>respawn</code> boolean doesn't do what you expect, the bag will still return to the original spawn point regardless if it's enabled or not.<br />
* You can't place more than one bag on a map, only one will spawn.<br />
* You can have different bag locations in Bagman and Team Bagman by using the gamemode flags.<br />
<br />
==Weapon Spawns==<br />
* You should clone other weapons to add new ones, if you make them from scratch and don't get the bounding box correct for certain weapons it can cause duplicate weapon spawns in some cases.<br />
* <code>weapon_type</code> determines which weapon will spawn and references <code>weapons.xtbl</code>.<br />
* The <code>preplaced</code> boolean needs more testing but you can disable weapons in certain game modes by disabling the game mode flags anyway.<br />
* The <code>respawns</code> boolean will cause the weapon to not re-spawn again during a match after it has been picked up for the first time.<br />
* Ensure the bounding box is slightly above the ground/floor when positioning weapons.<br />
<br />
==Trigger Regions==<br />
* In multiplayer & singleplayer these are used to prevent the player from going out of bounds.<br />
* <code>region_kill_type</code> can be set to a <code>cliff</code> or a <code>mine</code>. A cliff will cause the player to fall to their death, while a mine will explode and kill the player; this is also reflected in the killfeed message in multiplayer.<br />
* In singleplayer the <code>trigger_flags</code> can be changed so the trigger isn't enabled during missions and/or activities. Eg. <code>not_in_mission</code> will disable it during a main mission, <code>not_in_activity</code> would disable it during a side activity and <code>not_in_mission not_in_activity</code> would disable it during both.<br />
* The <code>enabled</code> boolean allows mappers to enable/disable the region.<br />
* The <code>trigger_shape</code> can be set to a <code>box</code> or <code>sphere</code>. However Nanoforge cannot render spherical bounding boxes yet.<br />
* <code>outer_radius</code> might control the size of the region, but this is untested.<br />
<br />
==Object Effects==<br />
* Plays an effect such as smoke, fire, explosion, sparks, etc. Also can play sounds if the effect has one in <code>effects.xtbl</code> and the sound string is used.<br />
* <code>sound_alr</code> = Unknown. <br />
* <code>sound</code> = The name of the sound in <code>effects.xtbl</code><br />
* <code>visual</code> = The name of the effect in <code>effects.xtbl</code><br />
* <code>looping</code> = Controls if the effect will play once or continuously.<br />
<br />
==Shape Cutters==<br />
* Used to damage or cut holes into destructible objects ahead of time.<br />
* <code>outer_radius</code> = Unknown.<br />
<br />
==Maps with names different from their in-game names==<br />
* wc1 - Complex<br />
* wc2 - Watchtower<br />
* wc3 - Scrapheap<br />
* wc4 - Vista<br />
* wc5 - Fortress<br />
* wc6 - Factory<br />
* wc7 - Gulch<br />
* wc8 - Cascade<br />
* wc9 - Transmission<br />
* wc10 - Pipeline<br />
* wcdlc1 - Ruins<br />
* wcdlc2 - Repercussion<br />
* wcdlc3 - Imperial<br />
* wcdlc4 - Expansion<br />
* wcdlc5 - Frost<br />
* wcdlc6 - Abandoned<br />
* wcdlc7 - Stratosphere <br />
* wcdlc8 - Invasion<br />
* wcdlc9 - Nordic Bonus<br />
* mpcx_crossover - Doubletime<br />
* mpcx_assembly - Outpost <br />
* mpdlc_landbridge - Equilibrium<br />
* mpdlc_islands - Haven<br />
* mpdlc_minibase - Complex<br />
* mpdlc_overhang - Gradient<br />
* mpdlc_ruins - Remnant<br />
<br />
==Maps with similar terrain==<br />
* Crash Site/Complex/Nordic Bonus<br />
* Rift/Factory<br />
* Remnant/Ruins<br />
* Broadside/Invasion<br />
* Wasteland/Gulch<br />
* Outpost/Framework<br />
* Radial/Transmission<br />
* Sand Pit/Division/Watchtower<br />
* Tutorial Area/Pipeline<br />
* Pinnacle/Fortress<br />
<br />
==Misc Notes==<br />
* Deep clone objects if you want to keep the children of an object and use regular clone if you just want to clone the parent. Only move the parent when deep cloning and the children will follow and be offset correctly.<br />
* If you see anything that looks like XML inside <code>layer_pc</code> or <code>rfgzone_pc</code> files you can ignore that as we're 99% sure it's junk from their file packer reusing memory without zeroing it out.<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail.<br />
<br />
===Localization strings===<br />
While Nanoforge is only in English at the moment it can view localized strings used by RFG. RFG uses placeholder strings in many xtbls which are replaced with their localization at runtime. These are shown automatically in the xtbl editor. You can also view a list of all localized strings via <code>Tools > Localization > View localized strings</code>. You can search by placeholder by checking "Search by identifier". You must fully enter the identifier without typos for this to work since it's comparing it to a hash of the identifier stored in the games localization files.<br />
<br />
[[File:Nanoforge_LocalizedStringList0.png|frameless|768px]]<br />
<br />
===Scriptx viewer===<br />
RFG uses an xml based scripting system called scriptx for some mission logic. The viewer is an attempt at making it easier to read scriptx files which can be difficult to understand. It's a low priority feature so it likely won't see changes for a while but was enabled in case it's useful to people editing scriptx files. You still need to edit them by hand but it can help make it clearer what a script is doing. You can access it via <code>View > Scriptx Viewer (WIP)</code>.<br />
<br />
[[File:Nanoforge_ScriptxViewer0.png|frameless|768px]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=Nanoforge_basics&diff=8961Nanoforge basics2023-06-21T04:25:31Z<p>Camo: /* Object Info */</p>
<hr />
<div>{{RFGEditing}}<br />
{{Under construction}}<br />
<br />
This page goes over how to install Nanoforge and it's basic features. This article only goes over the basics of each feature. See the other guides for more detailed explanations.<br />
<br />
==Installation==<br />
===Download===<br />
Nanoforge releases are posted on [https://github.com/Moneyl/Nanoforge/releases github]. Multiple releases will be listed. You should always download the most recent release. To download it, look for the <code>▸Assets</code> button(1), click it, and download the first zip file listed under it(2).<br />
<br />
[[File:NanoforgeDownloadStepsAnnotated.png|frameless|768px]]<br />
<br />
===Install===<br />
*Unpack the zip file you downloaded anywhere and run Nanoforge.exe<br />
*You should now see the start screen. On the left side it has the data path and the recent projects list. On the right it has the changelog. Nanoforge with attempt to auto detect your RFG install. If it says that your data path is invalid click the <code>Browse...</code> button and select your RFG data folder.<br />
<br />
==Features==<br />
This section gives a quick rundown of each of Nanoforge's features.<br />
<br />
===Projects===<br />
Nanoforge uses projects to track edits made to game files. The idea is to use a single project per mod. You only need to create a project if you're editing files. You don't need one to view and export files. To create a new project click <code>New project</code> in the start page or <code>File > New project...</code> on the main menu bar. Fill out all the info on the popup and click <code>Create</code>. Below are each of the fields to fill in:<br />
*Name: The name of the project. Used to name the project file and as the name in any modinfo.xml files it generates.<br />
*Path: Path to the folder that the project should be created in.<br />
*Description: (Optional) Description of what the mod is. Used in the description field of modinfo.xml.<br />
*Author: (Optional) Author(s) of the mod. Used in the author filed of modinfo.xml.<br />
*Create project folder: If unchecked then the project files are placed directly in the folder chosen for path. If checked a folder with the entered name will be created in that folder.<br />
<br />
===File explorer===<br />
The file explorer lets you view the contents of vpp_pc and str2_pc files without extracting them manually. You can double click supported file formats like textures to open them. If you single click a vpp_pc or str2_pc file it will expand to show it's contents. Extra info about the file will be shown in the properties panel for some files when single clicking them.<br />
<br />
[[File:Nanoforge ProjectCreationExample3.png|frameless|256px]]<br />
<br />
====Search====<br />
You can use the search bar to limit which files are shown in the file explorer. By default it will only show files with names that contain the search term. You can also use some special characters to specialize your search behavior:<br />
*Start your search with *: Will only show files with names that end with whatever comes after *<br />
*End your search with *: Will only show files with names that start with whatever comes before *<br />
<br />
If you prefer regex you can check the regex search option. Note that the regex search option is much slower than the default one.<br />
<br />
===Properties panel===<br />
The properties panel sometimes will show additional info about files selected in the file explorer. It also may be used by other UI panels to show additional info. For example, it can list object properties when viewing territories (see map viewing section below).<br />
<br />
[[File:Nanoforge_PropertiesPanel2.png|frameless|256px]]<br />
<br />
===Textures===<br />
You can open texture files by double clicking them in the file explorer. Textures are split into two files. Either a cpeg_pc and gpeg_pc file pair or a cvbm_pc and gvbm_pc file pair. You can double click any of these to open a texture. A single RFG texture file can contain multiple textures, which we'll refer to as subtextures. Info about the selected subtexture will be shown below the subtexture list.<br />
<br />
[[File:Nanoforge_TextureDocument.png|frameless|768px]]<br />
<br />
Above is an example of what you might see if you open a texture file. On the sidebar to the left there a few things, in order:<br />
*The subtexture list. Click on one to see more info about it below.<br />
*Texture info. This is info about the selected subtexture.<br />
*Header info. This is general info about the cpeg/cvbm file.<br />
<br />
====Exporting textures====<br />
Textures can be exported to files you can edit with common image editors like Paint.NET, GIMP, or Photoshop. Currently textures can only be exported as .dds files. You can export single subtextures by right clicking one of them and clicking <code>Export...</code>. You can export all subtextures at once with the <code>Export all...</code> button.<br />
<br />
====Editing textures====<br />
Textures can be edited by imported textures you've edited externally. Currently it can only import .dds files. You do this by right clicking a subtexture, clicking <code>Replace...</code> and selecting the file you want to replace the subtexture with. Once you do this it's critical that you press the <code>Save</code> button above the subtexture list to save your edit. This edit will be automatically saved to your current project when you click <code>Save</code>. See [[Nanoforge Texture Editing]] for more info.<br />
<br />
===Meshes===<br />
Nanoforge supports viewing and exporting .csmesh_pc (static mesh) and .ccmesh_pc (character mesh) files. Just like textures, meshes consist of two files. Every csmesh_pc file is paired with a gsmesh_pc file, and every ccmesh_pc file is paired with a gcmesh_pc file. You can click any of them to open a mesh. When you open a mesh you'll first see a blank space. Meshes are loaded on a background thread so it may take a few seconds for the mesh to be loaded and for it's textures to show up. Before its textures are found or if the textures cant be found you might see textures from previously loaded meshes applied to the mesh.<br />
<br />
[[File:Nanoforge_MeshDocument.png|frameless|512px]]<br />
<br />
Above is what you might see if you open a mesh file. There's a few parts of the UI to note, in order:<br />
* The camera button. This lets you control camera settings like speed and location. You can move the camera by holding down the right mouse button and using WASD to move around. If this doesn't work try left clicking on the mesh 3D view. Only the most recently selected mesh reacts to camera controls so if you have several open it'll only move one camera.<br />
* The scene button. This has some rendering settings for the mesh such as scale and lighting color/intensity.<br />
* The info button. This shows some additional info about the mesh such as vertex format, and the LOD slider for meshes with multiple levels of detail.<br />
* The export button. This lets you export the mesh and it's textures to a .obj file, which can be imported into tools like blender.<br />
* The status bar. This shows the loading status and percentage. It will show <code>Done! ✓</code> once loading is complete.<br />
<br />
====Exporting meshes====<br />
To export a mesh:<br />
* Wait for it to finish loading. The status bar will show <code>Done! ✓</code> and 100%.<br />
* Click the export button. Top left of the document, button furthest to the right.<br />
* Select a folder to export the mesh and it's textures to and click <code>Export</code>.<br />
<br />
A single gltf file and the meshes textures will be exported. Each lod level is labelled in the gltf under their own subnode. Currently these gltf files don't look right as is when imported into Blender. This is because GLTF uses a different rendering model than RFG. Typically meshes have a diffuse, specular, and normal texture. Their names end with _d, _s, and _n respectively. You'll need to make the following changes to the textures in the Blender shading tab:<br />
* Diffuse -> Set color space to linear, attach texture color to "Base Color" on the BSDF<br />
* Specular -> Set color space to linear, attach texture color to "Specular" on the BSDF<br />
* Normal -> Set color space to SRGB, attach texture color to "Normal" on the BSDF<br />
<br />
In the near future an extension will be made to automatically patch the shader graph.<br />
<br />
====Camera movement====<br />
To move the camera hold down the right mouse button over the 3D view and use WASD to move around. Holding down shift while moving will cause the camera to move faster. Pressing Q and E will move the camera directly up and directly down respectively.<br />
<br />
===Mod packaging===<br />
Once you're done editing textures you can use Nanoforge to repack the editing files and generate a modinfo.xml for you. To do this, simply click <code>File > Package mod</code> on the main menu bar. Once it's done go to the "Output" folder inside your project folder to see the modinfo.xml and any files that it relies on. These are ready for use with the re-mars-tered mod manager.<br />
<br />
===Map view===<br />
Nanoforge has partial support for viewing maps like the main campaign map. We'll be referring to them as territories as that's how RFG groups together many zones. See [[RF:G Map organization]] for more details on how RFG maps are structured. To open a territory via <code>Tools > Open territory</code> on the main menu bar. Terr01 is the main campaign map territory. A new document should appear when you open a new territory. Camera movement is the same as the mesh viewer. See [[#Camera_movement|camera movement]]. Terrain is loaded in the background so you'll see separate blocks of terrain pop into view as they load. Bounding boxes are drawn for zone objects. With a territory open you should see new information on the zone panel and the zone objects panel. You can dock panels by clicking and dragging on their titles. It's recommended that you dock the zone object list below the zone list so you can see both at once.<br />
<br />
Below is an annotated image of information you can view about territories plus descriptions for each annotation.<br />
<br />
[[File:Nanoforge_W3p0erDiTj.jpg|frameless|1024px]]<br />
<br />
* First, in the top left is the zone list. Territories are made up of one or more zones which in turn have many zone objects. Click a zone to see its object in the zone objects panel (bottom left). By default the zone with the most objects is selected. In this case that's <code>04_06</code>. Note that each zone corresponds to a rfgzone_pc file. So, for example, <code>04_06</code> is really terr01_04_06.rfgzone_pc.<br />
* Next, bottom left is the zone objects list. This lists the objects inside the selected zone. Click an object to see its properties in the properties panel. Some objects have child objects, denoted by having a triangle in front of their name which you can click to expand them. You can filter objects by type inside the filters header. By default some very common objects like navpoints are hidden.<br />
* Finally, in the top right is the properties panel. This shows the properties of the selected zone object.<br />
<br />
==Object Flags==<br />
* Flag 0 (Persistent): Unknown, any objects with this flag have a separate copy stored in a second <code>rfgzone_pc</code> file with its name prefixed with <code>p__.</code> So, for example, Crescent has two <code>rfgzone_pc</code> files. <code>mp_crescent.rfgzone_pc</code> and <code>p_mp_crescent.rfgzone_pc</code>. The objects with the persistent flag are stored in both zone files, while objects without that flag are only stored in <code>mp_crescent.rfgzone_pc</code>. It's consistently used on player spawns, on most siege objectives and on most <code>rfg_movers</code> on Siege maps. It's recommended you don't enable or disable this flag on maps if you're using the Terraform Patch as it contains fixes for missing objects that incorrectly used this flag or were missing it; doing so will cause objects to vanish.<br />
* Flag 1: Unknown<br />
* Flag 2: Unknown <br />
* Flag 3: Unknown; might be related to how the game saves/loads map data from save files (requires more investigation)<br />
* Flag 4: Unknown; seems to always get converted to the runtime flag <code>streaming_fixed</code>, most <code>rfg_movers</code> and <code>general_movers</code> have this flag. If you're using the Terraform Patch it's recommended you don't disable this flag as it applies it to all objects since it was used most of the time and objects missing it were assumed to be an error by Volition. (They also made mistakes with the gamemode and persistent flags)<br />
* Flag 5: Unknown; seems to get converted to the runtime flag <code>force_full_save</code><br />
* Flag 6: Unknown<br />
* Flag 7: Unknown<br />
* Flag 8: Spawns in Anarchy<br />
* Flag 9: Spawns in Team Anarchy<br />
* Flag 10: Spawns in CTF<br />
* Flag 11: Spawns in Siege<br />
* Flag 12: Spawns in Damage Control<br />
* Flag 13: Spawns in Bagman<br />
* Flag 14: Spawns in Team Bagman<br />
* Flag 15: Spawns in Demolition<br />
<br />
==Chunk Flags==<br />
* Applies to <code>rfg_movers</code> & <code>general_movers</code>.<br />
* When editing their properties in the inspector it's possible to change the <code>chunk_flags</code>.<br />
* You can also use <code>gameplay_properties.xtbl</code> to apply these flags and change <code>gameplay_props</code>. If you're using the Terraform Patch a new <code>gameplay_prop</code> named <code>Invulnerable</code> is added which also can be used to make objects indestructible.<br />
* Eg: <code>dynamic_link invulnerable</code> will make the object indestructible. Full list of flags below:<br />
* child_gives_control: Unknown.<br />
* building: Unknown.<br />
* dynamic_link: Unknown.<br />
* world_anchor: Unknown.<br />
* no_cover: Might be where EDF can't take cover behind objects.<br />
* propaganda: EDF propaganda billboards you destroy for the achievement in singleplayer have this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows to track the players progress and reduce EDF control of the sector.<br />
* kiosk: <code>tech_kiosk_EDF_A</code> has this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows its a special object that plays propaganda videos.<br />
* touch_terrain: Unknown, no <code>gameplay_properties.xtbl</code> entries use this flag and it's missing from the table description.<br />
* supply_crate: EDF crates you destroy for the achievement in singleplayer have this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows to track the players progress.<br />
* mining: Ores you mine for salvage and the achievement in singleplayer have this flag in <code>gameplay_properties.xtbl</code>. Probably used so the game knows to track the players progress.<br />
* one_of_many: Unknown, <code>windmill_0708</code>, <code>0102smokestack_86</code> & <code>0102smokestack_86_child</code> have this flag in <code>gameplay_properties.xtbl</code>. Might be related to one of the side activities where you have to destroy multiple targets.<br />
* plume_on_death: Unknown.<br />
* invulnerable: Makes an object indestructible.<br />
* inherit_damaga_pct: Unknown.<br />
* regrow_on_stream: Unknown.<br />
* casts_drop_shadow: Object will cast drop shadows.<br />
* disable_collapse_effect: Unknown.<br />
* force_dynamic: Unknown.<br />
* show_on_map: Most objects in <code>gameplay_properties.xtbl</code>. Most likely means the object will show on the minimap in singleplayer.<br />
* regenerate: Unknown.<br />
* casts_shadow: Object will cast a shadow map.<br />
<br />
==Object Info==<br />
* <code>obj_zone</code> = Defines the wind speed, terrain file name & <code>spawn_resource_data</code>. If you move its location the terrain will no longer have collision.<br />
* <code>MPST</code> = Multiplayer siege target.<br />
* <code>MPDCT</code> = Multiplayer damage control target.<br />
* <code>shape_cutter</code> = Causes object to start off with initial damage, used on damage control targets or maps like crash site, ruins & remnant where they put a hole in the wall.<br />
* <code>spawn_node</code> = Camera view at start of match and end of game. If a map doesn't have a least one of these it will crash.<br />
* <code>spectator_camera</code> = Camera view exclusively for players using the spectator mode, recommended to just ignore adding them and use <code>spawn_nodes</code> instead.<br />
* <code>trigger_region</code> = Killbox that can be set to a mine or cliff.<br />
* <code>rfg_mover</code> = Buildings, backpack racks & more.<br />
* <code>general_mover</code> = Explosive barrels and the <code>backpack_effect_attach.cchk_pc</code> objects for example.<br />
* <code>player_start</code> = Spawn point, can be set to Neutral, EDF or Guerilla.<br />
* <code>item</code> = In multiplayer the bag for bagman is set to <code>item_type</code> "multi_object_bagman_flag" and references <code>items_3d.xtbl</code>.<br />
* <code>weapon</code> = Weapon spawn, <code>weapon_type</code> determines which weapon will spawn and references <code>weapons.xtbl</code>.<br />
* <code>object_effect</code> = Visual effect, eg the fire on Nordic Bonus.<br />
* <code>multi_object_marker</code> = Multiple uses, in multiplayer the <code>marker_type</code> can be set to <code>Backpack rack</code>, <code>Spawn node</code>, <code>Flag capture zone</code>, <code>King of the Hill target</code>, <code>Siege target</code> & <code>Spectator camera</code>.<br />
* <code>cover_node</code> =<br />
* <code>navpoint</code> = Probably where NPCs can navigate, similar to navmeshes in other games.<br />
* <code>object_action_node</code> = <br />
* <code>object_squad_spawn_node</code> = Probably where squads spawn and references various <code>squads.xtbl</code> files.<br />
* <code>object_path_road</code> = Probably where NPCs can drive vehicles.<br />
* <code>object_guard_node</code> =<br />
* <code>object_vehicle_spawn_node</code> = Probably where vehicles can spawn like walkers found around the SP map.<br />
* <code>object_bounding_box</code> = Seems to be only be used in singleplayer, unknown why.<br />
* <code>object_activity_spawn</code> = Probably where you can start a side activity like demolition master for example.<br />
* <code>object_house_arrest_node</code> = Related to the house arrest side activity.<br />
* <code>object_patrol</code> = Probably where EDF patrol.<br />
* <code>object_dummy</code> =<br />
* <code>object_mission_start_node</code> = Probably where you can start a main mission.<br />
* <code>object_restricted_area</code> = Probably where the EDF will attack on sight and you will get an alert level in SP.<br />
* <code>backpack_effect_attach.cchk_pc</code> = Seems to be for attaching the backpack to the player when they spawn, DO NOT TOUCH IT ALL OR THE MAP WILL CRASH WHEN SPAWNING.<br />
<br />
==Object Properties==<br />
* <code>gameplay_props</code> references <code>gameplay_properties.xtbl</code>.<br />
* <code>backpack_type</code> references <code>mp_backpacks.xtbl</code>.<br />
* <code>weapon_type</code> references <code>weapons.xtbl</code>.<br />
* <code>item_type</code> references <code>items_3d.xtbl</code>.<br />
* <code>spawn_resource_data</code> references <code>spawn_resource.xtbl</code>.<br />
* <code>ambient_spawn</code> references <code>ambient_spawn_info.xtbl</code> or <code>dlc01_ambient_spawn_info.xtbl</code>.<br />
* <code>visual</code> references <code>effects.xtbl</code>.<br />
* <code>sound</code> references <code>foley.xtbl</code> (not included in the game for some reason) however there is <code>dlc01_foley.xtbl</code>.<br />
<br />
==Spawn Points==<br />
* <code>mp_team</code> can be set to <code>Neutral</code>, <code>EDF</code> or <code>Guerilla</code>.<br />
* When making a CTF map and you don't want players spawning at the opposing base ensure you disable the Flag <code>Spawn in CTF</code> for any Neutral spawn points.<br />
* Unknown if the <code>respawn</code> and <code>initial_spawn</code> booleans do anything in multiplayer.<br />
* <code>indoor</code> boolean is probably left over from Saints Row since all of RF:G is technically outdoors and no spawn points use this boolean.<br />
* <code>checkpoint_respawn</code> & <code>activity_respawn</code> are only used in singleplayer.<br />
* Foward X axis (blue line) determines player spawn direction.<br />
<br />
==Spawn Nodes==<br />
* Camera views at the start of match or when a player dies and is spectating.<br />
* Foward X axis (blue line) determines player camera direction & view.<br />
* If a map doesn't have at least one <code>Spawn node</code> it will crash when loading.<br />
<br />
==Spectator Cameras==<br />
* Believed to be similar to a <code>Spawn node</code> but used exclusively by players using the spectator option in matchmaking. Recommended to just ignore adding these since the community only plays custom games and adding <code>Spawn nodes</code> to your map will serve the same purpose.<br />
* Foward X axis (blue line) determines player camera direction & view.<br />
* These camera views are also shared with <code>Spawn nodes</code> at start of match or when a player dies and is spectating.<br />
<br />
==Mover Types==<br />
* Applies to <code>rfg_movers</code><br />
* When editing their properties it's possible to change the <code>mtype</code> field to the corresponding numbers<br />
* Fixed = 0 (default)<br />
* Normal = 1 (unknown)<br />
* Lite = 2 (unknown)<br />
* Ultra Lite = 3 (unknown)<br />
* World Only = 4 (no collision but you can still destroy it with a hammer for example)<br />
* No Collision = 5 (no collision)<br />
<br />
==Damage Control Targets==<br />
# Deep clone <code>MPDCT_MAPNAME_XXX</code>.<br />
# Move </code>MPDCT_MAPNAME_XXX</code> to the location of your choosing.<br />
# In object properties for the parent change <code>display_name</code> to whatever you want your new damage control objective to be called.<br />
# If you're making a map that doesn't already have a damage control target you can open it in another tab and use the deep clone feature. If you're using the Terraform Patch the majority of Wrecking Crew maps will already have the asset along with all Siege maps.<br />
# It's also possible to have only <code>1</code> target & more than <code>3</code>. The limit before the game will crash is a total of <code>6</code> targets when tested solo. The limit might be lower when played with other people but needs to be tested more.<br />
# It's also possible that using the same <code>display_name</code> name for each target can introduce instability.<br />
# The only valid value for the <code>mp_team</code> property is <code>Neutral</code>. If you change the team to <code>EDF</code> or <code>Guerilla</code> and disable the <code>shape_cutter</code> child so the target starts off intact it will belong to that team but not score any points until it's destroyed and repaired.<br />
# You can disable the <code>shape_cutter</code> child so the target starts off intact instead of destroyed like it is by default.<br />
# Any object can be used for a target if you add the <code>multi_object_marker</code>, <code>shape_cutter</code> and offset them correctly from the parent. See Stratosphere if using the Terraform Patch for how to do this; shipping containers are the targets added on that map in the patch.<br />
<br />
==Siege Targets==<br />
# Open a siege map in one tab, open a regular map with the same objects in another tab.<br />
# Deep clone the siege target to the regular map.<br />
# Move the added siege target to the exact same location as the existing matching object on the regular map.<br />
# Disable all the gamemode flags for the added siege target except for "Spawn in Siege" including its children.<br />
# Delete all the children of the siege targets (usually spawns that will be outside the map since they were deep cloned from the siege map), after they are all deleted make sure to "orphan children" of the child to ensure it doesn't have ghost children. <br />
# Disable the <code>Spawn in siege</code> flag on the matching original map object.<br />
# You need to update <code>mp_levels.xtbl</code> so the map is selectable in siege.<br />
# Ensure the siege target and its child have the persistent flag.<br />
# The <code>priority</code> property for the <code>Siege target</code> child determines which siege objects are unlocked to destroy, eg if you set it to <code>1</code> it would be the first target the attackers can destroy, you can have multiple targets unlocked by using the same number and if you wanted to have targets unlocked one at a time you would use <code>1</code>, <code>2</code>, <code>3</code> and so on. If you use a value of <code>4294967295</code> they are also unlocked at the same time.<br />
# You must use an existing string in the game for the <code>display_name</code> property on the child or the map will crash.<br />
# If you mess up the offset of the child the map will crash.<br />
<br />
==Backpack Racks==<br />
* Make sure you deep clone them when adding new racks, the child <code>Backpack rack</code> is required for it to work properly.<br />
* Ensure that when moving the rack to a new location you only move the parent (the child will follow and be offset correctly), they will be named <code>Jetpack</code> for example if you're using the Terraform Patch.<br />
* When editing the child <code>backpack_type</code> determines which backpack will spawn, most are the same as their in game names with the exception of Firepower <code>Commando</code> & Concussion <code>Shockwave</code>. These names are from <code>mp_backpacks.xtbl</code>.<br />
* When editing the child you can change the number of backpacks on a rack, edit <code>num_backpacks</code> and change it from a value ranging from <code>0-3</code>, although <code>0</code> would mean the rack is empty and useless.<br />
* When editing the child it's possible to make it team exclusive, this means only the EDF or Red Faction can pickup backpacks from that rack during team game modes. Edit <code>mp_team</code> and enter either <code>EDF</code> or <code>Guerilla</code>. In game that rack will have a green glow around it if your team can use it.<br />
* The <code>random_backpacks</code> boolean in the object properties for the <code>Backpack rack</code> child doesn't seem to do anything.<br />
* It's possible to make Backpack Racks destructable by changing <code>gameplay_props</code> to <code>Default</code>. During team game modes teams can fight for control by destroying racks and repairing them so only their team can use them. Racks you're able to use will glow green and racks you can't will glow red if you're using the Terraform Patch.<br />
* The maximum number of Backpack Racks you can have on a map before it causes issues is <code>25</code>.<br />
<br />
==Capture the Flag targets==<br />
* The EDF and Red Faction have their own unique flag stand placed near their team spawns on regular multiplayer maps.<br />
* Make sure you use deep cloning and only move the parent when placing or moving them so the child is offset correctly.<br />
* Objects are called <code>edf_flag_stand.cchk_pc</code> & <code>guerrilla_flag_stand.cchk_pc</code>.<br />
* If you attempt to add more than two stands to a map, the extras will not work as capture points and only the asset will appear.<br />
* <code>Neutral</code> is not a valid value for <code>mp_team</code>.<br />
<br />
==Bagman Objective Spawn==<br />
* Object is an <code>item</code> type referencing <code>items.3d_xtbl</code>.<br />
* Ignore the varying bounding box sizes when positioning the bag spawn, the XYZ axis position is what matters (the red, blue & green lines).<br />
* The <code>respawn</code> boolean doesn't do what you expect, the bag will still return to the original spawn point regardless if it's enabled or not.<br />
* You can't place more than one bag on a map, only one will spawn.<br />
* You can have different bag locations in Bagman and Team Bagman by using the gamemode flags.<br />
<br />
==Weapon Spawns==<br />
* You should clone other weapons to add new ones, if you make them from scratch and don't get the bounding box correct for certain weapons it can cause duplicate weapon spawns in some cases.<br />
* <code>weapon_type</code> determines which weapon will spawn and references <code>weapons.xtbl</code>.<br />
* The <code>preplaced</code> boolean needs more testing but you can disable weapons in certain game modes by disabling the game mode flags anyway.<br />
* The <code>respawns</code> boolean will cause the weapon to not re-spawn again during a match after it has been picked up for the first time.<br />
* Ensure the bounding box is slightly above the ground/floor when positioning weapons.<br />
<br />
==Trigger Regions==<br />
* In multiplayer & singleplayer these are used to prevent the player from going out of bounds.<br />
* <code>region_kill_type</code> can be set to a <code>cliff</code> or a <code>mine</code>. A cliff will cause the player to fall to their death, while a mine will explode and kill the player; this is also reflected in the killfeed message in multiplayer.<br />
* In singleplayer the <code>trigger_flags</code> can be changed so the trigger isn't enabled during missions and/or activities. Eg. <code>not_in_mission</code> will disable it during a main mission, <code>not_in_activity</code> would disable it during a side activity and <code>not_in_mission not_in_activity</code> would disable it during both.<br />
* The <code>enabled</code> boolean allows mappers to enable/disable the region.<br />
<br />
==Object Effects==<br />
* Plays an effect such as smoke, fire, explosion, sparks, etc. Also can play sounds if the effect has one in <code>effects.xtbl</code> and the sound string is used.<br />
* <code>sound_alr</code> = Unknown. <br />
* <code>sound</code> = The name of the sound in <code>effects.xtbl</code><br />
* <code>visual</code> = The name of the effect in <code>effects.xtbl</code><br />
* <code>looping</code> = Controls if the effect will play once or continuously.<br />
<br />
==Shape Cutters==<br />
* Used to damage or cut holes into destructible objects ahead of time.<br />
* <code>outer_radius</code> = Unknown.<br />
<br />
==Maps with names different from their in-game names==<br />
* wc1 - Complex<br />
* wc2 - Watchtower<br />
* wc3 - Scrapheap<br />
* wc4 - Vista<br />
* wc5 - Fortress<br />
* wc6 - Factory<br />
* wc7 - Gulch<br />
* wc8 - Cascade<br />
* wc9 - Transmission<br />
* wc10 - Pipeline<br />
* wcdlc1 - Ruins<br />
* wcdlc2 - Repercussion<br />
* wcdlc3 - Imperial<br />
* wcdlc4 - Expansion<br />
* wcdlc5 - Frost<br />
* wcdlc6 - Abandoned<br />
* wcdlc7 - Stratosphere <br />
* wcdlc8 - Invasion<br />
* wcdlc9 - Nordic Bonus<br />
* mpcx_crossover - Doubletime<br />
* mpcx_assembly - Outpost <br />
* mpdlc_landbridge - Equilibrium<br />
* mpdlc_islands - Haven<br />
* mpdlc_minibase - Complex<br />
* mpdlc_overhang - Gradient<br />
* mpdlc_ruins - Remnant<br />
<br />
==Maps with similar terrain==<br />
* Crash Site/Complex/Nordic Bonus<br />
* Rift/Factory<br />
* Remnant/Ruins<br />
* Broadside/Invasion<br />
* Wasteland/Gulch<br />
* Outpost/Framework<br />
* Radial/Transmission<br />
* Sand Pit/Division/Watchtower<br />
* Tutorial Area/Pipeline<br />
* Pinnacle/Fortress<br />
<br />
==Misc Notes==<br />
* Deep clone objects if you want to keep the children of an object and use regular clone if you just want to clone the parent. Only move the parent when deep cloning and the children will follow and be offset correctly.<br />
* If you see anything that looks like XML inside <code>layer_pc</code> or <code>rfgzone_pc</code> files you can ignore that as we're 99% sure it's junk from their file packer reusing memory without zeroing it out.<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail.<br />
<br />
===Localization strings===<br />
While Nanoforge is only in English at the moment it can view localized strings used by RFG. RFG uses placeholder strings in many xtbls which are replaced with their localization at runtime. These are shown automatically in the xtbl editor. You can also view a list of all localized strings via <code>Tools > Localization > View localized strings</code>. You can search by placeholder by checking "Search by identifier". You must fully enter the identifier without typos for this to work since it's comparing it to a hash of the identifier stored in the games localization files.<br />
<br />
[[File:Nanoforge_LocalizedStringList0.png|frameless|768px]]<br />
<br />
===Scriptx viewer===<br />
RFG uses an xml based scripting system called scriptx for some mission logic. The viewer is an attempt at making it easier to read scriptx files which can be difficult to understand. It's a low priority feature so it likely won't see changes for a while but was enabled in case it's useful to people editing scriptx files. You still need to edit them by hand but it can help make it clearer what a script is doing. You can access it via <code>View > Scriptx Viewer (WIP)</code>.<br />
<br />
[[File:Nanoforge_ScriptxViewer0.png|frameless|768px]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Game_Night_News&diff=8960RF:G Game Night News2023-06-19T03:10:06Z<p>Camo: /* Troubleshooting */</p>
<hr />
<div>{{Under construction}}<br />
<br />
== News ==<br />
<br />
* Terraform Patch v1.07.5 was recently released on the 8th of June, 2023. Please update before game night!<br />
* SyncFaction v9 was recently released on the 14th of March, 2023. Please update before game night!<br />
<br />
== Multiplayer Server Status ==<br />
<br />
* Steam version: Fix already included in latest update from Steam.<br />
* GOG version: You will need to manually replace <code>sw_api.dll</code> in the <code>Red Faction Guerrilla Re-Mars-tered</code> folder with the one from here: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_debug/mp_fix/gog/sw_api.dll<br />
<br />
== Installing Terraform Patch ==<br />
<br />
# Download https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
# Open SyncFaction.<br />
# The first time you run it SyncFaction will take some time verifying your game files are vanilla, if you encounter any errors please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game in Steam. You can quickly find your game folder by right clicking RF:G in your Steam library, selecting properties, clicking Local files and finally Browse. Verify integrity of game files is also found here.<br />
# After SyncFaction is done verifying you will see a button at the bottom middle <code>Update to latest Community Patch</code>, click it & SyncFaction will automatically download and install the patch; you will see the progress tracked in the log.<br />
# When it has successfully installed the patch you will see this wiki page instead of the log along with <code>Run Game</code>, <code>Apply</code> & <code>Refresh</code> buttons, you don't need to do anything else and can close SyncFaction now.<br />
<br />
== Updating Terraform Patch ==<br />
<br />
* If you've played game nights before, get latest SF version and let it do the update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* No need to waste time verifying game with Steam!<br />
<br />
== Troubleshooting ==<br />
<br />
* Make sure you're on the latest SF version and update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* If you suspect your game is corrupted, please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game.<br />
* Sometimes after installing the required .NET version you will need to restart your computer for SF to work.<br />
* '''DON'T''' install any mods or maps on top of the patch or you'll corrupt your game!<br />
* '''DON'T''' use RSL1 for the Steam version of the game, it won't allow you into multiplayer due to cheating concerns.<br />
* If you have both the Steam & GOG versions installed, lots of drives or SF is having issues finding your game install try putting <code>SyncFaction.exe</code> with <code>rfg.exe</code> in the respective game versions folder.<br />
* If your anti virus detects <code>SyncFaction.exe</code> as malware you can be assured it's a false positive, it's open source on github and developed by a trusted member of the community. You can safely make an exception in your anti virus software.<br />
* If SyncFaction has trouble downloading the patch and shows an error starting with <code>System.Net.Http.HttpRequestException</code> it's probably being blocked by your firewall.<br />
* If your game crashes on startup it's possible you incorrectly replaced <code>sw_api.dll</code> for the Steam version when that is only needed for the GOG version, try restoring it to the Steam version: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_debug/mp_fix/steam/sw_api.dll<br />
* If you're unable to move your character, pause the game and then unpause.<br />
* If your GPU only has 1gb of VRAM try turning down all graphics settings down to minimum.<br />
* '''NUCLEAR''' option if other troubleshooting steps above fail or your game is frequently crashing: delete the entire <code>data</code> folder and verify game in Steam. If using GOG completely uninstall the game and install from scratch and then use the latest SF version to re-install the Terraform Patch.<br />
* This app release is not tested thoroughly so please be patient & report any bugs to rast1234.<br />
<br />
=== Saving Space ===<br />
<br />
* After you've updated to the current latest version of the patch it's safe to delete the <code>\data\.syncfaction\mod_xxx</code> folders.<br />
* This is because previous patch versions are cached there and not needed since last update is not incremental.<br />
<br />
=== Confirming Patch Installed Correctly === <br />
<br />
* On the first loading screen before the main menu you should see <code>Terraform Patch v1.075 ALPHA</code> at the bottom right. Example: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/misc.vpp_pc/E_TEXTURE_CHANGES/SOURCE/ui_loading_init.png?raw=true<br />
* When creating a custom match the default options should have fleetfoot selected as the starting backpack.<br />
* You should see DLC Wrecking Crew & custom maps when going through map selection such as Storage, Abandoned, Nordic Bonus, Ruins, Imperial etc.<br />
* You should see DLC Weapons when going through weapons such as the Subverter, Spiker, Misslepod etc.<br />
* You should see new characters in the multiplayer customization screen such as Jenkins, Sam, Voice of Mars etc.<br />
<br />
=== Networking Issues === <br />
<br />
* As the game relies on THQN servers and it seems NAT punching isn't always reliable some connection issues like not being able to join certain players, players not being able to join you or an unusual issue where you're stuck spectating when the game begins may require manual configuration of your network to resolve.<br />
* Ensure <code>rfg.exe</code> isn't blocked by the Windows Firewall for both <code>Inbound</code> and <code>Outbound</code> connections. You can make new rules to <code>Allow the connection</code> for both <code>Inbound</code> and <code>Outbound</code> by searching for <code>Windows Defender Firewall with Advanced Security</code>. See the guide below for more advanced instructions.<br />
* Ensure all the games ports are forwarded in your routers firewall: you will need to setup a Static IP on your computer and forward the following ports in your router: <code>TCP: 80</code>, <code>UDP: 88</code>, <code>TCP/UDP: 443</code>, <code>TCP/UDP: 3074</code>, <code>UDP: 3478</code>, <code>UDP: 4379-4380</code>, <code>TCP/UDP: 23022</code>, <code>TCP/UDP: 38888</code>, <code>TCP/UDP 27000-27100</code> & <code>TCP/UDP: 61111</code>. Consult your routers manual on how to do this and see the guide below for detailed instructions on setting up a Static IP.<br />
* You can also setup DMZ for your Static IP but this is less secure. Consult your routers manual on how to do this.<br />
* It's possible your ISP is blocking ports, you can try using their app if they provide one or calling them and asking them to unblock all ports.<br />
* It's possible issues may be caused by a bad router/modem.<br />
* [https://www.howtogeek.com/19249/how-to-assign-a-static-ip-address-in-xp-vista-or-windows-7/ How to Assign a Static IP Address in Windows 10 or 11]<br />
* [https://www.howtogeek.com/112564/how-to-create-advanced-firewall-rules-in-the-windows-firewall/ How to Create Advanced Firewall Rules in the Windows Firewall]<br />
<br />
=== Configs & Save Data Corruption ===<br />
<br />
* It's unknown if this is required but it might be worth a try if you've followed all previous troubleshooting steps and you're still having issues with your game.<br />
* Delete <code>config.ini</code> in <code>%APPDATA%\kaiko\rfg\</code>. This will reset all your settings to default and you will have to reconfigure them the next time you start your game.<br />
* Steam save: <code><Steam-folder>\userdata\<user-id>\667720\remote\</code> or <code><Steam-folder>\userdata\<user-id>\667720\remote\autocloud\save</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* GOG save: <code>%LOCALAPPDATA%\GOG.com\Galaxy\Applications\51153410217180642\Storage\Shared\Files\autocloud\save\</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* Note: It's possible to transfer the Steam save to GOG or vice versa so you can try that also.<br />
<br />
=== Improving Game Stability ===<br />
<br />
# Right click <code>rfg.exe</code> in your game folder.<br />
# Select <code>Properties</code> in the context menu.<br />
# Select the <code>Compatibility</code> tab.<br />
# Tick <code>Disable fullscreen optimizations</code>.<br />
# Click <code>Change high DPI settings</code>.<br />
# Tick <code>Override high DPI scaling Behavior. Scaling performed by: Application</code>.<br />
# Click ok to both windows.<br />
# If on Windows 11 follow the below additional steps.<br />
# Open the <code>Settings</code> app.<br />
# Navigate to System > Display > Graphics > Add an app > Desktop app > Find <code>rfg.exe</code>.<br />
# Once it's added, search for rfg and click <code>Options</code>.<br />
# Tick <code>Don't use optimizations for windowed games</code>.<br />
# Make sure you select exclusive fullscreen inside the games option menu.<br />
[[File:GameStabilityFix.jpeg|frameless|512px]]<br />
<br />
=== Microstuttering Fix ===<br />
<br />
* Disable '''VSYNC''' in the games option menu.<br />
* Force '''VSYNC''' in your graphics card control panel. <br />
* Cap the framerate to your refresh rate in your graphics card control panel.<br />
* Make sure you select exclusive fullscreen inside the games option menu.<br />
<br />
== Terraform Patch Info ==<br />
<br />
* Changelog: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/changelog.txt<br />
* Known Issues: https://github.com/users/CamoRF/projects/3/views/1<br />
* Github: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch<br />
* This patch is an alpha version so you may encounter bugs, please ping Camo in the rfg-modding channel to report any issues.<br />
<br />
== Recommended Competitive Game Settings ==<br />
<br />
* Note: settings are always personal preference but this should serve as a decent starting guide if you want to play more competitively.<br />
* The default keybindings for RF:G are unusual compared to other shooters, most members in the community recommend the following settings:<br />
* All options are found under <code>Main Menu</code> --> <code>Options</code><br />
<br />
* Controls & Keybindings<br />
* Zoom: Right Click<br />
* Melee Attack: F<br />
* Melee Attack 2: Side Mouse Button if your mouse has one<br />
* Shoulder Switch: Side Mouse Button if your mouse has one<br />
* Zoom: Hold<br />
* Crouch: Toggle<br />
<br />
* Audio Options (These will allow you to hear enemy movement more clearly)<br />
* Ambience: 50%<br />
* Music: 0%<br />
* Voice: 50%<br />
* SFX: 100%<br />
<br />
* Graphics Options<br />
* FOV: 85<br />
* Depth of Field: Disabled<br />
* Motion Blur: Disabled<br />
<br />
* Game Options<br />
* Camera Shake: Disabled<br />
<br />
== Run game ==<br />
<br />
All maps are included in the Terraform Patch and you don't need to install anything else. Join the [https://discord.gg/factionfiles FactionFiles Discord] and subscribe to RF:G Game Night event!</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Editing_Main_Page&diff=8959RF:G Editing Main Page2023-06-18T21:49:47Z<p>Camo: </p>
<hr />
<div>{{RFGEditing}}<br />
{{Under construction}}<br />
<br />
This will serve as a landing page for all resources related to [[Red Faction: Guerrilla]] editing for the '''Re-Mars-tered Edition'''.<br />
<br />
==External Links==<br />
===Community===<br />
*[https://discord.gg/factionfiles Faction Files Community Discord] - Active Red Faction series community Discord with #map-mod-development channel for community development discussion<br />
===Downloads===<br />
*[https://www.factionfiles.com/ff.php?action=files FactionFiles.com] - Custom mods, tools, patches, and reference material<br />
*[https://www.nexusmods.com/redfactionguerilla/mods/ Nexus Mods] - Custom mods<br />
*[https://www.nexusmods.com/redfactionguerrillaremarstered/mods/ Nexus Mods Re-Mars-tered] - Custom mods<br />
<br />
==Documentation==<br />
*[[RF:G Map organization]]<br />
*[[Nanoforge basics]]<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail<br />
===Core Concepts===<br />
*[[Red Faction: Guerrilla]]'s level editor is [[CLOE]], which is not publicly available.<br />
<br />
===Red Faction: Guerrilla File Formats===<br />
* <code>.xtbl</code> - XML table files are used to store properties or attributes in Red Faction: Guerrilla. Overall, their function is similar to the <code>.tbl</code> files of Red Faction and Red Faction II.<br />
* <code>.scriptx</code> - Internal script engine file, commonly used for missions and activities<br />
* <code>.dtodx</code> - Weather/lighting file for maps that controls things like fog, tint, ambient colour, eye adaption, bloom, cloud color and speed<br />
* <code>.gtodx</code> - Skybox file for maps that controls things like the sun texture, moon positions and if the horizon mountain texture is enabled<br />
* <code>.vpp_pc</code> - Packfile<br />
* <code>.rigx</code> - Rig<br />
* <code>.str2_pc</code> - Texture Packfile<br />
* <code>.rfgzone_pc</code> - Map zone<br />
* <code>.layer_pc</code> - Map zone<br />
* <code>.cpeg_pc, cvbm_pc</code> - Texture cpu file<br />
* <code>.gpeg_pc, gvbm_pc</code> - Texture gpu file<br />
* <code>.asm_pc</code> - Streaming index<br />
* <code>.csmesh_pc</code> - Static mesh cpu file<br />
* <code>.gsmesh_pc</code> - Static mesh gpu file<br />
* <code>.ccmesh_pc</code> - Character mesh cpu file<br />
* <code>.gcmesh_pc</code> - Character mesh gpu file<br />
* <code>.ccar_pc</code> - Vehicle mesh cpu file<br />
* <code>.gcar_pc</code> - Vehicle mesh gpu file<br />
* <code>.anim_pc</code> - Animation<br />
* <code>.cchk_pc</code> - Destructible object cpu file<br />
* <code>.gchk_pc</code> - Destructible object gpu file<br />
* <code>.cefct_pc</code> - Visual effect cpu file<br />
* <code>.gefct_pc</code> - Visual effect gpu file<br />
* <code>.cfmesh_pc</code> - Foliage mesh<br />
* <code>.cstch</code> - Terrain clutter mesh cpu file<br />
* <code>.gstch</code> - Terrain clutter mesh gpu file<br />
* <code>.cterrain_pc</code> - Terrain zone cpu file<br />
* <code>.gterrain_pc</code> - Terrain zone gpu file<br />
* <code>.ctmesh_pc</code> - Terrain subzone cpu file<br />
* <code>.gtmesh_pc</code> - Terrain subzone gpu file<br />
* <code>.fsmib</code> - Fullscreen map data<br />
* <code>.fxo_kg</code> - Shader<br />
* <code>.le_strings</code> - Steam localization strings<br />
* <code>.rfglocatext</code> - Localization strings<br />
* <code>.mat_pc</code> - Render material<br />
* <code>.morph_pc</code> - Animation Morph<br />
* <code>.vint_doc</code> - UI<br />
* <code>.sim_pc</code> - Cloth sim<br />
* <code>.xgs_pc</code> - Sound config<br />
* <code>.xsb_pc</code> - Soundbank<br />
* <code>.xwb_pc</code> - Wavebank<br />
* <code>.aud_pc</code> - Audio categories<br />
* <code>.vf3_pc</code> - Font<br />
* <code>.vfdvp_pc</code> - ?<br />
* <code>.rfgvp_pc</code> - ?<br />
<br />
===Red Faction: Guerrilla File Structure===<br />
<br />
\Red Faction Guerrilla Re-MARS-tered\data\<br />
<br />
The two most important files for modding most of RF:G are <code>misc.vpp_pc</code> & <code>table.vpp_pc</code><br />
<br />
* <code>activities.vpp_pc</code> - contains textures for singleplayer activities<br />
* <code>anims.vpp_pc</code> - contains animation files<br />
* <code>chunks.vpp_pc</code> - contains <code>.rfgchunkx</code> files and seems to be related to the <code>preload_chunks.xtbl</code> file, it's possible to add them to a map using the correct <code>dest_checksum</code> & <code>uid</code> numbers. Game might also spawn <code>missing_chunk</code> or <code>missing_destroyable</code> if a mesh fails to load.<br />
* <code>cloth_sim.vpp_pc</code> - contains cloth simulation files<br />
* <code>decals.vpp_pc</code> - contains decal textures<br />
* <code>dlc01_l0.vpp_pc</code> - singleplayer DLC map<br />
* <code>dlc01_l1.vpp_pc</code> - only contains a blank <code>asm_pc</code> file<br />
* <code>dlc01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer DLC map<br />
* <code>dlcp01_activities.vpp_pc</code> - contains textures for singleplayer DLC activities<br />
* <code>dlcp01_anims.vpp_pc</code> - contains animation files for singleplayer DLC<br />
* <code>dlcp01_cloth_sim.vpp_pc</code> - contains cloth simulation files for singleplayer DLC<br />
* <code>dlcp01_effects.vpp_pc</code> - contains visual effect files for singleplayer DLC, some are <code>.str2</code><br />
* <code>dlcp01_humans.vpp_pc</code> - contains textures and meshes for characters in singleplayer DLC<br />
* <code>dlcp01_interface.vpp_pc</code> - contains textures for loading screens & thumbnails in singleplayer DLC<br />
* <code>dlcp01_items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in singleplayer DLC<br />
* <code>dlc01_misc.vpp_pc</code> - contains <code>.rig_pc</code> files, the <code>.fsmib</code> file and two <code>.xtbl</code> files for singleplayer DLC<br />
* <code>dlc01_missions.vpp_pc</code> - contains textures related to singleplayer DLC missions<br />
* <code>dlcp01_personas_en_us.vpp_pc</code> - <br />
* <code>dlcp01_vehicles.vpp_pc</code> - contains textures and meshes for singleplayer DLC vehicles<br />
* <code>dlcp01_voices_en_us.vpp_pc</code> -<br />
* <code>dlcp02_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for multiplayer DLC<br />
* <code>dlcp02_misc.vpp_pc</code> - <br />
* <code>dlcp03_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for wrecking crew DLC<br />
* <code>dlcp03_misc.vpp_pc</code> -<br />
* <code>effects.vpp_pc</code> - contains visual effect files, some are <code>.str2</code><br />
* <code>effects_mp.vpp_pc</code> - contains multiplayer only visual effect files, some are <code>.str2</code><br />
* <code>humans.vpp_pc</code> - contains textures and meshes for characters in both singleplayer and multiplayer<br />
* <code>interface.vpp_pc</code> - contains textures for loading screens & thumbnails in both SP and MP and character portraits in multiplayer<br />
* <code>items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in both singleplayer & multiplayer<br />
* <code>items_mp.vpp_pc</code> - contains multiplayer only textures and meshes<br />
* <code>misc.vpp_pc</code> contains <code>.xtbl</code> files and most other file types<br />
* <code>missions.vpp_pc</code> - contains textures for singleplayer missions<br />
* <code>mp_common.vpp_pc</code> - contains textures shared between multiplayer maps<br />
* <code>mp_xxx.vpp_pc</code> - multiplayer maps, excluding <code>mp_common.vpp_pc</code><br />
* <code>mpdlc_xxx.vpp_pc</code> - DLC multiplayer maps<br />
* <code>personas_de_de.vpp_pc</code> -<br />
* <code>personas_en_us.vpp_pc</code> - <br />
* <code>personas_es_es.vpp_pc</code> - <br />
* <code>personas_fr_fr.vpp_pc</code> -<br />
* <code>personas_it_it.vpp_pc</code> -<br />
* <code>personas_ru_ru.vpp_pc</code> -<br />
* <code>rfg_cine_00a.bik_xbox2</code> -<br />
* <code>rfg_cine_01a.bik_xbox2</code> -<br />
* <code>rfg_cine_02a.bik_xbox2</code> -<br />
* <code>rfg_cine_03a.bik_xbox2</code> - <br />
* <code>rfg_cine_03b.bik_xbox2</code> - <br />
* <code>rfg_cine_04a.bik_xbox2</code> - <br />
* <code>rfg_cine_05a.bik_xbox2</code> - <br />
* <code>rfg_cine_06a.bik_xbox2</code> - <br />
* <code>skybox.vpp_pc</code> - contains textures for the skybox like the clouds<br />
* <code>sounds_r.vpp_pc</code> - contains <code>.xmb_pc</code> sound files<br />
* <code>steam.vpp_pc</code> -<br />
* <code>table.vpp_pc</code> - contains only <code>.xtbl</code> files and will overwrite <code>.xtbl</code> files in <code>misc.vpp_pc</code><br />
* <code>terr01_l0.vpp_pc</code> - singleplayer map<br />
* <code>terr01_l1.vpp_pc</code> - singleplayer map<br />
* <code>terr01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer map<br />
* <code>vehicles_r.vpp_pc</code> - contains textures and meshes for singleplayer vehicles<br />
* <code>voices_de_de.vpp_pc</code> - <br />
* <code>voices_en_us.vpp_pc</code> - <br />
* <code>voices_es_es.vpp_pc</code> - <br />
* <code>voices_fr_fr.vpp_pc</code> - <br />
* <code>voices_it_it.vpp_pc</code> - <br />
* <code>voices_ru_ru.vpp_pc</code> -<br />
* <code>wcxxx.vpp_c</code> - wrecking crew maps<br />
* <code>zonescript_dlc01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer DLC map<br />
* <code>zonescript_terr01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer map<br />
* <code>xxx.bik</code> - pre-rendered custscenes<br />
<br />
===Scriptx Functions===<br />
<br />
* [https://www.factionfiles.com/ff.php?action=scriptxfuncs .scriptx functions]<br />
<br />
===Primitive data types & limits===<br />
<br />
* Floats (floating decimal points): Max value <code>3.4028237</code> and move the decimal place right 38 times. Examples: <code>1.0, 0.0</code><br />
* Integer (whole number that could hold a zero, positive or negative value): Max value <code>2147483647</code><br />
* Boolean (truth value with two constants objects True and False , basically a toggle to enable or disable something using "true" or "false"): Examples: <code><Unlocks_Cheat>True</Unlocks_Cheat>, <Unlocks_Cheat>False</Unlocks_Cheat></code><br />
* String (represents a sequence or characters/text): Example: <code><string>OldCoot</string></code><br />
<br />
===sounds_r.vpp_pc Info===<br />
<br />
* S16 = Signed 16 bit<br />
* LE = Little endian<br />
* 2CH = 2 channels (stereo)<br />
<br />
* destruction.xwb_pc - unknown<br />
* dlc01_voc_d01offcam.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01dan.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm02.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm03.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm04.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm05.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm06.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01rfc.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01sam_pcm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01vasha_safe.xwb_pc.en_us.xwb_pc - unknown <br />
* mov_foley.xwb_pc - unknown <br />
* mov_jet_pack.xwb_pc - unknown <br />
* mov_male.xwb_pc - unknown <br />
* mov_npc_male.xwb_pc - unknown <br />
* mp_backpacks.xwb_pc - S16, LE, 2CH. Intermittent static starting ~28sec <br />
* mp_wep.xwb_pc - S16, LE, 2CH. Static at start and end <br />
* mus_briefings.xwb_pc - S16, LE, 2CH. <br />
* mus_demomaster.xwb_pc - S16, LE, 2CH. <br />
* mus_frontend.xwb_pc - S16, LE, 2CH. <br />
* mus_multiplayer.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_01.xwb_pc - S16, LE, 2CH. Static at start, may be header <br />
* mus_progression_02.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_03.xwb_pc - S16, LE, 2CH. <br />
* mus_sting.xwb_pc - S16, LE, 2CH. <br />
* obj_shared_ambient.xwb_pc - unknown<br />
* obj_shared_dth.xwb_pc - unknown <br />
* obj_shared_exp.xwb_pc - unknown<br />
* obj_shared_impact.xwb_pc - unknown <br />
* scripted_raids.xwb_pc - unknown <br />
* system.xwb_pc - S16, LE, 2CH. Mostly static, valid sound in middle <br />
* system_mp.xwb_pc - unknown <br />
* veh_civ_bus.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car1.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car2.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car3.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_flat.xwb_pc - unknown <br />
* veh_civ_flat2.xwb_pc - unknown<br />
* veh_civ_fuel.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_hauler.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_taxi.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_trash.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_walker.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_aax.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_abx.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_apc.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_atank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_htank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_mtank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_scout.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staff.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staffh2h.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_raider.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_atv.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_bull.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_dtruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_etruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_pickup.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_rover.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_roverwk.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supplyrt.xwb_pc - unknown<br />
* veh_min_wlklg.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_wlkmd.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_shared.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* walla.xwb_pc - unknown<br />
* weather.xwb_pc - S16, LE, 2CH.<br />
* wep_rfg.xwb_pc - S16, LE, 2CH. Mostly valid, some static<br />
<br />
===RfgUtil Guide===<br />
<br />
* Unpacking [Placeholder]<br />
* Repacking [Placeholder]<br />
* Command arguments [Placeholder]<br />
* Scripts [Placeholder]<br />
* Updating <code>.asm_pc</code> files [Placeholder]<br />
<br />
===Misc Notes===<br />
<br />
* When repacking <code>.vpp_pc</code> files don't compress and/or condense them if they weren't like that in the vanilla game, it will cause the game to crash. Eg: <code>items.vpp_pc</code>, <code>interface.vpp_pc</code>, map files etc. See the table below:<br />
* <code>table.vpp_pc</code> overwrites changes to <code>.xtbl</code> files in <code>misc.vpp_pc</code>. The work around for this with the legacy mod manager is to rename the file however this breaks multiplayer and reduces the stability of the game. You should edit the same <code>.xtbl</code> files in both <code>misc.vpp_pc</code> & <code>table.vpp_pc</code>.<br />
<br />
{| class="wikitable"<br />
|+<br />
|-<br />
! Filename !! Alignment !! Compressed !! Condensed<br />
|-<br />
| ALL .str2 || 0 || Yes || Yes<br />
|-<br />
| MOST .vpp_pc || 2048 || No || No<br />
|-<br />
| dlc01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlcp01_misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| mp_common.vpp_pc || 2048 || Yes || No<br />
|-<br />
| steam.vpp_pc || 2048 || Yes || No<br />
|-<br />
| terr01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_dlc01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_terr01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlc01_l1.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp01_voices_en_us.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp02_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| dlcp03_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| anims.vpp_pc || 16 || Yes || Yes<br />
|-<br />
| table.vpp_pc || 64 || Yes || Yes<br />
|-<br />
| skybox.vpp_pc || 4096 || No || No<br />
|-<br />
| dlcp01_personas_en_us.vpp_pc || 4096 || No || No<br />
<br />
|}<br />
<br />
===Red Faction: Guerrilla Tools===<br />
<br />
* [https://github.com/Moneyl/RfgUtil/releases RfgUtil] - Used for unpacking most file formats and updating <code>.asm_pc</code> files<br />
* [https://github.com/Moneyl/Nanoforge/releases Nanoforge C++] - Map editor, texture editor, <code>.xtbl</code> editor and more<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/mTools.zip mTools] - Drag and drop tool to convert <code>.asm_pc</code> files to XML and vice versa<br />
* [https://github.com/rsl-dev/RSL/releases RSL] - Script Loader<br />
* [https://github.com/Moneyl/AsmTool AsmTool]- WIP Tool for modifying <code>.asm_pc</code> files used by Red Faction Guerrilla. This is meant to replace hand editing them, which is very error prone and tedious<br />
* [https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe SyncFaction] - WIP tool for automatically installing the Terraform Patch and eventually replacing the old mod manager<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5686 xdelta UI] - GUI for generating <code>.xdelta</code> (binary) patches<br />
* [https://www.w3schools.com/xml/xml_validator.asp XML Validator] - Use this to validate <code>.xtbl</code> edits, any mistakes you make will crash the game<br />
* [https://jsonformatter.org/xml-formatter XML Formatter] - Use this to format <code>.xtbl</code> files so they are easier to read<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5995 Mod Manager Re-mars-tered v1.03] - Legacy mod manager<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/Volition_Table_File_Editor.zip Volition Table File Editor] - GUI for editing <code>.xtbl</code> files<br />
* [https://onecompiler.com/lua/3ykpyrhhb LUA Validator] - Useful for validating RSL scripts for errors, note it's safe to ignore <code>attempt to index a nil value (global 'rfg')</code><br />
<br />
===Useful Software===<br />
<br />
* [https://www.voidtools.com/ Voidtools Everything] - Locate files and folders by name instantly<br />
* [https://www.mythicsoft.com/agentransack/ Agent Ransack] - Bulk search for keywords within unpacked files<br />
* [https://notepad-plus-plus.org/downloads/ Notepad++] - Good text editor for manually editing <code>.xtbl</code> files, set language as XML<br />
<br />
==Tutorials==<br />
*[[Nanoforge basics]] - Introduction to Nanoforge and its features.<br />
*[[Nanoforge xtbl editing]] - How to edit [[.xtbl]] files in Nanoforge.<br />
*[[Nanoforge Texture Editing]] - How to edit textures using Nanoforge.<br />
<br />
<br />
[[Category: Red Faction: Guerrilla]]<br />
[[Category: RF:G Editing]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Editing_Main_Page&diff=8958RF:G Editing Main Page2023-06-18T21:49:32Z<p>Camo: </p>
<hr />
<div>{{RFGEditing}}<br />
{{Under construction}}<br />
<br />
This will serve as a landing page for all resources related to [[Red Faction: Guerrilla]] editing for the ''Re-Mars-tered Edition'''.<br />
<br />
==External Links==<br />
===Community===<br />
*[https://discord.gg/factionfiles Faction Files Community Discord] - Active Red Faction series community Discord with #map-mod-development channel for community development discussion<br />
===Downloads===<br />
*[https://www.factionfiles.com/ff.php?action=files FactionFiles.com] - Custom mods, tools, patches, and reference material<br />
*[https://www.nexusmods.com/redfactionguerilla/mods/ Nexus Mods] - Custom mods<br />
*[https://www.nexusmods.com/redfactionguerrillaremarstered/mods/ Nexus Mods Re-Mars-tered] - Custom mods<br />
<br />
==Documentation==<br />
*[[RF:G Map organization]]<br />
*[[Nanoforge basics]]<br />
*[https://github.com/Moneyl/RfgTools/blob/main/Documentation/RfgZonexFormat.md Zone file format docs] - Describes the zone format used by RFG in more detail<br />
===Core Concepts===<br />
*[[Red Faction: Guerrilla]]'s level editor is [[CLOE]], which is not publicly available.<br />
<br />
===Red Faction: Guerrilla File Formats===<br />
* <code>.xtbl</code> - XML table files are used to store properties or attributes in Red Faction: Guerrilla. Overall, their function is similar to the <code>.tbl</code> files of Red Faction and Red Faction II.<br />
* <code>.scriptx</code> - Internal script engine file, commonly used for missions and activities<br />
* <code>.dtodx</code> - Weather/lighting file for maps that controls things like fog, tint, ambient colour, eye adaption, bloom, cloud color and speed<br />
* <code>.gtodx</code> - Skybox file for maps that controls things like the sun texture, moon positions and if the horizon mountain texture is enabled<br />
* <code>.vpp_pc</code> - Packfile<br />
* <code>.rigx</code> - Rig<br />
* <code>.str2_pc</code> - Texture Packfile<br />
* <code>.rfgzone_pc</code> - Map zone<br />
* <code>.layer_pc</code> - Map zone<br />
* <code>.cpeg_pc, cvbm_pc</code> - Texture cpu file<br />
* <code>.gpeg_pc, gvbm_pc</code> - Texture gpu file<br />
* <code>.asm_pc</code> - Streaming index<br />
* <code>.csmesh_pc</code> - Static mesh cpu file<br />
* <code>.gsmesh_pc</code> - Static mesh gpu file<br />
* <code>.ccmesh_pc</code> - Character mesh cpu file<br />
* <code>.gcmesh_pc</code> - Character mesh gpu file<br />
* <code>.ccar_pc</code> - Vehicle mesh cpu file<br />
* <code>.gcar_pc</code> - Vehicle mesh gpu file<br />
* <code>.anim_pc</code> - Animation<br />
* <code>.cchk_pc</code> - Destructible object cpu file<br />
* <code>.gchk_pc</code> - Destructible object gpu file<br />
* <code>.cefct_pc</code> - Visual effect cpu file<br />
* <code>.gefct_pc</code> - Visual effect gpu file<br />
* <code>.cfmesh_pc</code> - Foliage mesh<br />
* <code>.cstch</code> - Terrain clutter mesh cpu file<br />
* <code>.gstch</code> - Terrain clutter mesh gpu file<br />
* <code>.cterrain_pc</code> - Terrain zone cpu file<br />
* <code>.gterrain_pc</code> - Terrain zone gpu file<br />
* <code>.ctmesh_pc</code> - Terrain subzone cpu file<br />
* <code>.gtmesh_pc</code> - Terrain subzone gpu file<br />
* <code>.fsmib</code> - Fullscreen map data<br />
* <code>.fxo_kg</code> - Shader<br />
* <code>.le_strings</code> - Steam localization strings<br />
* <code>.rfglocatext</code> - Localization strings<br />
* <code>.mat_pc</code> - Render material<br />
* <code>.morph_pc</code> - Animation Morph<br />
* <code>.vint_doc</code> - UI<br />
* <code>.sim_pc</code> - Cloth sim<br />
* <code>.xgs_pc</code> - Sound config<br />
* <code>.xsb_pc</code> - Soundbank<br />
* <code>.xwb_pc</code> - Wavebank<br />
* <code>.aud_pc</code> - Audio categories<br />
* <code>.vf3_pc</code> - Font<br />
* <code>.vfdvp_pc</code> - ?<br />
* <code>.rfgvp_pc</code> - ?<br />
<br />
===Red Faction: Guerrilla File Structure===<br />
<br />
\Red Faction Guerrilla Re-MARS-tered\data\<br />
<br />
The two most important files for modding most of RF:G are <code>misc.vpp_pc</code> & <code>table.vpp_pc</code><br />
<br />
* <code>activities.vpp_pc</code> - contains textures for singleplayer activities<br />
* <code>anims.vpp_pc</code> - contains animation files<br />
* <code>chunks.vpp_pc</code> - contains <code>.rfgchunkx</code> files and seems to be related to the <code>preload_chunks.xtbl</code> file, it's possible to add them to a map using the correct <code>dest_checksum</code> & <code>uid</code> numbers. Game might also spawn <code>missing_chunk</code> or <code>missing_destroyable</code> if a mesh fails to load.<br />
* <code>cloth_sim.vpp_pc</code> - contains cloth simulation files<br />
* <code>decals.vpp_pc</code> - contains decal textures<br />
* <code>dlc01_l0.vpp_pc</code> - singleplayer DLC map<br />
* <code>dlc01_l1.vpp_pc</code> - only contains a blank <code>asm_pc</code> file<br />
* <code>dlc01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer DLC map<br />
* <code>dlcp01_activities.vpp_pc</code> - contains textures for singleplayer DLC activities<br />
* <code>dlcp01_anims.vpp_pc</code> - contains animation files for singleplayer DLC<br />
* <code>dlcp01_cloth_sim.vpp_pc</code> - contains cloth simulation files for singleplayer DLC<br />
* <code>dlcp01_effects.vpp_pc</code> - contains visual effect files for singleplayer DLC, some are <code>.str2</code><br />
* <code>dlcp01_humans.vpp_pc</code> - contains textures and meshes for characters in singleplayer DLC<br />
* <code>dlcp01_interface.vpp_pc</code> - contains textures for loading screens & thumbnails in singleplayer DLC<br />
* <code>dlcp01_items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in singleplayer DLC<br />
* <code>dlc01_misc.vpp_pc</code> - contains <code>.rig_pc</code> files, the <code>.fsmib</code> file and two <code>.xtbl</code> files for singleplayer DLC<br />
* <code>dlc01_missions.vpp_pc</code> - contains textures related to singleplayer DLC missions<br />
* <code>dlcp01_personas_en_us.vpp_pc</code> - <br />
* <code>dlcp01_vehicles.vpp_pc</code> - contains textures and meshes for singleplayer DLC vehicles<br />
* <code>dlcp01_voices_en_us.vpp_pc</code> -<br />
* <code>dlcp02_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for multiplayer DLC<br />
* <code>dlcp02_misc.vpp_pc</code> - <br />
* <code>dlcp03_interface.vpp_pc</code> - contains textures for loading screens & thumbnails for wrecking crew DLC<br />
* <code>dlcp03_misc.vpp_pc</code> -<br />
* <code>effects.vpp_pc</code> - contains visual effect files, some are <code>.str2</code><br />
* <code>effects_mp.vpp_pc</code> - contains multiplayer only visual effect files, some are <code>.str2</code><br />
* <code>humans.vpp_pc</code> - contains textures and meshes for characters in both singleplayer and multiplayer<br />
* <code>interface.vpp_pc</code> - contains textures for loading screens & thumbnails in both SP and MP and character portraits in multiplayer<br />
* <code>items.vpp_pc</code> - contains textures and meshes for weapons, character props and misc objects in both singleplayer & multiplayer<br />
* <code>items_mp.vpp_pc</code> - contains multiplayer only textures and meshes<br />
* <code>misc.vpp_pc</code> contains <code>.xtbl</code> files and most other file types<br />
* <code>missions.vpp_pc</code> - contains textures for singleplayer missions<br />
* <code>mp_common.vpp_pc</code> - contains textures shared between multiplayer maps<br />
* <code>mp_xxx.vpp_pc</code> - multiplayer maps, excluding <code>mp_common.vpp_pc</code><br />
* <code>mpdlc_xxx.vpp_pc</code> - DLC multiplayer maps<br />
* <code>personas_de_de.vpp_pc</code> -<br />
* <code>personas_en_us.vpp_pc</code> - <br />
* <code>personas_es_es.vpp_pc</code> - <br />
* <code>personas_fr_fr.vpp_pc</code> -<br />
* <code>personas_it_it.vpp_pc</code> -<br />
* <code>personas_ru_ru.vpp_pc</code> -<br />
* <code>rfg_cine_00a.bik_xbox2</code> -<br />
* <code>rfg_cine_01a.bik_xbox2</code> -<br />
* <code>rfg_cine_02a.bik_xbox2</code> -<br />
* <code>rfg_cine_03a.bik_xbox2</code> - <br />
* <code>rfg_cine_03b.bik_xbox2</code> - <br />
* <code>rfg_cine_04a.bik_xbox2</code> - <br />
* <code>rfg_cine_05a.bik_xbox2</code> - <br />
* <code>rfg_cine_06a.bik_xbox2</code> - <br />
* <code>skybox.vpp_pc</code> - contains textures for the skybox like the clouds<br />
* <code>sounds_r.vpp_pc</code> - contains <code>.xmb_pc</code> sound files<br />
* <code>steam.vpp_pc</code> -<br />
* <code>table.vpp_pc</code> - contains only <code>.xtbl</code> files and will overwrite <code>.xtbl</code> files in <code>misc.vpp_pc</code><br />
* <code>terr01_l0.vpp_pc</code> - singleplayer map<br />
* <code>terr01_l1.vpp_pc</code> - singleplayer map<br />
* <code>terr01_precache.vpp_pc</code> - similar to <code>mp_common.vpp_pc</code> but for the singleplayer map<br />
* <code>vehicles_r.vpp_pc</code> - contains textures and meshes for singleplayer vehicles<br />
* <code>voices_de_de.vpp_pc</code> - <br />
* <code>voices_en_us.vpp_pc</code> - <br />
* <code>voices_es_es.vpp_pc</code> - <br />
* <code>voices_fr_fr.vpp_pc</code> - <br />
* <code>voices_it_it.vpp_pc</code> - <br />
* <code>voices_ru_ru.vpp_pc</code> -<br />
* <code>wcxxx.vpp_c</code> - wrecking crew maps<br />
* <code>zonescript_dlc01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer DLC map<br />
* <code>zonescript_terr01.vpp_pc</code> - contains <code>.scriptx</code> and <code>.rfgzone_pc</code> files for singleplayer map<br />
* <code>xxx.bik</code> - pre-rendered custscenes<br />
<br />
===Scriptx Functions===<br />
<br />
* [https://www.factionfiles.com/ff.php?action=scriptxfuncs .scriptx functions]<br />
<br />
===Primitive data types & limits===<br />
<br />
* Floats (floating decimal points): Max value <code>3.4028237</code> and move the decimal place right 38 times. Examples: <code>1.0, 0.0</code><br />
* Integer (whole number that could hold a zero, positive or negative value): Max value <code>2147483647</code><br />
* Boolean (truth value with two constants objects True and False , basically a toggle to enable or disable something using "true" or "false"): Examples: <code><Unlocks_Cheat>True</Unlocks_Cheat>, <Unlocks_Cheat>False</Unlocks_Cheat></code><br />
* String (represents a sequence or characters/text): Example: <code><string>OldCoot</string></code><br />
<br />
===sounds_r.vpp_pc Info===<br />
<br />
* S16 = Signed 16 bit<br />
* LE = Little endian<br />
* 2CH = 2 channels (stereo)<br />
<br />
* destruction.xwb_pc - unknown<br />
* dlc01_voc_d01offcam.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01dan.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm02.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm03.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm04.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm05.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01msm06.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01rfc.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01sam_pcm01.xwb_pc.en_us.xwb_pc - unknown <br />
* dlc01_voc_spe_d01vasha_safe.xwb_pc.en_us.xwb_pc - unknown <br />
* mov_foley.xwb_pc - unknown <br />
* mov_jet_pack.xwb_pc - unknown <br />
* mov_male.xwb_pc - unknown <br />
* mov_npc_male.xwb_pc - unknown <br />
* mp_backpacks.xwb_pc - S16, LE, 2CH. Intermittent static starting ~28sec <br />
* mp_wep.xwb_pc - S16, LE, 2CH. Static at start and end <br />
* mus_briefings.xwb_pc - S16, LE, 2CH. <br />
* mus_demomaster.xwb_pc - S16, LE, 2CH. <br />
* mus_frontend.xwb_pc - S16, LE, 2CH. <br />
* mus_multiplayer.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_01.xwb_pc - S16, LE, 2CH. Static at start, may be header <br />
* mus_progression_02.xwb_pc - S16, LE, 2CH. <br />
* mus_progression_03.xwb_pc - S16, LE, 2CH. <br />
* mus_sting.xwb_pc - S16, LE, 2CH. <br />
* obj_shared_ambient.xwb_pc - unknown<br />
* obj_shared_dth.xwb_pc - unknown <br />
* obj_shared_exp.xwb_pc - unknown<br />
* obj_shared_impact.xwb_pc - unknown <br />
* scripted_raids.xwb_pc - unknown <br />
* system.xwb_pc - S16, LE, 2CH. Mostly static, valid sound in middle <br />
* system_mp.xwb_pc - unknown <br />
* veh_civ_bus.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car1.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car2.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_car3.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_flat.xwb_pc - unknown <br />
* veh_civ_flat2.xwb_pc - unknown<br />
* veh_civ_fuel.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_hauler.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_taxi.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_trash.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_civ_walker.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_aax.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_abx.xwb_pc - S16, LE, 2CH. Mostly static, some valid sound at end. <br />
* veh_edf_apc.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_atank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_htank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_mtank.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_scout.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staff.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_staffh2h.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_edf_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_mar_raider.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_atv.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_bull.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_dtruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_etruck.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_jetter.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_pickup.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_rover.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_roverwk.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supply.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_supplyrt.xwb_pc - unknown<br />
* veh_min_wlklg.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_min_wlkmd.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* veh_shared.xwb_pc - S16, LE, 2CH. Some static, some valid sound. <br />
* walla.xwb_pc - unknown<br />
* weather.xwb_pc - S16, LE, 2CH.<br />
* wep_rfg.xwb_pc - S16, LE, 2CH. Mostly valid, some static<br />
<br />
===RfgUtil Guide===<br />
<br />
* Unpacking [Placeholder]<br />
* Repacking [Placeholder]<br />
* Command arguments [Placeholder]<br />
* Scripts [Placeholder]<br />
* Updating <code>.asm_pc</code> files [Placeholder]<br />
<br />
===Misc Notes===<br />
<br />
* When repacking <code>.vpp_pc</code> files don't compress and/or condense them if they weren't like that in the vanilla game, it will cause the game to crash. Eg: <code>items.vpp_pc</code>, <code>interface.vpp_pc</code>, map files etc. See the table below:<br />
* <code>table.vpp_pc</code> overwrites changes to <code>.xtbl</code> files in <code>misc.vpp_pc</code>. The work around for this with the legacy mod manager is to rename the file however this breaks multiplayer and reduces the stability of the game. You should edit the same <code>.xtbl</code> files in both <code>misc.vpp_pc</code> & <code>table.vpp_pc</code>.<br />
<br />
{| class="wikitable"<br />
|+<br />
|-<br />
! Filename !! Alignment !! Compressed !! Condensed<br />
|-<br />
| ALL .str2 || 0 || Yes || Yes<br />
|-<br />
| MOST .vpp_pc || 2048 || No || No<br />
|-<br />
| dlc01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlcp01_misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| misc.vpp_pc || 2048 || Yes || No<br />
|-<br />
| mp_common.vpp_pc || 2048 || Yes || No<br />
|-<br />
| steam.vpp_pc || 2048 || Yes || No<br />
|-<br />
| terr01_precache.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_dlc01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| zonescript_terr01.vpp_pc || 2048 || Yes || No<br />
|-<br />
| dlc01_l1.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp01_voices_en_us.vpp_pc || 0 || No || No<br />
|-<br />
| dlcp02_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| dlcp03_misc.vpp_pc || 0 || Yes || No<br />
|-<br />
| anims.vpp_pc || 16 || Yes || Yes<br />
|-<br />
| table.vpp_pc || 64 || Yes || Yes<br />
|-<br />
| skybox.vpp_pc || 4096 || No || No<br />
|-<br />
| dlcp01_personas_en_us.vpp_pc || 4096 || No || No<br />
<br />
|}<br />
<br />
===Red Faction: Guerrilla Tools===<br />
<br />
* [https://github.com/Moneyl/RfgUtil/releases RfgUtil] - Used for unpacking most file formats and updating <code>.asm_pc</code> files<br />
* [https://github.com/Moneyl/Nanoforge/releases Nanoforge C++] - Map editor, texture editor, <code>.xtbl</code> editor and more<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/mTools.zip mTools] - Drag and drop tool to convert <code>.asm_pc</code> files to XML and vice versa<br />
* [https://github.com/rsl-dev/RSL/releases RSL] - Script Loader<br />
* [https://github.com/Moneyl/AsmTool AsmTool]- WIP Tool for modifying <code>.asm_pc</code> files used by Red Faction Guerrilla. This is meant to replace hand editing them, which is very error prone and tedious<br />
* [https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe SyncFaction] - WIP tool for automatically installing the Terraform Patch and eventually replacing the old mod manager<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5686 xdelta UI] - GUI for generating <code>.xdelta</code> (binary) patches<br />
* [https://www.w3schools.com/xml/xml_validator.asp XML Validator] - Use this to validate <code>.xtbl</code> edits, any mistakes you make will crash the game<br />
* [https://jsonformatter.org/xml-formatter XML Formatter] - Use this to format <code>.xtbl</code> files so they are easier to read<br />
* [https://www.factionfiles.com/ff.php?action=file&id=5995 Mod Manager Re-mars-tered v1.03] - Legacy mod manager<br />
* [https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/tools/Volition_Table_File_Editor.zip Volition Table File Editor] - GUI for editing <code>.xtbl</code> files<br />
* [https://onecompiler.com/lua/3ykpyrhhb LUA Validator] - Useful for validating RSL scripts for errors, note it's safe to ignore <code>attempt to index a nil value (global 'rfg')</code><br />
<br />
===Useful Software===<br />
<br />
* [https://www.voidtools.com/ Voidtools Everything] - Locate files and folders by name instantly<br />
* [https://www.mythicsoft.com/agentransack/ Agent Ransack] - Bulk search for keywords within unpacked files<br />
* [https://notepad-plus-plus.org/downloads/ Notepad++] - Good text editor for manually editing <code>.xtbl</code> files, set language as XML<br />
<br />
==Tutorials==<br />
*[[Nanoforge basics]] - Introduction to Nanoforge and its features.<br />
*[[Nanoforge xtbl editing]] - How to edit [[.xtbl]] files in Nanoforge.<br />
*[[Nanoforge Texture Editing]] - How to edit textures using Nanoforge.<br />
<br />
<br />
[[Category: Red Faction: Guerrilla]]<br />
[[Category: RF:G Editing]]</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Game_Night_News&diff=8957RF:G Game Night News2023-06-10T13:44:00Z<p>Camo: /* Troubleshooting */</p>
<hr />
<div>{{Under construction}}<br />
<br />
== News ==<br />
<br />
* Terraform Patch v1.07.5 was recently released on the 8th of June, 2023. Please update before game night!<br />
* SyncFaction v9 was recently released on the 14th of March, 2023. Please update before game night!<br />
<br />
== Multiplayer Server Status ==<br />
<br />
* Steam version: Fix already included in latest update from Steam.<br />
* GOG version: You will need to manually replace <code>sw_api.dll</code> in the <code>Red Faction Guerrilla Re-Mars-tered</code> folder with the one from here: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_debug/mp_fix/gog/sw_api.dll<br />
<br />
== Installing Terraform Patch ==<br />
<br />
# Download https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
# Open SyncFaction.<br />
# The first time you run it SyncFaction will take some time verifying your game files are vanilla, if you encounter any errors please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game in Steam. You can quickly find your game folder by right clicking RF:G in your Steam library, selecting properties, clicking Local files and finally Browse. Verify integrity of game files is also found here.<br />
# After SyncFaction is done verifying you will see a button at the bottom middle <code>Update to latest Community Patch</code>, click it & SyncFaction will automatically download and install the patch; you will see the progress tracked in the log.<br />
# When it has successfully installed the patch you will see this wiki page instead of the log along with <code>Run Game</code>, <code>Apply</code> & <code>Refresh</code> buttons, you don't need to do anything else and can close SyncFaction now.<br />
<br />
== Updating Terraform Patch ==<br />
<br />
* If you've played game nights before, get latest SF version and let it do the update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* No need to waste time verifying game with Steam!<br />
<br />
== Troubleshooting ==<br />
<br />
* Make sure you're on the latest SF version and update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* If you suspect your game is corrupted, please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game.<br />
* Sometimes after installing the required .NET version you will need to restart your computer for SF to work.<br />
* '''DON'T''' install any mods or maps on top of the patch or you'll corrupt your game!<br />
* '''DON'T''' use RSL1 for the Steam version of the game, it won't allow you into multiplayer due to cheating concerns.<br />
* If you have both the Steam & GOG versions installed, lots of drives or SF is having issues finding your game install try putting <code>SyncFaction.exe</code> with <code>rfg.exe</code> in the respective game versions folder.<br />
* If your anti virus detects <code>SyncFaction.exe</code> as malware you can be assured it's a false positive, it's open source on github and developed by a trusted member of the community. You can safely make an exception in your anti virus software.<br />
* If SyncFaction has trouble downloading the patch and shows an error starting with <code>System.Net.Http.HttpRequestException</code> it's probably being blocked by your firewall.<br />
* If your game crashes on startup it's possible you incorrectly replaced <code>sw_api.dll</code> for the Steam version when that is only needed for the GOG version, try restoring it to the Steam version: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_debug/mp_fix/steam/sw_api.dll<br />
* If you're unable to move your character, pause the game and then unpause.<br />
* '''NUCLEAR''' option if other troubleshooting steps above fail or your game is frequently crashing: delete the entire <code>data</code> folder and verify game in Steam. If using GOG completely uninstall the game and install from scratch and then use the latest SF version to re-install the Terraform Patch.<br />
* This app release is not tested thoroughly so please be patient & report any bugs to rast1234.<br />
<br />
=== Saving Space ===<br />
<br />
* After you've updated to the current latest version of the patch it's safe to delete the <code>\data\.syncfaction\mod_xxx</code> folders.<br />
* This is because previous patch versions are cached there and not needed since last update is not incremental.<br />
<br />
=== Confirming Patch Installed Correctly === <br />
<br />
* On the first loading screen before the main menu you should see <code>Terraform Patch v1.075 ALPHA</code> at the bottom right. Example: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/misc.vpp_pc/E_TEXTURE_CHANGES/SOURCE/ui_loading_init.png?raw=true<br />
* When creating a custom match the default options should have fleetfoot selected as the starting backpack.<br />
* You should see DLC Wrecking Crew & custom maps when going through map selection such as Storage, Abandoned, Nordic Bonus, Ruins, Imperial etc.<br />
* You should see DLC Weapons when going through weapons such as the Subverter, Spiker, Misslepod etc.<br />
* You should see new characters in the multiplayer customization screen such as Jenkins, Sam, Voice of Mars etc.<br />
<br />
=== Networking Issues === <br />
<br />
* As the game relies on THQN servers and it seems NAT punching isn't always reliable some connection issues like not being able to join certain players, players not being able to join you or an unusual issue where you're stuck spectating when the game begins may require manual configuration of your network to resolve.<br />
* Ensure <code>rfg.exe</code> isn't blocked by the Windows Firewall for both <code>Inbound</code> and <code>Outbound</code> connections. You can make new rules to <code>Allow the connection</code> for both <code>Inbound</code> and <code>Outbound</code> by searching for <code>Windows Defender Firewall with Advanced Security</code>. See the guide below for more advanced instructions.<br />
* Ensure all the games ports are forwarded in your routers firewall: you will need to setup a Static IP on your computer and forward the following ports in your router: <code>TCP: 80</code>, <code>UDP: 88</code>, <code>TCP/UDP: 443</code>, <code>TCP/UDP: 3074</code>, <code>UDP: 3478</code>, <code>UDP: 4379-4380</code>, <code>TCP/UDP: 23022</code>, <code>TCP/UDP: 38888</code>, <code>TCP/UDP 27000-27100</code> & <code>TCP/UDP: 61111</code>. Consult your routers manual on how to do this and see the guide below for detailed instructions on setting up a Static IP.<br />
* You can also setup DMZ for your Static IP but this is less secure. Consult your routers manual on how to do this.<br />
* It's possible your ISP is blocking ports, you can try using their app if they provide one or calling them and asking them to unblock all ports.<br />
* It's possible issues may be caused by a bad router/modem.<br />
* [https://www.howtogeek.com/19249/how-to-assign-a-static-ip-address-in-xp-vista-or-windows-7/ How to Assign a Static IP Address in Windows 10 or 11]<br />
* [https://www.howtogeek.com/112564/how-to-create-advanced-firewall-rules-in-the-windows-firewall/ How to Create Advanced Firewall Rules in the Windows Firewall]<br />
<br />
=== Configs & Save Data Corruption ===<br />
<br />
* It's unknown if this is required but it might be worth a try if you've followed all previous troubleshooting steps and you're still having issues with your game.<br />
* Delete <code>config.ini</code> in <code>%APPDATA%\kaiko\rfg\</code>. This will reset all your settings to default and you will have to reconfigure them the next time you start your game.<br />
* Steam save: <code><Steam-folder>\userdata\<user-id>\667720\remote\</code> or <code><Steam-folder>\userdata\<user-id>\667720\remote\autocloud\save</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* GOG save: <code>%LOCALAPPDATA%\GOG.com\Galaxy\Applications\51153410217180642\Storage\Shared\Files\autocloud\save\</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* Note: It's possible to transfer the Steam save to GOG or vice versa so you can try that also.<br />
<br />
=== Improving Game Stability ===<br />
<br />
# Right click <code>rfg.exe</code> in your game folder.<br />
# Select <code>Properties</code> in the context menu.<br />
# Select the <code>Compatibility</code> tab.<br />
# Tick <code>Disable fullscreen optimizations</code>.<br />
# Click <code>Change high DPI settings</code>.<br />
# Tick <code>Override high DPI scaling Behavior. Scaling performed by: Application</code>.<br />
# Click ok to both windows.<br />
# If on Windows 11 follow the below additional steps.<br />
# Open the <code>Settings</code> app.<br />
# Navigate to System > Display > Graphics > Add an app > Desktop app > Find <code>rfg.exe</code>.<br />
# Once it's added, search for rfg and click <code>Options</code>.<br />
# Tick <code>Don't use optimizations for windowed games</code>.<br />
# Make sure you select exclusive fullscreen inside the games option menu.<br />
[[File:GameStabilityFix.jpeg|frameless|512px]]<br />
<br />
=== Microstuttering Fix ===<br />
<br />
* Disable '''VSYNC''' in the games option menu.<br />
* Force '''VSYNC''' in your graphics card control panel. <br />
* Cap the framerate to your refresh rate in your graphics card control panel.<br />
* Make sure you select exclusive fullscreen inside the games option menu.<br />
<br />
== Terraform Patch Info ==<br />
<br />
* Changelog: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/changelog.txt<br />
* Known Issues: https://github.com/users/CamoRF/projects/3/views/1<br />
* Github: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch<br />
* This patch is an alpha version so you may encounter bugs, please ping Camo in the rfg-modding channel to report any issues.<br />
<br />
== Recommended Competitive Game Settings ==<br />
<br />
* Note: settings are always personal preference but this should serve as a decent starting guide if you want to play more competitively.<br />
* The default keybindings for RF:G are unusual compared to other shooters, most members in the community recommend the following settings:<br />
* All options are found under <code>Main Menu</code> --> <code>Options</code><br />
<br />
* Controls & Keybindings<br />
* Zoom: Right Click<br />
* Melee Attack: F<br />
* Melee Attack 2: Side Mouse Button if your mouse has one<br />
* Shoulder Switch: Side Mouse Button if your mouse has one<br />
* Zoom: Hold<br />
* Crouch: Toggle<br />
<br />
* Audio Options (These will allow you to hear enemy movement more clearly)<br />
* Ambience: 50%<br />
* Music: 0%<br />
* Voice: 50%<br />
* SFX: 100%<br />
<br />
* Graphics Options<br />
* FOV: 85<br />
* Depth of Field: Disabled<br />
* Motion Blur: Disabled<br />
<br />
* Game Options<br />
* Camera Shake: Disabled<br />
<br />
== Run game ==<br />
<br />
All maps are included in the Terraform Patch and you don't need to install anything else. Join the [https://discord.gg/factionfiles FactionFiles Discord] and subscribe to RF:G Game Night event!</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Game_Night_News&diff=8956RF:G Game Night News2023-06-10T13:42:32Z<p>Camo: Improved networking troubleshooting section</p>
<hr />
<div>{{Under construction}}<br />
<br />
== News ==<br />
<br />
* Terraform Patch v1.07.5 was recently released on the 8th of June, 2023. Please update before game night!<br />
* SyncFaction v9 was recently released on the 14th of March, 2023. Please update before game night!<br />
<br />
== Multiplayer Server Status ==<br />
<br />
* Steam version: Fix already included in latest update from Steam.<br />
* GOG version: You will need to manually replace <code>sw_api.dll</code> in the <code>Red Faction Guerrilla Re-Mars-tered</code> folder with the one from here: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_debug/mp_fix/gog/sw_api.dll<br />
<br />
== Installing Terraform Patch ==<br />
<br />
# Download https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
# Open SyncFaction.<br />
# The first time you run it SyncFaction will take some time verifying your game files are vanilla, if you encounter any errors please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game in Steam. You can quickly find your game folder by right clicking RF:G in your Steam library, selecting properties, clicking Local files and finally Browse. Verify integrity of game files is also found here.<br />
# After SyncFaction is done verifying you will see a button at the bottom middle <code>Update to latest Community Patch</code>, click it & SyncFaction will automatically download and install the patch; you will see the progress tracked in the log.<br />
# When it has successfully installed the patch you will see this wiki page instead of the log along with <code>Run Game</code>, <code>Apply</code> & <code>Refresh</code> buttons, you don't need to do anything else and can close SyncFaction now.<br />
<br />
== Updating Terraform Patch ==<br />
<br />
* If you've played game nights before, get latest SF version and let it do the update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* No need to waste time verifying game with Steam!<br />
<br />
== Troubleshooting ==<br />
<br />
* Make sure you're on the latest SF version and update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* If you suspect your game is corrupted, please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game.<br />
* Sometimes after installing the required .NET version you will need to restart your computer for SF to work.<br />
* '''DON'T''' install any mods or maps on top of the patch or you'll corrupt your game!<br />
* If you have both the Steam & GOG versions installed, lots of drives or SF is having issues finding your game install try putting <code>SyncFaction.exe</code> with <code>rfg.exe</code> in the respective game versions folder.<br />
* If your anti virus detects <code>SyncFaction.exe</code> as malware you can be assured it's a false positive, it's open source on github and developed by a trusted member of the community. You can safely make an exception in your anti virus software.<br />
* If SyncFaction has trouble downloading the patch and shows an error starting with <code>System.Net.Http.HttpRequestException</code> it's probably being blocked by your firewall.<br />
* If your game crashes on startup it's possible you incorrectly replaced <code>sw_api.dll</code> for the Steam version when that is only needed for the GOG version, try restoring it to the Steam version: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_debug/mp_fix/steam/sw_api.dll<br />
* If you're unable to move your character, pause the game and then unpause.<br />
* '''NUCLEAR''' option if other troubleshooting steps above fail or your game is frequently crashing: delete the entire <code>data</code> folder and verify game in Steam. If using GOG completely uninstall the game and install from scratch and then use the latest SF version to re-install the Terraform Patch.<br />
* This app release is not tested thoroughly so please be patient & report any bugs to rast1234.<br />
<br />
=== Saving Space ===<br />
<br />
* After you've updated to the current latest version of the patch it's safe to delete the <code>\data\.syncfaction\mod_xxx</code> folders.<br />
* This is because previous patch versions are cached there and not needed since last update is not incremental.<br />
<br />
=== Confirming Patch Installed Correctly === <br />
<br />
* On the first loading screen before the main menu you should see <code>Terraform Patch v1.075 ALPHA</code> at the bottom right. Example: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/misc.vpp_pc/E_TEXTURE_CHANGES/SOURCE/ui_loading_init.png?raw=true<br />
* When creating a custom match the default options should have fleetfoot selected as the starting backpack.<br />
* You should see DLC Wrecking Crew & custom maps when going through map selection such as Storage, Abandoned, Nordic Bonus, Ruins, Imperial etc.<br />
* You should see DLC Weapons when going through weapons such as the Subverter, Spiker, Misslepod etc.<br />
* You should see new characters in the multiplayer customization screen such as Jenkins, Sam, Voice of Mars etc.<br />
<br />
=== Networking Issues === <br />
<br />
* As the game relies on THQN servers and it seems NAT punching isn't always reliable some connection issues like not being able to join certain players, players not being able to join you or an unusual issue where you're stuck spectating when the game begins may require manual configuration of your network to resolve.<br />
* Ensure <code>rfg.exe</code> isn't blocked by the Windows Firewall for both <code>Inbound</code> and <code>Outbound</code> connections. You can make new rules to <code>Allow the connection</code> for both <code>Inbound</code> and <code>Outbound</code> by searching for <code>Windows Defender Firewall with Advanced Security</code>. See the guide below for more advanced instructions.<br />
* Ensure all the games ports are forwarded in your routers firewall: you will need to setup a Static IP on your computer and forward the following ports in your router: <code>TCP: 80</code>, <code>UDP: 88</code>, <code>TCP/UDP: 443</code>, <code>TCP/UDP: 3074</code>, <code>UDP: 3478</code>, <code>UDP: 4379-4380</code>, <code>TCP/UDP: 23022</code>, <code>TCP/UDP: 38888</code>, <code>TCP/UDP 27000-27100</code> & <code>TCP/UDP: 61111</code>. Consult your routers manual on how to do this and see the guide below for detailed instructions on setting up a Static IP.<br />
* You can also setup DMZ for your Static IP but this is less secure. Consult your routers manual on how to do this.<br />
* It's possible your ISP is blocking ports, you can try using their app if they provide one or calling them and asking them to unblock all ports.<br />
* It's possible issues may be caused by a bad router/modem.<br />
* [https://www.howtogeek.com/19249/how-to-assign-a-static-ip-address-in-xp-vista-or-windows-7/ How to Assign a Static IP Address in Windows 10 or 11]<br />
* [https://www.howtogeek.com/112564/how-to-create-advanced-firewall-rules-in-the-windows-firewall/ How to Create Advanced Firewall Rules in the Windows Firewall]<br />
<br />
=== Configs & Save Data Corruption ===<br />
<br />
* It's unknown if this is required but it might be worth a try if you've followed all previous troubleshooting steps and you're still having issues with your game.<br />
* Delete <code>config.ini</code> in <code>%APPDATA%\kaiko\rfg\</code>. This will reset all your settings to default and you will have to reconfigure them the next time you start your game.<br />
* Steam save: <code><Steam-folder>\userdata\<user-id>\667720\remote\</code> or <code><Steam-folder>\userdata\<user-id>\667720\remote\autocloud\save</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* GOG save: <code>%LOCALAPPDATA%\GOG.com\Galaxy\Applications\51153410217180642\Storage\Shared\Files\autocloud\save\</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* Note: It's possible to transfer the Steam save to GOG or vice versa so you can try that also.<br />
<br />
=== Improving Game Stability ===<br />
<br />
# Right click <code>rfg.exe</code> in your game folder.<br />
# Select <code>Properties</code> in the context menu.<br />
# Select the <code>Compatibility</code> tab.<br />
# Tick <code>Disable fullscreen optimizations</code>.<br />
# Click <code>Change high DPI settings</code>.<br />
# Tick <code>Override high DPI scaling Behavior. Scaling performed by: Application</code>.<br />
# Click ok to both windows.<br />
# If on Windows 11 follow the below additional steps.<br />
# Open the <code>Settings</code> app.<br />
# Navigate to System > Display > Graphics > Add an app > Desktop app > Find <code>rfg.exe</code>.<br />
# Once it's added, search for rfg and click <code>Options</code>.<br />
# Tick <code>Don't use optimizations for windowed games</code>.<br />
# Make sure you select exclusive fullscreen inside the games option menu.<br />
[[File:GameStabilityFix.jpeg|frameless|512px]]<br />
<br />
=== Microstuttering Fix ===<br />
<br />
* Disable '''VSYNC''' in the games option menu.<br />
* Force '''VSYNC''' in your graphics card control panel. <br />
* Cap the framerate to your refresh rate in your graphics card control panel.<br />
* Make sure you select exclusive fullscreen inside the games option menu.<br />
<br />
== Terraform Patch Info ==<br />
<br />
* Changelog: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/changelog.txt<br />
* Known Issues: https://github.com/users/CamoRF/projects/3/views/1<br />
* Github: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch<br />
* This patch is an alpha version so you may encounter bugs, please ping Camo in the rfg-modding channel to report any issues.<br />
<br />
== Recommended Competitive Game Settings ==<br />
<br />
* Note: settings are always personal preference but this should serve as a decent starting guide if you want to play more competitively.<br />
* The default keybindings for RF:G are unusual compared to other shooters, most members in the community recommend the following settings:<br />
* All options are found under <code>Main Menu</code> --> <code>Options</code><br />
<br />
* Controls & Keybindings<br />
* Zoom: Right Click<br />
* Melee Attack: F<br />
* Melee Attack 2: Side Mouse Button if your mouse has one<br />
* Shoulder Switch: Side Mouse Button if your mouse has one<br />
* Zoom: Hold<br />
* Crouch: Toggle<br />
<br />
* Audio Options (These will allow you to hear enemy movement more clearly)<br />
* Ambience: 50%<br />
* Music: 0%<br />
* Voice: 50%<br />
* SFX: 100%<br />
<br />
* Graphics Options<br />
* FOV: 85<br />
* Depth of Field: Disabled<br />
* Motion Blur: Disabled<br />
<br />
* Game Options<br />
* Camera Shake: Disabled<br />
<br />
== Run game ==<br />
<br />
All maps are included in the Terraform Patch and you don't need to install anything else. Join the [https://discord.gg/factionfiles FactionFiles Discord] and subscribe to RF:G Game Night event!</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Game_Night_News&diff=8955RF:G Game Night News2023-06-10T13:41:17Z<p>Camo: /* Networking Issues */</p>
<hr />
<div>{{Under construction}}<br />
<br />
== News ==<br />
<br />
* Terraform Patch v1.07.5 was recently released on the 8th of June, 2023. Please update before game night!<br />
* SyncFaction v9 was recently released on the 14th of March, 2023. Please update before game night!<br />
<br />
== Multiplayer Server Status ==<br />
<br />
* Steam version: Fix already included in latest update from Steam.<br />
* GOG version: You will need to manually replace <code>sw_api.dll</code> in the <code>Red Faction Guerrilla Re-Mars-tered</code> folder with the one from here: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_debug/mp_fix/gog/sw_api.dll<br />
<br />
== Installing Terraform Patch ==<br />
<br />
# Download https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
# Open SyncFaction.<br />
# The first time you run it SyncFaction will take some time verifying your game files are vanilla, if you encounter any errors please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game in Steam. You can quickly find your game folder by right clicking RF:G in your Steam library, selecting properties, clicking Local files and finally Browse. Verify integrity of game files is also found here.<br />
# After SyncFaction is done verifying you will see a button at the bottom middle <code>Update to latest Community Patch</code>, click it & SyncFaction will automatically download and install the patch; you will see the progress tracked in the log.<br />
# When it has successfully installed the patch you will see this wiki page instead of the log along with <code>Run Game</code>, <code>Apply</code> & <code>Refresh</code> buttons, you don't need to do anything else and can close SyncFaction now.<br />
<br />
== Updating Terraform Patch ==<br />
<br />
* If you've played game nights before, get latest SF version and let it do the update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* No need to waste time verifying game with Steam!<br />
<br />
== Troubleshooting ==<br />
<br />
* Make sure you're on the latest SF version and update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* If you suspect your game is corrupted, please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game.<br />
* Sometimes after installing the required .NET version you will need to restart your computer for SF to work.<br />
* '''DON'T''' install any mods or maps on top of the patch or you'll corrupt your game!<br />
* If you have both the Steam & GOG versions installed, lots of drives or SF is having issues finding your game install try putting <code>SyncFaction.exe</code> with <code>rfg.exe</code> in the respective game versions folder.<br />
* If your anti virus detects <code>SyncFaction.exe</code> as malware you can be assured it's a false positive, it's open source on github and developed by a trusted member of the community. You can safely make an exception in your anti virus software.<br />
* If SyncFaction has trouble downloading the patch and shows an error starting with <code>System.Net.Http.HttpRequestException</code> it's probably being blocked by your firewall.<br />
* If your game crashes on startup it's possible you incorrectly replaced <code>sw_api.dll</code> for the Steam version when that is only needed for the GOG version, try restoring it to the Steam version: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_debug/mp_fix/steam/sw_api.dll<br />
* If you're unable to move your character, pause the game and then unpause.<br />
* '''NUCLEAR''' option if other troubleshooting steps above fail or your game is frequently crashing: delete the entire <code>data</code> folder and verify game in Steam. If using GOG completely uninstall the game and install from scratch and then use the latest SF version to re-install the Terraform Patch.<br />
* This app release is not tested thoroughly so please be patient & report any bugs to rast1234.<br />
<br />
=== Saving Space ===<br />
<br />
* After you've updated to the current latest version of the patch it's safe to delete the <code>\data\.syncfaction\mod_xxx</code> folders.<br />
* This is because previous patch versions are cached there and not needed since last update is not incremental.<br />
<br />
=== Confirming Patch Installed Correctly === <br />
<br />
* On the first loading screen before the main menu you should see <code>Terraform Patch v1.075 ALPHA</code> at the bottom right. Example: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/misc.vpp_pc/E_TEXTURE_CHANGES/SOURCE/ui_loading_init.png?raw=true<br />
* When creating a custom match the default options should have fleetfoot selected as the starting backpack.<br />
* You should see DLC Wrecking Crew & custom maps when going through map selection such as Storage, Abandoned, Nordic Bonus, Ruins, Imperial etc.<br />
* You should see DLC Weapons when going through weapons such as the Subverter, Spiker, Misslepod etc.<br />
* You should see new characters in the multiplayer customization screen such as Jenkins, Sam, Voice of Mars etc.<br />
<br />
=== Networking Issues === <br />
<br />
* As the game relies on THQN servers and it seems NAT punching isn't always reliable some connection issues like not being able to join certain players, players not being able to join you or an unusual issue where you're stuck spectating when the game begins may require manual configuration of your network to resolve.<br />
* Ensure <code>rfg.exe</code> isn't blocked by the Windows Firewall for both inbound and outbound connections. You can make new rules to <code>Allow the connection</code> for both <code>Inbound</code> and <code>Outbound</code> by searching for <code>Windows Defender Firewall with Advanced Security</code>. See the guide below for more advanced instructions.<br />
* Ensure all the games ports are forwarded in your routers firewall: you will need to setup a Static IP on your computer and forward the following ports in your router: <code>TCP: 80</code>, <code>UDP: 88</code>, <code>TCP/UDP: 443</code>, <code>TCP/UDP: 3074</code>, <code>UDP: 3478</code>, <code>UDP: 4379-4380</code>, <code>TCP/UDP: 23022</code>, <code>TCP/UDP: 38888</code>, <code>TCP/UDP 27000-27100</code> & <code>TCP/UDP: 61111</code>. Consult your routers manual on how to do this and see the guide below for detailed instructions on setting up a Static IP.<br />
* You can also setup DMZ for your Static IP but this is less secure. Consult your routers manual on how to do this.<br />
* It's possible your ISP is blocking ports, you can try using their app if they provide one or calling them and asking them to unblock all ports.<br />
* It's possible issues may be caused by a bad router/modem.<br />
* [https://www.howtogeek.com/19249/how-to-assign-a-static-ip-address-in-xp-vista-or-windows-7/ How to Assign a Static IP Address in Windows 10 or 11]<br />
* [https://www.howtogeek.com/112564/how-to-create-advanced-firewall-rules-in-the-windows-firewall/ How to Create Advanced Firewall Rules in the Windows Firewall]<br />
<br />
=== Configs & Save Data Corruption ===<br />
<br />
* It's unknown if this is required but it might be worth a try if you've followed all previous troubleshooting steps and you're still having issues with your game.<br />
* Delete <code>config.ini</code> in <code>%APPDATA%\kaiko\rfg\</code>. This will reset all your settings to default and you will have to reconfigure them the next time you start your game.<br />
* Steam save: <code><Steam-folder>\userdata\<user-id>\667720\remote\</code> or <code><Steam-folder>\userdata\<user-id>\667720\remote\autocloud\save</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* GOG save: <code>%LOCALAPPDATA%\GOG.com\Galaxy\Applications\51153410217180642\Storage\Shared\Files\autocloud\save\</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* Note: It's possible to transfer the Steam save to GOG or vice versa so you can try that also.<br />
<br />
=== Improving Game Stability ===<br />
<br />
# Right click <code>rfg.exe</code> in your game folder.<br />
# Select <code>Properties</code> in the context menu.<br />
# Select the <code>Compatibility</code> tab.<br />
# Tick <code>Disable fullscreen optimizations</code>.<br />
# Click <code>Change high DPI settings</code>.<br />
# Tick <code>Override high DPI scaling Behavior. Scaling performed by: Application</code>.<br />
# Click ok to both windows.<br />
# If on Windows 11 follow the below additional steps.<br />
# Open the <code>Settings</code> app.<br />
# Navigate to System > Display > Graphics > Add an app > Desktop app > Find <code>rfg.exe</code>.<br />
# Once it's added, search for rfg and click <code>Options</code>.<br />
# Tick <code>Don't use optimizations for windowed games</code>.<br />
# Make sure you select exclusive fullscreen inside the games option menu.<br />
[[File:GameStabilityFix.jpeg|frameless|512px]]<br />
<br />
=== Microstuttering Fix ===<br />
<br />
* Disable '''VSYNC''' in the games option menu.<br />
* Force '''VSYNC''' in your graphics card control panel. <br />
* Cap the framerate to your refresh rate in your graphics card control panel.<br />
* Make sure you select exclusive fullscreen inside the games option menu.<br />
<br />
== Terraform Patch Info ==<br />
<br />
* Changelog: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/changelog.txt<br />
* Known Issues: https://github.com/users/CamoRF/projects/3/views/1<br />
* Github: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch<br />
* This patch is an alpha version so you may encounter bugs, please ping Camo in the rfg-modding channel to report any issues.<br />
<br />
== Recommended Competitive Game Settings ==<br />
<br />
* Note: settings are always personal preference but this should serve as a decent starting guide if you want to play more competitively.<br />
* The default keybindings for RF:G are unusual compared to other shooters, most members in the community recommend the following settings:<br />
* All options are found under <code>Main Menu</code> --> <code>Options</code><br />
<br />
* Controls & Keybindings<br />
* Zoom: Right Click<br />
* Melee Attack: F<br />
* Melee Attack 2: Side Mouse Button if your mouse has one<br />
* Shoulder Switch: Side Mouse Button if your mouse has one<br />
* Zoom: Hold<br />
* Crouch: Toggle<br />
<br />
* Audio Options (These will allow you to hear enemy movement more clearly)<br />
* Ambience: 50%<br />
* Music: 0%<br />
* Voice: 50%<br />
* SFX: 100%<br />
<br />
* Graphics Options<br />
* FOV: 85<br />
* Depth of Field: Disabled<br />
* Motion Blur: Disabled<br />
<br />
* Game Options<br />
* Camera Shake: Disabled<br />
<br />
== Run game ==<br />
<br />
All maps are included in the Terraform Patch and you don't need to install anything else. Join the [https://discord.gg/factionfiles FactionFiles Discord] and subscribe to RF:G Game Night event!</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Game_Night_News&diff=8954RF:G Game Night News2023-06-10T13:40:38Z<p>Camo: /* Networking Issues */</p>
<hr />
<div>{{Under construction}}<br />
<br />
== News ==<br />
<br />
* Terraform Patch v1.07.5 was recently released on the 8th of June, 2023. Please update before game night!<br />
* SyncFaction v9 was recently released on the 14th of March, 2023. Please update before game night!<br />
<br />
== Multiplayer Server Status ==<br />
<br />
* Steam version: Fix already included in latest update from Steam.<br />
* GOG version: You will need to manually replace <code>sw_api.dll</code> in the <code>Red Faction Guerrilla Re-Mars-tered</code> folder with the one from here: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_debug/mp_fix/gog/sw_api.dll<br />
<br />
== Installing Terraform Patch ==<br />
<br />
# Download https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
# Open SyncFaction.<br />
# The first time you run it SyncFaction will take some time verifying your game files are vanilla, if you encounter any errors please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game in Steam. You can quickly find your game folder by right clicking RF:G in your Steam library, selecting properties, clicking Local files and finally Browse. Verify integrity of game files is also found here.<br />
# After SyncFaction is done verifying you will see a button at the bottom middle <code>Update to latest Community Patch</code>, click it & SyncFaction will automatically download and install the patch; you will see the progress tracked in the log.<br />
# When it has successfully installed the patch you will see this wiki page instead of the log along with <code>Run Game</code>, <code>Apply</code> & <code>Refresh</code> buttons, you don't need to do anything else and can close SyncFaction now.<br />
<br />
== Updating Terraform Patch ==<br />
<br />
* If you've played game nights before, get latest SF version and let it do the update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* No need to waste time verifying game with Steam!<br />
<br />
== Troubleshooting ==<br />
<br />
* Make sure you're on the latest SF version and update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* If you suspect your game is corrupted, please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game.<br />
* Sometimes after installing the required .NET version you will need to restart your computer for SF to work.<br />
* '''DON'T''' install any mods or maps on top of the patch or you'll corrupt your game!<br />
* If you have both the Steam & GOG versions installed, lots of drives or SF is having issues finding your game install try putting <code>SyncFaction.exe</code> with <code>rfg.exe</code> in the respective game versions folder.<br />
* If your anti virus detects <code>SyncFaction.exe</code> as malware you can be assured it's a false positive, it's open source on github and developed by a trusted member of the community. You can safely make an exception in your anti virus software.<br />
* If SyncFaction has trouble downloading the patch and shows an error starting with <code>System.Net.Http.HttpRequestException</code> it's probably being blocked by your firewall.<br />
* If your game crashes on startup it's possible you incorrectly replaced <code>sw_api.dll</code> for the Steam version when that is only needed for the GOG version, try restoring it to the Steam version: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_debug/mp_fix/steam/sw_api.dll<br />
* If you're unable to move your character, pause the game and then unpause.<br />
* '''NUCLEAR''' option if other troubleshooting steps above fail or your game is frequently crashing: delete the entire <code>data</code> folder and verify game in Steam. If using GOG completely uninstall the game and install from scratch and then use the latest SF version to re-install the Terraform Patch.<br />
* This app release is not tested thoroughly so please be patient & report any bugs to rast1234.<br />
<br />
=== Saving Space ===<br />
<br />
* After you've updated to the current latest version of the patch it's safe to delete the <code>\data\.syncfaction\mod_xxx</code> folders.<br />
* This is because previous patch versions are cached there and not needed since last update is not incremental.<br />
<br />
=== Confirming Patch Installed Correctly === <br />
<br />
* On the first loading screen before the main menu you should see <code>Terraform Patch v1.075 ALPHA</code> at the bottom right. Example: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/misc.vpp_pc/E_TEXTURE_CHANGES/SOURCE/ui_loading_init.png?raw=true<br />
* When creating a custom match the default options should have fleetfoot selected as the starting backpack.<br />
* You should see DLC Wrecking Crew & custom maps when going through map selection such as Storage, Abandoned, Nordic Bonus, Ruins, Imperial etc.<br />
* You should see DLC Weapons when going through weapons such as the Subverter, Spiker, Misslepod etc.<br />
* You should see new characters in the multiplayer customization screen such as Jenkins, Sam, Voice of Mars etc.<br />
<br />
=== Networking Issues === <br />
<br />
* As the game relies on THQN servers and it seems NAT punching isn't always reliable some connection issues like not being able to join certain players, players not being able to join you or an unusual issue where you're stuck spectating when the game begins may require manual configuration of your network to resolve.<br />
* Ensure <code>rfg.exe</code> isn't blocked by the Windows Firewall for both inbound and outbound connections. You can make a new rules to <code>allow the connection</code> for both <code>inbound</code> and <code>outbound</code> by searching for <code>Windows Defender Firewall with Advanced Security</code>. See the guide below for more advanced instructions.<br />
* Ensure all the games ports are forwarded in your routers firewall: you will need to setup a Static IP on your computer and forward the following ports in your router: <code>TCP: 80</code>, <code>UDP: 88</code>, <code>TCP/UDP: 443</code>, <code>TCP/UDP: 3074</code>, <code>UDP: 3478</code>, <code>UDP: 4379-4380</code>, <code>TCP/UDP: 23022</code>, <code>TCP/UDP: 38888</code>, <code>TCP/UDP 27000-27100</code> & <code>TCP/UDP: 61111</code>. Consult your routers manual on how to do this and see the guide below for detailed instructions on setting up a Static IP.<br />
* You can also setup DMZ for your Static IP but this is less secure. Consult your routers manual on how to do this.<br />
* It's possible your ISP is blocking ports, you can try using their app if they provide one or calling them and asking them to unblock all ports.<br />
* It's possible issues may be caused by a bad router/modem.<br />
* [https://www.howtogeek.com/19249/how-to-assign-a-static-ip-address-in-xp-vista-or-windows-7/ How to Assign a Static IP Address in Windows 10 or 11]<br />
* [https://www.howtogeek.com/112564/how-to-create-advanced-firewall-rules-in-the-windows-firewall/ How to Create Advanced Firewall Rules in the Windows Firewall]<br />
<br />
=== Configs & Save Data Corruption ===<br />
<br />
* It's unknown if this is required but it might be worth a try if you've followed all previous troubleshooting steps and you're still having issues with your game.<br />
* Delete <code>config.ini</code> in <code>%APPDATA%\kaiko\rfg\</code>. This will reset all your settings to default and you will have to reconfigure them the next time you start your game.<br />
* Steam save: <code><Steam-folder>\userdata\<user-id>\667720\remote\</code> or <code><Steam-folder>\userdata\<user-id>\667720\remote\autocloud\save</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* GOG save: <code>%LOCALAPPDATA%\GOG.com\Galaxy\Applications\51153410217180642\Storage\Shared\Files\autocloud\save\</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* Note: It's possible to transfer the Steam save to GOG or vice versa so you can try that also.<br />
<br />
=== Improving Game Stability ===<br />
<br />
# Right click <code>rfg.exe</code> in your game folder.<br />
# Select <code>Properties</code> in the context menu.<br />
# Select the <code>Compatibility</code> tab.<br />
# Tick <code>Disable fullscreen optimizations</code>.<br />
# Click <code>Change high DPI settings</code>.<br />
# Tick <code>Override high DPI scaling Behavior. Scaling performed by: Application</code>.<br />
# Click ok to both windows.<br />
# If on Windows 11 follow the below additional steps.<br />
# Open the <code>Settings</code> app.<br />
# Navigate to System > Display > Graphics > Add an app > Desktop app > Find <code>rfg.exe</code>.<br />
# Once it's added, search for rfg and click <code>Options</code>.<br />
# Tick <code>Don't use optimizations for windowed games</code>.<br />
# Make sure you select exclusive fullscreen inside the games option menu.<br />
[[File:GameStabilityFix.jpeg|frameless|512px]]<br />
<br />
=== Microstuttering Fix ===<br />
<br />
* Disable '''VSYNC''' in the games option menu.<br />
* Force '''VSYNC''' in your graphics card control panel. <br />
* Cap the framerate to your refresh rate in your graphics card control panel.<br />
* Make sure you select exclusive fullscreen inside the games option menu.<br />
<br />
== Terraform Patch Info ==<br />
<br />
* Changelog: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/changelog.txt<br />
* Known Issues: https://github.com/users/CamoRF/projects/3/views/1<br />
* Github: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch<br />
* This patch is an alpha version so you may encounter bugs, please ping Camo in the rfg-modding channel to report any issues.<br />
<br />
== Recommended Competitive Game Settings ==<br />
<br />
* Note: settings are always personal preference but this should serve as a decent starting guide if you want to play more competitively.<br />
* The default keybindings for RF:G are unusual compared to other shooters, most members in the community recommend the following settings:<br />
* All options are found under <code>Main Menu</code> --> <code>Options</code><br />
<br />
* Controls & Keybindings<br />
* Zoom: Right Click<br />
* Melee Attack: F<br />
* Melee Attack 2: Side Mouse Button if your mouse has one<br />
* Shoulder Switch: Side Mouse Button if your mouse has one<br />
* Zoom: Hold<br />
* Crouch: Toggle<br />
<br />
* Audio Options (These will allow you to hear enemy movement more clearly)<br />
* Ambience: 50%<br />
* Music: 0%<br />
* Voice: 50%<br />
* SFX: 100%<br />
<br />
* Graphics Options<br />
* FOV: 85<br />
* Depth of Field: Disabled<br />
* Motion Blur: Disabled<br />
<br />
* Game Options<br />
* Camera Shake: Disabled<br />
<br />
== Run game ==<br />
<br />
All maps are included in the Terraform Patch and you don't need to install anything else. Join the [https://discord.gg/factionfiles FactionFiles Discord] and subscribe to RF:G Game Night event!</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Game_Night_News&diff=8953RF:G Game Night News2023-06-10T13:37:11Z<p>Camo: Fixed Steam MP Fix download link</p>
<hr />
<div>{{Under construction}}<br />
<br />
== News ==<br />
<br />
* Terraform Patch v1.07.5 was recently released on the 8th of June, 2023. Please update before game night!<br />
* SyncFaction v9 was recently released on the 14th of March, 2023. Please update before game night!<br />
<br />
== Multiplayer Server Status ==<br />
<br />
* Steam version: Fix already included in latest update from Steam.<br />
* GOG version: You will need to manually replace <code>sw_api.dll</code> in the <code>Red Faction Guerrilla Re-Mars-tered</code> folder with the one from here: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_debug/mp_fix/gog/sw_api.dll<br />
<br />
== Installing Terraform Patch ==<br />
<br />
# Download https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
# Open SyncFaction.<br />
# The first time you run it SyncFaction will take some time verifying your game files are vanilla, if you encounter any errors please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game in Steam. You can quickly find your game folder by right clicking RF:G in your Steam library, selecting properties, clicking Local files and finally Browse. Verify integrity of game files is also found here.<br />
# After SyncFaction is done verifying you will see a button at the bottom middle <code>Update to latest Community Patch</code>, click it & SyncFaction will automatically download and install the patch; you will see the progress tracked in the log.<br />
# When it has successfully installed the patch you will see this wiki page instead of the log along with <code>Run Game</code>, <code>Apply</code> & <code>Refresh</code> buttons, you don't need to do anything else and can close SyncFaction now.<br />
<br />
== Updating Terraform Patch ==<br />
<br />
* If you've played game nights before, get latest SF version and let it do the update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* No need to waste time verifying game with Steam!<br />
<br />
== Troubleshooting ==<br />
<br />
* Make sure you're on the latest SF version and update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* If you suspect your game is corrupted, please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game.<br />
* Sometimes after installing the required .NET version you will need to restart your computer for SF to work.<br />
* '''DON'T''' install any mods or maps on top of the patch or you'll corrupt your game!<br />
* If you have both the Steam & GOG versions installed, lots of drives or SF is having issues finding your game install try putting <code>SyncFaction.exe</code> with <code>rfg.exe</code> in the respective game versions folder.<br />
* If your anti virus detects <code>SyncFaction.exe</code> as malware you can be assured it's a false positive, it's open source on github and developed by a trusted member of the community. You can safely make an exception in your anti virus software.<br />
* If SyncFaction has trouble downloading the patch and shows an error starting with <code>System.Net.Http.HttpRequestException</code> it's probably being blocked by your firewall.<br />
* If your game crashes on startup it's possible you incorrectly replaced <code>sw_api.dll</code> for the Steam version when that is only needed for the GOG version, try restoring it to the Steam version: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_debug/mp_fix/steam/sw_api.dll<br />
* If you're unable to move your character, pause the game and then unpause.<br />
* '''NUCLEAR''' option if other troubleshooting steps above fail or your game is frequently crashing: delete the entire <code>data</code> folder and verify game in Steam. If using GOG completely uninstall the game and install from scratch and then use the latest SF version to re-install the Terraform Patch.<br />
* This app release is not tested thoroughly so please be patient & report any bugs to rast1234.<br />
<br />
=== Saving Space ===<br />
<br />
* After you've updated to the current latest version of the patch it's safe to delete the <code>\data\.syncfaction\mod_xxx</code> folders.<br />
* This is because previous patch versions are cached there and not needed since last update is not incremental.<br />
<br />
=== Confirming Patch Installed Correctly === <br />
<br />
* On the first loading screen before the main menu you should see <code>Terraform Patch v1.075 ALPHA</code> at the bottom right. Example: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/misc.vpp_pc/E_TEXTURE_CHANGES/SOURCE/ui_loading_init.png?raw=true<br />
* When creating a custom match the default options should have fleetfoot selected as the starting backpack.<br />
* You should see DLC Wrecking Crew & custom maps when going through map selection such as Storage, Abandoned, Nordic Bonus, Ruins, Imperial etc.<br />
* You should see DLC Weapons when going through weapons such as the Subverter, Spiker, Misslepod etc.<br />
* You should see new characters in the multiplayer customization screen such as Jenkins, Sam, Voice of Mars etc.<br />
<br />
=== Networking Issues === <br />
<br />
* As the game relies on THQN servers and it seems NAT punching isn't always reliable some connection issues like not being able to join certain players, players not being able to join you or an unusual issue where you're stuck spectating when the game begins may require manual configuration of your network to resolve.<br />
* Ensure <code>rfg.exe</code> isn't blocked by the Windows Firewall for both inbound and outbound connections. You can make a new rule by searching for <code>Windows Defender Firewall with Advanced Security</code>. See the guide below for more advanced instructions.<br />
* Ensure all the games ports are forwarded in your routers firewall: you will need to setup a Static IP on your computer and forward the following ports in your router: <code>TCP: 80</code>, <code>UDP: 88</code>, <code>TCP/UDP: 443</code>, <code>TCP/UDP: 3074</code>, <code>UDP: 3478</code>, <code>UDP: 4379-4380</code>, <code>TCP/UDP: 23022</code>, <code>TCP/UDP: 38888</code>, <code>TCP/UDP 27000-27100</code> & <code>TCP/UDP: 61111</code>. Consult your routers manual on how to do this and see the guide below for detailed instructions on setting up a Static IP.<br />
* You can also setup DMZ for your Static IP but this is less secure. Consult your routers manual on how to do this.<br />
* It's possible your ISP is blocking ports, you can try using their app if they provide one or calling them and asking them to unblock all ports.<br />
* It's possible issues may be caused by a bad router/modem.<br />
* [https://www.howtogeek.com/19249/how-to-assign-a-static-ip-address-in-xp-vista-or-windows-7/ How to Assign a Static IP Address in Windows 10 or 11]<br />
* [https://www.howtogeek.com/112564/how-to-create-advanced-firewall-rules-in-the-windows-firewall/ How to Create Advanced Firewall Rules in the Windows Firewall]<br />
<br />
=== Configs & Save Data Corruption ===<br />
<br />
* It's unknown if this is required but it might be worth a try if you've followed all previous troubleshooting steps and you're still having issues with your game.<br />
* Delete <code>config.ini</code> in <code>%APPDATA%\kaiko\rfg\</code>. This will reset all your settings to default and you will have to reconfigure them the next time you start your game.<br />
* Steam save: <code><Steam-folder>\userdata\<user-id>\667720\remote\</code> or <code><Steam-folder>\userdata\<user-id>\667720\remote\autocloud\save</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* GOG save: <code>%LOCALAPPDATA%\GOG.com\Galaxy\Applications\51153410217180642\Storage\Shared\Files\autocloud\save\</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* Note: It's possible to transfer the Steam save to GOG or vice versa so you can try that also.<br />
<br />
=== Improving Game Stability ===<br />
<br />
# Right click <code>rfg.exe</code> in your game folder.<br />
# Select <code>Properties</code> in the context menu.<br />
# Select the <code>Compatibility</code> tab.<br />
# Tick <code>Disable fullscreen optimizations</code>.<br />
# Click <code>Change high DPI settings</code>.<br />
# Tick <code>Override high DPI scaling Behavior. Scaling performed by: Application</code>.<br />
# Click ok to both windows.<br />
# If on Windows 11 follow the below additional steps.<br />
# Open the <code>Settings</code> app.<br />
# Navigate to System > Display > Graphics > Add an app > Desktop app > Find <code>rfg.exe</code>.<br />
# Once it's added, search for rfg and click <code>Options</code>.<br />
# Tick <code>Don't use optimizations for windowed games</code>.<br />
# Make sure you select exclusive fullscreen inside the games option menu.<br />
[[File:GameStabilityFix.jpeg|frameless|512px]]<br />
<br />
=== Microstuttering Fix ===<br />
<br />
* Disable '''VSYNC''' in the games option menu.<br />
* Force '''VSYNC''' in your graphics card control panel. <br />
* Cap the framerate to your refresh rate in your graphics card control panel.<br />
* Make sure you select exclusive fullscreen inside the games option menu.<br />
<br />
== Terraform Patch Info ==<br />
<br />
* Changelog: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/changelog.txt<br />
* Known Issues: https://github.com/users/CamoRF/projects/3/views/1<br />
* Github: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch<br />
* This patch is an alpha version so you may encounter bugs, please ping Camo in the rfg-modding channel to report any issues.<br />
<br />
== Recommended Competitive Game Settings ==<br />
<br />
* Note: settings are always personal preference but this should serve as a decent starting guide if you want to play more competitively.<br />
* The default keybindings for RF:G are unusual compared to other shooters, most members in the community recommend the following settings:<br />
* All options are found under <code>Main Menu</code> --> <code>Options</code><br />
<br />
* Controls & Keybindings<br />
* Zoom: Right Click<br />
* Melee Attack: F<br />
* Melee Attack 2: Side Mouse Button if your mouse has one<br />
* Shoulder Switch: Side Mouse Button if your mouse has one<br />
* Zoom: Hold<br />
* Crouch: Toggle<br />
<br />
* Audio Options (These will allow you to hear enemy movement more clearly)<br />
* Ambience: 50%<br />
* Music: 0%<br />
* Voice: 50%<br />
* SFX: 100%<br />
<br />
* Graphics Options<br />
* FOV: 85<br />
* Depth of Field: Disabled<br />
* Motion Blur: Disabled<br />
<br />
* Game Options<br />
* Camera Shake: Disabled<br />
<br />
== Run game ==<br />
<br />
All maps are included in the Terraform Patch and you don't need to install anything else. Join the [https://discord.gg/factionfiles FactionFiles Discord] and subscribe to RF:G Game Night event!</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Game_Night_News&diff=8952RF:G Game Night News2023-06-10T13:36:11Z<p>Camo: Fixed GOG MP fix download link</p>
<hr />
<div>{{Under construction}}<br />
<br />
== News ==<br />
<br />
* Terraform Patch v1.07.5 was recently released on the 8th of June, 2023. Please update before game night!<br />
* SyncFaction v9 was recently released on the 14th of March, 2023. Please update before game night!<br />
<br />
== Multiplayer Server Status ==<br />
<br />
* Steam version: Fix already included in latest update from Steam.<br />
* GOG version: You will need to manually replace <code>sw_api.dll</code> in the <code>Red Faction Guerrilla Re-Mars-tered</code> folder with the one from here: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/z_debug/mp_fix/gog/sw_api.dll<br />
<br />
== Installing Terraform Patch ==<br />
<br />
# Download https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
# Open SyncFaction.<br />
# The first time you run it SyncFaction will take some time verifying your game files are vanilla, if you encounter any errors please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game in Steam. You can quickly find your game folder by right clicking RF:G in your Steam library, selecting properties, clicking Local files and finally Browse. Verify integrity of game files is also found here.<br />
# After SyncFaction is done verifying you will see a button at the bottom middle <code>Update to latest Community Patch</code>, click it & SyncFaction will automatically download and install the patch; you will see the progress tracked in the log.<br />
# When it has successfully installed the patch you will see this wiki page instead of the log along with <code>Run Game</code>, <code>Apply</code> & <code>Refresh</code> buttons, you don't need to do anything else and can close SyncFaction now.<br />
<br />
== Updating Terraform Patch ==<br />
<br />
* If you've played game nights before, get latest SF version and let it do the update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* No need to waste time verifying game with Steam!<br />
<br />
== Troubleshooting ==<br />
<br />
* Make sure you're on the latest SF version and update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* If you suspect your game is corrupted, please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game.<br />
* Sometimes after installing the required .NET version you will need to restart your computer for SF to work.<br />
* '''DON'T''' install any mods or maps on top of the patch or you'll corrupt your game!<br />
* If you have both the Steam & GOG versions installed, lots of drives or SF is having issues finding your game install try putting <code>SyncFaction.exe</code> with <code>rfg.exe</code> in the respective game versions folder.<br />
* If your anti virus detects <code>SyncFaction.exe</code> as malware you can be assured it's a false positive, it's open source on github and developed by a trusted member of the community. You can safely make an exception in your anti virus software.<br />
* If SyncFaction has trouble downloading the patch and shows an error starting with <code>System.Net.Http.HttpRequestException</code> it's probably being blocked by your firewall.<br />
* If your game crashes on startup it's possible you incorrectly replaced <code>sw_api.dll</code> for the Steam version when that is only needed for the GOG version, try restoring it to the Steam version: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/debug/mp_fix/steam/sw_api.dll<br />
* If you're unable to move your character, pause the game and then unpause.<br />
* '''NUCLEAR''' option if other troubleshooting steps above fail or your game is frequently crashing: delete the entire <code>data</code> folder and verify game in Steam. If using GOG completely uninstall the game and install from scratch and then use the latest SF version to re-install the Terraform Patch.<br />
* This app release is not tested thoroughly so please be patient & report any bugs to rast1234.<br />
<br />
=== Saving Space ===<br />
<br />
* After you've updated to the current latest version of the patch it's safe to delete the <code>\data\.syncfaction\mod_xxx</code> folders.<br />
* This is because previous patch versions are cached there and not needed since last update is not incremental.<br />
<br />
=== Confirming Patch Installed Correctly === <br />
<br />
* On the first loading screen before the main menu you should see <code>Terraform Patch v1.075 ALPHA</code> at the bottom right. Example: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/misc.vpp_pc/E_TEXTURE_CHANGES/SOURCE/ui_loading_init.png?raw=true<br />
* When creating a custom match the default options should have fleetfoot selected as the starting backpack.<br />
* You should see DLC Wrecking Crew & custom maps when going through map selection such as Storage, Abandoned, Nordic Bonus, Ruins, Imperial etc.<br />
* You should see DLC Weapons when going through weapons such as the Subverter, Spiker, Misslepod etc.<br />
* You should see new characters in the multiplayer customization screen such as Jenkins, Sam, Voice of Mars etc.<br />
<br />
=== Networking Issues === <br />
<br />
* As the game relies on THQN servers and it seems NAT punching isn't always reliable some connection issues like not being able to join certain players, players not being able to join you or an unusual issue where you're stuck spectating when the game begins may require manual configuration of your network to resolve.<br />
* Ensure <code>rfg.exe</code> isn't blocked by the Windows Firewall for both inbound and outbound connections. You can make a new rule by searching for <code>Windows Defender Firewall with Advanced Security</code>. See the guide below for more advanced instructions.<br />
* Ensure all the games ports are forwarded in your routers firewall: you will need to setup a Static IP on your computer and forward the following ports in your router: <code>TCP: 80</code>, <code>UDP: 88</code>, <code>TCP/UDP: 443</code>, <code>TCP/UDP: 3074</code>, <code>UDP: 3478</code>, <code>UDP: 4379-4380</code>, <code>TCP/UDP: 23022</code>, <code>TCP/UDP: 38888</code>, <code>TCP/UDP 27000-27100</code> & <code>TCP/UDP: 61111</code>. Consult your routers manual on how to do this and see the guide below for detailed instructions on setting up a Static IP.<br />
* You can also setup DMZ for your Static IP but this is less secure. Consult your routers manual on how to do this.<br />
* It's possible your ISP is blocking ports, you can try using their app if they provide one or calling them and asking them to unblock all ports.<br />
* It's possible issues may be caused by a bad router/modem.<br />
* [https://www.howtogeek.com/19249/how-to-assign-a-static-ip-address-in-xp-vista-or-windows-7/ How to Assign a Static IP Address in Windows 10 or 11]<br />
* [https://www.howtogeek.com/112564/how-to-create-advanced-firewall-rules-in-the-windows-firewall/ How to Create Advanced Firewall Rules in the Windows Firewall]<br />
<br />
=== Configs & Save Data Corruption ===<br />
<br />
* It's unknown if this is required but it might be worth a try if you've followed all previous troubleshooting steps and you're still having issues with your game.<br />
* Delete <code>config.ini</code> in <code>%APPDATA%\kaiko\rfg\</code>. This will reset all your settings to default and you will have to reconfigure them the next time you start your game.<br />
* Steam save: <code><Steam-folder>\userdata\<user-id>\667720\remote\</code> or <code><Steam-folder>\userdata\<user-id>\667720\remote\autocloud\save</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* GOG save: <code>%LOCALAPPDATA%\GOG.com\Galaxy\Applications\51153410217180642\Storage\Shared\Files\autocloud\save\</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* Note: It's possible to transfer the Steam save to GOG or vice versa so you can try that also.<br />
<br />
=== Improving Game Stability ===<br />
<br />
# Right click <code>rfg.exe</code> in your game folder.<br />
# Select <code>Properties</code> in the context menu.<br />
# Select the <code>Compatibility</code> tab.<br />
# Tick <code>Disable fullscreen optimizations</code>.<br />
# Click <code>Change high DPI settings</code>.<br />
# Tick <code>Override high DPI scaling Behavior. Scaling performed by: Application</code>.<br />
# Click ok to both windows.<br />
# If on Windows 11 follow the below additional steps.<br />
# Open the <code>Settings</code> app.<br />
# Navigate to System > Display > Graphics > Add an app > Desktop app > Find <code>rfg.exe</code>.<br />
# Once it's added, search for rfg and click <code>Options</code>.<br />
# Tick <code>Don't use optimizations for windowed games</code>.<br />
# Make sure you select exclusive fullscreen inside the games option menu.<br />
[[File:GameStabilityFix.jpeg|frameless|512px]]<br />
<br />
=== Microstuttering Fix ===<br />
<br />
* Disable '''VSYNC''' in the games option menu.<br />
* Force '''VSYNC''' in your graphics card control panel. <br />
* Cap the framerate to your refresh rate in your graphics card control panel.<br />
* Make sure you select exclusive fullscreen inside the games option menu.<br />
<br />
== Terraform Patch Info ==<br />
<br />
* Changelog: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/changelog.txt<br />
* Known Issues: https://github.com/users/CamoRF/projects/3/views/1<br />
* Github: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch<br />
* This patch is an alpha version so you may encounter bugs, please ping Camo in the rfg-modding channel to report any issues.<br />
<br />
== Recommended Competitive Game Settings ==<br />
<br />
* Note: settings are always personal preference but this should serve as a decent starting guide if you want to play more competitively.<br />
* The default keybindings for RF:G are unusual compared to other shooters, most members in the community recommend the following settings:<br />
* All options are found under <code>Main Menu</code> --> <code>Options</code><br />
<br />
* Controls & Keybindings<br />
* Zoom: Right Click<br />
* Melee Attack: F<br />
* Melee Attack 2: Side Mouse Button if your mouse has one<br />
* Shoulder Switch: Side Mouse Button if your mouse has one<br />
* Zoom: Hold<br />
* Crouch: Toggle<br />
<br />
* Audio Options (These will allow you to hear enemy movement more clearly)<br />
* Ambience: 50%<br />
* Music: 0%<br />
* Voice: 50%<br />
* SFX: 100%<br />
<br />
* Graphics Options<br />
* FOV: 85<br />
* Depth of Field: Disabled<br />
* Motion Blur: Disabled<br />
<br />
* Game Options<br />
* Camera Shake: Disabled<br />
<br />
== Run game ==<br />
<br />
All maps are included in the Terraform Patch and you don't need to install anything else. Join the [https://discord.gg/factionfiles FactionFiles Discord] and subscribe to RF:G Game Night event!</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Game_Night_News&diff=8951RF:G Game Night News2023-06-10T04:24:33Z<p>Camo: /* Troubleshooting */</p>
<hr />
<div>{{Under construction}}<br />
<br />
== News ==<br />
<br />
* Terraform Patch v1.07.5 was recently released on the 8th of June, 2023. Please update before game night!<br />
* SyncFaction v9 was recently released on the 14th of March, 2023. Please update before game night!<br />
<br />
== Multiplayer Server Status ==<br />
<br />
* Steam version: Fix already included in latest update from Steam.<br />
* GOG version: You will need to manually replace <code>sw_api.dll</code> in the <code>Red Faction Guerrilla Re-Mars-tered</code> folder with the one from here: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/debug/mp_fix/gog/sw_api.dll<br />
<br />
== Installing Terraform Patch ==<br />
<br />
# Download https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
# Open SyncFaction.<br />
# The first time you run it SyncFaction will take some time verifying your game files are vanilla, if you encounter any errors please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game in Steam. You can quickly find your game folder by right clicking RF:G in your Steam library, selecting properties, clicking Local files and finally Browse. Verify integrity of game files is also found here.<br />
# After SyncFaction is done verifying you will see a button at the bottom middle <code>Update to latest Community Patch</code>, click it & SyncFaction will automatically download and install the patch; you will see the progress tracked in the log.<br />
# When it has successfully installed the patch you will see this wiki page instead of the log along with <code>Run Game</code>, <code>Apply</code> & <code>Refresh</code> buttons, you don't need to do anything else and can close SyncFaction now.<br />
<br />
== Updating Terraform Patch ==<br />
<br />
* If you've played game nights before, get latest SF version and let it do the update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* No need to waste time verifying game with Steam!<br />
<br />
== Troubleshooting ==<br />
<br />
* Make sure you're on the latest SF version and update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* If you suspect your game is corrupted, please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game.<br />
* Sometimes after installing the required .NET version you will need to restart your computer for SF to work.<br />
* '''DON'T''' install any mods or maps on top of the patch or you'll corrupt your game!<br />
* If you have both the Steam & GOG versions installed, lots of drives or SF is having issues finding your game install try putting <code>SyncFaction.exe</code> with <code>rfg.exe</code> in the respective game versions folder.<br />
* If your anti virus detects <code>SyncFaction.exe</code> as malware you can be assured it's a false positive, it's open source on github and developed by a trusted member of the community. You can safely make an exception in your anti virus software.<br />
* If SyncFaction has trouble downloading the patch and shows an error starting with <code>System.Net.Http.HttpRequestException</code> it's probably being blocked by your firewall.<br />
* If your game crashes on startup it's possible you incorrectly replaced <code>sw_api.dll</code> for the Steam version when that is only needed for the GOG version, try restoring it to the Steam version: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/debug/mp_fix/steam/sw_api.dll<br />
* If you're unable to move your character, pause the game and then unpause.<br />
* '''NUCLEAR''' option if other troubleshooting steps above fail or your game is frequently crashing: delete the entire <code>data</code> folder and verify game in Steam. If using GOG completely uninstall the game and install from scratch and then use the latest SF version to re-install the Terraform Patch.<br />
* This app release is not tested thoroughly so please be patient & report any bugs to rast1234.<br />
<br />
=== Saving Space ===<br />
<br />
* After you've updated to the current latest version of the patch it's safe to delete the <code>\data\.syncfaction\mod_xxx</code> folders.<br />
* This is because previous patch versions are cached there and not needed since last update is not incremental.<br />
<br />
=== Confirming Patch Installed Correctly === <br />
<br />
* On the first loading screen before the main menu you should see <code>Terraform Patch v1.075 ALPHA</code> at the bottom right. Example: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/misc.vpp_pc/E_TEXTURE_CHANGES/SOURCE/ui_loading_init.png?raw=true<br />
* When creating a custom match the default options should have fleetfoot selected as the starting backpack.<br />
* You should see DLC Wrecking Crew & custom maps when going through map selection such as Storage, Abandoned, Nordic Bonus, Ruins, Imperial etc.<br />
* You should see DLC Weapons when going through weapons such as the Subverter, Spiker, Misslepod etc.<br />
* You should see new characters in the multiplayer customization screen such as Jenkins, Sam, Voice of Mars etc.<br />
<br />
=== Networking Issues === <br />
<br />
* As the game relies on THQN servers and it seems NAT punching isn't always reliable some connection issues like not being able to join certain players, players not being able to join you or an unusual issue where you're stuck spectating when the game begins may require manual configuration of your network to resolve.<br />
* Ensure <code>rfg.exe</code> isn't blocked by the Windows Firewall for both inbound and outbound connections. You can make a new rule by searching for <code>Windows Defender Firewall with Advanced Security</code>. See the guide below for more advanced instructions.<br />
* Ensure all the games ports are forwarded in your routers firewall: you will need to setup a Static IP on your computer and forward the following ports in your router: <code>TCP: 80</code>, <code>UDP: 88</code>, <code>TCP/UDP: 443</code>, <code>TCP/UDP: 3074</code>, <code>UDP: 3478</code>, <code>UDP: 4379-4380</code>, <code>TCP/UDP: 23022</code>, <code>TCP/UDP: 38888</code>, <code>TCP/UDP 27000-27100</code> & <code>TCP/UDP: 61111</code>. Consult your routers manual on how to do this and see the guide below for detailed instructions on setting up a Static IP.<br />
* You can also setup DMZ for your Static IP but this is less secure. Consult your routers manual on how to do this.<br />
* It's possible your ISP is blocking ports, you can try using their app if they provide one or calling them and asking them to unblock all ports.<br />
* It's possible issues may be caused by a bad router/modem.<br />
* [https://www.howtogeek.com/19249/how-to-assign-a-static-ip-address-in-xp-vista-or-windows-7/ How to Assign a Static IP Address in Windows 10 or 11]<br />
* [https://www.howtogeek.com/112564/how-to-create-advanced-firewall-rules-in-the-windows-firewall/ How to Create Advanced Firewall Rules in the Windows Firewall]<br />
<br />
=== Configs & Save Data Corruption ===<br />
<br />
* It's unknown if this is required but it might be worth a try if you've followed all previous troubleshooting steps and you're still having issues with your game.<br />
* Delete <code>config.ini</code> in <code>%APPDATA%\kaiko\rfg\</code>. This will reset all your settings to default and you will have to reconfigure them the next time you start your game.<br />
* Steam save: <code><Steam-folder>\userdata\<user-id>\667720\remote\</code> or <code><Steam-folder>\userdata\<user-id>\667720\remote\autocloud\save</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* GOG save: <code>%LOCALAPPDATA%\GOG.com\Galaxy\Applications\51153410217180642\Storage\Shared\Files\autocloud\save\</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* Note: It's possible to transfer the Steam save to GOG or vice versa so you can try that also.<br />
<br />
=== Improving Game Stability ===<br />
<br />
# Right click <code>rfg.exe</code> in your game folder.<br />
# Select <code>Properties</code> in the context menu.<br />
# Select the <code>Compatibility</code> tab.<br />
# Tick <code>Disable fullscreen optimizations</code>.<br />
# Click <code>Change high DPI settings</code>.<br />
# Tick <code>Override high DPI scaling Behavior. Scaling performed by: Application</code>.<br />
# Click ok to both windows.<br />
# If on Windows 11 follow the below additional steps.<br />
# Open the <code>Settings</code> app.<br />
# Navigate to System > Display > Graphics > Add an app > Desktop app > Find <code>rfg.exe</code>.<br />
# Once it's added, search for rfg and click <code>Options</code>.<br />
# Tick <code>Don't use optimizations for windowed games</code>.<br />
# Make sure you select exclusive fullscreen inside the games option menu.<br />
[[File:GameStabilityFix.jpeg|frameless|512px]]<br />
<br />
=== Microstuttering Fix ===<br />
<br />
* Disable '''VSYNC''' in the games option menu.<br />
* Force '''VSYNC''' in your graphics card control panel. <br />
* Cap the framerate to your refresh rate in your graphics card control panel.<br />
* Make sure you select exclusive fullscreen inside the games option menu.<br />
<br />
== Terraform Patch Info ==<br />
<br />
* Changelog: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/changelog.txt<br />
* Known Issues: https://github.com/users/CamoRF/projects/3/views/1<br />
* Github: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch<br />
* This patch is an alpha version so you may encounter bugs, please ping Camo in the rfg-modding channel to report any issues.<br />
<br />
== Recommended Competitive Game Settings ==<br />
<br />
* Note: settings are always personal preference but this should serve as a decent starting guide if you want to play more competitively.<br />
* The default keybindings for RF:G are unusual compared to other shooters, most members in the community recommend the following settings:<br />
* All options are found under <code>Main Menu</code> --> <code>Options</code><br />
<br />
* Controls & Keybindings<br />
* Zoom: Right Click<br />
* Melee Attack: F<br />
* Melee Attack 2: Side Mouse Button if your mouse has one<br />
* Shoulder Switch: Side Mouse Button if your mouse has one<br />
* Zoom: Hold<br />
* Crouch: Toggle<br />
<br />
* Audio Options (These will allow you to hear enemy movement more clearly)<br />
* Ambience: 50%<br />
* Music: 0%<br />
* Voice: 50%<br />
* SFX: 100%<br />
<br />
* Graphics Options<br />
* FOV: 85<br />
* Depth of Field: Disabled<br />
* Motion Blur: Disabled<br />
<br />
* Game Options<br />
* Camera Shake: Disabled<br />
<br />
== Run game ==<br />
<br />
All maps are included in the Terraform Patch and you don't need to install anything else. Join the [https://discord.gg/factionfiles FactionFiles Discord] and subscribe to RF:G Game Night event!</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Game_Night_News&diff=8950RF:G Game Night News2023-06-10T02:56:20Z<p>Camo: /* Troubleshooting */</p>
<hr />
<div>{{Under construction}}<br />
<br />
== News ==<br />
<br />
* Terraform Patch v1.07.5 was recently released on the 8th of June, 2023. Please update before game night!<br />
* SyncFaction v9 was recently released on the 14th of March, 2023. Please update before game night!<br />
<br />
== Multiplayer Server Status ==<br />
<br />
* Steam version: Fix already included in latest update from Steam.<br />
* GOG version: You will need to manually replace <code>sw_api.dll</code> in the <code>Red Faction Guerrilla Re-Mars-tered</code> folder with the one from here: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/debug/mp_fix/gog/sw_api.dll<br />
<br />
== Installing Terraform Patch ==<br />
<br />
# Download https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
# Open SyncFaction.<br />
# The first time you run it SyncFaction will take some time verifying your game files are vanilla, if you encounter any errors please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game in Steam. You can quickly find your game folder by right clicking RF:G in your Steam library, selecting properties, clicking Local files and finally Browse. Verify integrity of game files is also found here.<br />
# After SyncFaction is done verifying you will see a button at the bottom middle <code>Update to latest Community Patch</code>, click it & SyncFaction will automatically download and install the patch; you will see the progress tracked in the log.<br />
# When it has successfully installed the patch you will see this wiki page instead of the log along with <code>Run Game</code>, <code>Apply</code> & <code>Refresh</code> buttons, you don't need to do anything else and can close SyncFaction now.<br />
<br />
== Updating Terraform Patch ==<br />
<br />
* If you've played game nights before, get latest SF version and let it do the update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* No need to waste time verifying game with Steam!<br />
<br />
== Troubleshooting ==<br />
<br />
* Make sure you're on the latest SF version and update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* If you suspect your game is corrupted, please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game.<br />
* Sometimes after installing the required .NET version you will need to restart your computer for SF to work.<br />
* '''DON'T''' install any mods or maps on top of the patch or you'll corrupt your game!<br />
* If you have both the Steam & GOG versions installed, lots of drives or SF is having issues finding your game install try putting <code>SyncFaction.exe</code> with <code>rfg.exe</code> in the respective game versions folder.<br />
* If your anti virus detects <code>SyncFaction.exe</code> as malware you can be assured it's a false positive, it's open source on github and developed by a trusted member of the community. You can safely make an exception in your anti virus software.<br />
* If SyncFaction has trouble downloading the patch and shows an error starting with <code>System.Net.Http.HttpRequestException</code> it's probably being blocked by your firewall.<br />
* If your game crashes on startup it's possible you incorrectly replaced <code>sw_api.dll</code> for the Steam version when that is only needed for the GOG version, try restoring it to the Steam version: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/debug/mp_fix/steam/sw_api.dll<br />
* '''NUCLEAR''' option if other troubleshooting steps above fail or your game is frequently crashing: delete the entire <code>data</code> folder and verify game in Steam. If using GOG completely uninstall the game and install from scratch and then use the latest SF version to re-install the Terraform Patch.<br />
* If you're unable to move your character, pause the game and then unpause.<br />
* This app release is not tested thoroughly so please be patient & report any bugs to rast1234.<br />
<br />
=== Saving Space ===<br />
<br />
* After you've updated to the current latest version of the patch it's safe to delete the <code>\data\.syncfaction\mod_xxx</code> folders.<br />
* This is because previous patch versions are cached there and not needed since last update is not incremental.<br />
<br />
=== Confirming Patch Installed Correctly === <br />
<br />
* On the first loading screen before the main menu you should see <code>Terraform Patch v1.075 ALPHA</code> at the bottom right. Example: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/misc.vpp_pc/E_TEXTURE_CHANGES/SOURCE/ui_loading_init.png?raw=true<br />
* When creating a custom match the default options should have fleetfoot selected as the starting backpack.<br />
* You should see DLC Wrecking Crew & custom maps when going through map selection such as Storage, Abandoned, Nordic Bonus, Ruins, Imperial etc.<br />
* You should see DLC Weapons when going through weapons such as the Subverter, Spiker, Misslepod etc.<br />
* You should see new characters in the multiplayer customization screen such as Jenkins, Sam, Voice of Mars etc.<br />
<br />
=== Networking Issues === <br />
<br />
* As the game relies on THQN servers and it seems NAT punching isn't always reliable some connection issues like not being able to join certain players, players not being able to join you or an unusual issue where you're stuck spectating when the game begins may require manual configuration of your network to resolve.<br />
* Ensure <code>rfg.exe</code> isn't blocked by the Windows Firewall for both inbound and outbound connections. You can make a new rule by searching for <code>Windows Defender Firewall with Advanced Security</code>. See the guide below for more advanced instructions.<br />
* Ensure all the games ports are forwarded in your routers firewall: you will need to setup a Static IP on your computer and forward the following ports in your router: <code>TCP: 80</code>, <code>UDP: 88</code>, <code>TCP/UDP: 443</code>, <code>TCP/UDP: 3074</code>, <code>UDP: 3478</code>, <code>UDP: 4379-4380</code>, <code>TCP/UDP: 23022</code>, <code>TCP/UDP: 38888</code>, <code>TCP/UDP 27000-27100</code> & <code>TCP/UDP: 61111</code>. Consult your routers manual on how to do this and see the guide below for detailed instructions on setting up a Static IP.<br />
* You can also setup DMZ for your Static IP but this is less secure. Consult your routers manual on how to do this.<br />
* It's possible your ISP is blocking ports, you can try using their app if they provide one or calling them and asking them to unblock all ports.<br />
* It's possible issues may be caused by a bad router/modem.<br />
* [https://www.howtogeek.com/19249/how-to-assign-a-static-ip-address-in-xp-vista-or-windows-7/ How to Assign a Static IP Address in Windows 10 or 11]<br />
* [https://www.howtogeek.com/112564/how-to-create-advanced-firewall-rules-in-the-windows-firewall/ How to Create Advanced Firewall Rules in the Windows Firewall]<br />
<br />
=== Configs & Save Data Corruption ===<br />
<br />
* It's unknown if this is required but it might be worth a try if you've followed all previous troubleshooting steps and you're still having issues with your game.<br />
* Delete <code>config.ini</code> in <code>%APPDATA%\kaiko\rfg\</code>. This will reset all your settings to default and you will have to reconfigure them the next time you start your game.<br />
* Steam save: <code><Steam-folder>\userdata\<user-id>\667720\remote\</code> or <code><Steam-folder>\userdata\<user-id>\667720\remote\autocloud\save</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* GOG save: <code>%LOCALAPPDATA%\GOG.com\Galaxy\Applications\51153410217180642\Storage\Shared\Files\autocloud\save\</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* Note: It's possible to transfer the Steam save to GOG or vice versa so you can try that also.<br />
<br />
=== Improving Game Stability ===<br />
<br />
# Right click <code>rfg.exe</code> in your game folder.<br />
# Select <code>Properties</code> in the context menu.<br />
# Select the <code>Compatibility</code> tab.<br />
# Tick <code>Disable fullscreen optimizations</code>.<br />
# Click <code>Change high DPI settings</code>.<br />
# Tick <code>Override high DPI scaling Behavior. Scaling performed by: Application</code>.<br />
# Click ok to both windows.<br />
# If on Windows 11 follow the below additional steps.<br />
# Open the <code>Settings</code> app.<br />
# Navigate to System > Display > Graphics > Add an app > Desktop app > Find <code>rfg.exe</code>.<br />
# Once it's added, search for rfg and click <code>Options</code>.<br />
# Tick <code>Don't use optimizations for windowed games</code>.<br />
# Make sure you select exclusive fullscreen inside the games option menu.<br />
[[File:GameStabilityFix.jpeg|frameless|512px]]<br />
<br />
=== Microstuttering Fix ===<br />
<br />
* Disable '''VSYNC''' in the games option menu.<br />
* Force '''VSYNC''' in your graphics card control panel. <br />
* Cap the framerate to your refresh rate in your graphics card control panel.<br />
* Make sure you select exclusive fullscreen inside the games option menu.<br />
<br />
== Terraform Patch Info ==<br />
<br />
* Changelog: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/changelog.txt<br />
* Known Issues: https://github.com/users/CamoRF/projects/3/views/1<br />
* Github: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch<br />
* This patch is an alpha version so you may encounter bugs, please ping Camo in the rfg-modding channel to report any issues.<br />
<br />
== Recommended Competitive Game Settings ==<br />
<br />
* Note: settings are always personal preference but this should serve as a decent starting guide if you want to play more competitively.<br />
* The default keybindings for RF:G are unusual compared to other shooters, most members in the community recommend the following settings:<br />
* All options are found under <code>Main Menu</code> --> <code>Options</code><br />
<br />
* Controls & Keybindings<br />
* Zoom: Right Click<br />
* Melee Attack: F<br />
* Melee Attack 2: Side Mouse Button if your mouse has one<br />
* Shoulder Switch: Side Mouse Button if your mouse has one<br />
* Zoom: Hold<br />
* Crouch: Toggle<br />
<br />
* Audio Options (These will allow you to hear enemy movement more clearly)<br />
* Ambience: 50%<br />
* Music: 0%<br />
* Voice: 50%<br />
* SFX: 100%<br />
<br />
* Graphics Options<br />
* FOV: 85<br />
* Depth of Field: Disabled<br />
* Motion Blur: Disabled<br />
<br />
* Game Options<br />
* Camera Shake: Disabled<br />
<br />
== Run game ==<br />
<br />
All maps are included in the Terraform Patch and you don't need to install anything else. Join the [https://discord.gg/factionfiles FactionFiles Discord] and subscribe to RF:G Game Night event!</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Game_Night_News&diff=8949RF:G Game Night News2023-06-10T02:56:06Z<p>Camo: /* Troubleshooting */</p>
<hr />
<div>{{Under construction}}<br />
<br />
== News ==<br />
<br />
* Terraform Patch v1.07.5 was recently released on the 8th of June, 2023. Please update before game night!<br />
* SyncFaction v9 was recently released on the 14th of March, 2023. Please update before game night!<br />
<br />
== Multiplayer Server Status ==<br />
<br />
* Steam version: Fix already included in latest update from Steam.<br />
* GOG version: You will need to manually replace <code>sw_api.dll</code> in the <code>Red Faction Guerrilla Re-Mars-tered</code> folder with the one from here: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/debug/mp_fix/gog/sw_api.dll<br />
<br />
== Installing Terraform Patch ==<br />
<br />
# Download https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
# Open SyncFaction.<br />
# The first time you run it SyncFaction will take some time verifying your game files are vanilla, if you encounter any errors please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game in Steam. You can quickly find your game folder by right clicking RF:G in your Steam library, selecting properties, clicking Local files and finally Browse. Verify integrity of game files is also found here.<br />
# After SyncFaction is done verifying you will see a button at the bottom middle <code>Update to latest Community Patch</code>, click it & SyncFaction will automatically download and install the patch; you will see the progress tracked in the log.<br />
# When it has successfully installed the patch you will see this wiki page instead of the log along with <code>Run Game</code>, <code>Apply</code> & <code>Refresh</code> buttons, you don't need to do anything else and can close SyncFaction now.<br />
<br />
== Updating Terraform Patch ==<br />
<br />
* If you've played game nights before, get latest SF version and let it do the update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* No need to waste time verifying game with Steam!<br />
<br />
== Troubleshooting ==<br />
<br />
* Make sure you're on the latest SF version and update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* If you suspect your game is corrupted, please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game.<br />
* Sometimes after installing the required .NET version you will need to restart your computer for SF to work.<br />
* '''DON'T''' install any mods or maps on top of the patch or you'll corrupt your game!<br />
* If you have both the Steam & GOG versions installed, lots of drives or SF is having issues finding your game install try putting <code>SyncFaction.exe</code> with <code>rfg.exe</code> in the respective game versions folder.<br />
* If your anti virus detects <code>SyncFaction.exe</code> as malware you can be assured it's a false positive, it's open source on github and developed by a trusted member of the community. You can safely make an exception in your anti virus software.<br />
* If SyncFaction has trouble downloading the patch and shows an error starting with <code>System.Net.Http.HttpRequestException</code> it's probably being blocked by your firewall.<br />
* If your game crashes on startup it's possible you incorrectly replaced <code>sw_api.dll</code> for the Steam version when that is only needed for the GOG version, try restoring it to the Steam version: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/debug/mp_fix/steam/sw_api.dll<br />
* ```NUCLEAR``` option if other troubleshooting steps above fail or your game is frequently crashing: delete the entire <code>data</code> folder and verify game in Steam. If using GOG completely uninstall the game and install from scratch and then use the latest SF version to re-install the Terraform Patch.<br />
* If you're unable to move your character, pause the game and then unpause.<br />
* This app release is not tested thoroughly so please be patient & report any bugs to rast1234.<br />
<br />
=== Saving Space ===<br />
<br />
* After you've updated to the current latest version of the patch it's safe to delete the <code>\data\.syncfaction\mod_xxx</code> folders.<br />
* This is because previous patch versions are cached there and not needed since last update is not incremental.<br />
<br />
=== Confirming Patch Installed Correctly === <br />
<br />
* On the first loading screen before the main menu you should see <code>Terraform Patch v1.075 ALPHA</code> at the bottom right. Example: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/misc.vpp_pc/E_TEXTURE_CHANGES/SOURCE/ui_loading_init.png?raw=true<br />
* When creating a custom match the default options should have fleetfoot selected as the starting backpack.<br />
* You should see DLC Wrecking Crew & custom maps when going through map selection such as Storage, Abandoned, Nordic Bonus, Ruins, Imperial etc.<br />
* You should see DLC Weapons when going through weapons such as the Subverter, Spiker, Misslepod etc.<br />
* You should see new characters in the multiplayer customization screen such as Jenkins, Sam, Voice of Mars etc.<br />
<br />
=== Networking Issues === <br />
<br />
* As the game relies on THQN servers and it seems NAT punching isn't always reliable some connection issues like not being able to join certain players, players not being able to join you or an unusual issue where you're stuck spectating when the game begins may require manual configuration of your network to resolve.<br />
* Ensure <code>rfg.exe</code> isn't blocked by the Windows Firewall for both inbound and outbound connections. You can make a new rule by searching for <code>Windows Defender Firewall with Advanced Security</code>. See the guide below for more advanced instructions.<br />
* Ensure all the games ports are forwarded in your routers firewall: you will need to setup a Static IP on your computer and forward the following ports in your router: <code>TCP: 80</code>, <code>UDP: 88</code>, <code>TCP/UDP: 443</code>, <code>TCP/UDP: 3074</code>, <code>UDP: 3478</code>, <code>UDP: 4379-4380</code>, <code>TCP/UDP: 23022</code>, <code>TCP/UDP: 38888</code>, <code>TCP/UDP 27000-27100</code> & <code>TCP/UDP: 61111</code>. Consult your routers manual on how to do this and see the guide below for detailed instructions on setting up a Static IP.<br />
* You can also setup DMZ for your Static IP but this is less secure. Consult your routers manual on how to do this.<br />
* It's possible your ISP is blocking ports, you can try using their app if they provide one or calling them and asking them to unblock all ports.<br />
* It's possible issues may be caused by a bad router/modem.<br />
* [https://www.howtogeek.com/19249/how-to-assign-a-static-ip-address-in-xp-vista-or-windows-7/ How to Assign a Static IP Address in Windows 10 or 11]<br />
* [https://www.howtogeek.com/112564/how-to-create-advanced-firewall-rules-in-the-windows-firewall/ How to Create Advanced Firewall Rules in the Windows Firewall]<br />
<br />
=== Configs & Save Data Corruption ===<br />
<br />
* It's unknown if this is required but it might be worth a try if you've followed all previous troubleshooting steps and you're still having issues with your game.<br />
* Delete <code>config.ini</code> in <code>%APPDATA%\kaiko\rfg\</code>. This will reset all your settings to default and you will have to reconfigure them the next time you start your game.<br />
* Steam save: <code><Steam-folder>\userdata\<user-id>\667720\remote\</code> or <code><Steam-folder>\userdata\<user-id>\667720\remote\autocloud\save</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* GOG save: <code>%LOCALAPPDATA%\GOG.com\Galaxy\Applications\51153410217180642\Storage\Shared\Files\autocloud\save\</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* Note: It's possible to transfer the Steam save to GOG or vice versa so you can try that also.<br />
<br />
=== Improving Game Stability ===<br />
<br />
# Right click <code>rfg.exe</code> in your game folder.<br />
# Select <code>Properties</code> in the context menu.<br />
# Select the <code>Compatibility</code> tab.<br />
# Tick <code>Disable fullscreen optimizations</code>.<br />
# Click <code>Change high DPI settings</code>.<br />
# Tick <code>Override high DPI scaling Behavior. Scaling performed by: Application</code>.<br />
# Click ok to both windows.<br />
# If on Windows 11 follow the below additional steps.<br />
# Open the <code>Settings</code> app.<br />
# Navigate to System > Display > Graphics > Add an app > Desktop app > Find <code>rfg.exe</code>.<br />
# Once it's added, search for rfg and click <code>Options</code>.<br />
# Tick <code>Don't use optimizations for windowed games</code>.<br />
# Make sure you select exclusive fullscreen inside the games option menu.<br />
[[File:GameStabilityFix.jpeg|frameless|512px]]<br />
<br />
=== Microstuttering Fix ===<br />
<br />
* Disable '''VSYNC''' in the games option menu.<br />
* Force '''VSYNC''' in your graphics card control panel. <br />
* Cap the framerate to your refresh rate in your graphics card control panel.<br />
* Make sure you select exclusive fullscreen inside the games option menu.<br />
<br />
== Terraform Patch Info ==<br />
<br />
* Changelog: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/changelog.txt<br />
* Known Issues: https://github.com/users/CamoRF/projects/3/views/1<br />
* Github: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch<br />
* This patch is an alpha version so you may encounter bugs, please ping Camo in the rfg-modding channel to report any issues.<br />
<br />
== Recommended Competitive Game Settings ==<br />
<br />
* Note: settings are always personal preference but this should serve as a decent starting guide if you want to play more competitively.<br />
* The default keybindings for RF:G are unusual compared to other shooters, most members in the community recommend the following settings:<br />
* All options are found under <code>Main Menu</code> --> <code>Options</code><br />
<br />
* Controls & Keybindings<br />
* Zoom: Right Click<br />
* Melee Attack: F<br />
* Melee Attack 2: Side Mouse Button if your mouse has one<br />
* Shoulder Switch: Side Mouse Button if your mouse has one<br />
* Zoom: Hold<br />
* Crouch: Toggle<br />
<br />
* Audio Options (These will allow you to hear enemy movement more clearly)<br />
* Ambience: 50%<br />
* Music: 0%<br />
* Voice: 50%<br />
* SFX: 100%<br />
<br />
* Graphics Options<br />
* FOV: 85<br />
* Depth of Field: Disabled<br />
* Motion Blur: Disabled<br />
<br />
* Game Options<br />
* Camera Shake: Disabled<br />
<br />
== Run game ==<br />
<br />
All maps are included in the Terraform Patch and you don't need to install anything else. Join the [https://discord.gg/factionfiles FactionFiles Discord] and subscribe to RF:G Game Night event!</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Game_Night_News&diff=8948RF:G Game Night News2023-06-10T02:52:07Z<p>Camo: /* Microstuttering Fix */</p>
<hr />
<div>{{Under construction}}<br />
<br />
== News ==<br />
<br />
* Terraform Patch v1.07.5 was recently released on the 8th of June, 2023. Please update before game night!<br />
* SyncFaction v9 was recently released on the 14th of March, 2023. Please update before game night!<br />
<br />
== Multiplayer Server Status ==<br />
<br />
* Steam version: Fix already included in latest update from Steam.<br />
* GOG version: You will need to manually replace <code>sw_api.dll</code> in the <code>Red Faction Guerrilla Re-Mars-tered</code> folder with the one from here: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/debug/mp_fix/gog/sw_api.dll<br />
<br />
== Installing Terraform Patch ==<br />
<br />
# Download https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
# Open SyncFaction.<br />
# The first time you run it SyncFaction will take some time verifying your game files are vanilla, if you encounter any errors please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game in Steam. You can quickly find your game folder by right clicking RF:G in your Steam library, selecting properties, clicking Local files and finally Browse. Verify integrity of game files is also found here.<br />
# After SyncFaction is done verifying you will see a button at the bottom middle <code>Update to latest Community Patch</code>, click it & SyncFaction will automatically download and install the patch; you will see the progress tracked in the log.<br />
# When it has successfully installed the patch you will see this wiki page instead of the log along with <code>Run Game</code>, <code>Apply</code> & <code>Refresh</code> buttons, you don't need to do anything else and can close SyncFaction now.<br />
<br />
== Updating Terraform Patch ==<br />
<br />
* If you've played game nights before, get latest SF version and let it do the update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* No need to waste time verifying game with Steam!<br />
<br />
== Troubleshooting ==<br />
<br />
* Make sure you're on the latest SF version and update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* If you suspect your game is corrupted, please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game.<br />
* Sometimes after installing the required .NET version you will need to restart your computer for SF to work.<br />
* '''DON'T''' install any mods or maps on top of the patch or you'll corrupt your game!<br />
* If you have both the Steam & GOG versions installed, lots of drives or SF is having issues finding your game install try putting <code>SyncFaction.exe</code> with <code>rfg.exe</code> in the respective game versions folder.<br />
* If your anti virus detects <code>SyncFaction.exe</code> as malware you can be assured it's a false positive, it's open source on github and developed by a trusted member of the community. You can safely make an exception in your anti virus software.<br />
* If SyncFaction has trouble downloading the patch and shows an error starting with <code>System.Net.Http.HttpRequestException</code> it's probably being blocked by your firewall.<br />
* If your game crashes on startup it's possible you incorrectly replaced <code>sw_api.dll</code> for the Steam version when that is only needed for the GOG version, try restoring it to the Steam version: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/debug/mp_fix/steam/sw_api.dll<br />
* Nuclear option if other troubleshooting steps above fail: delete the entire <code>data</code> folder and verify game in Steam. If using GOG completely uninstall the game and install from scratch and then use the latest SF version to re-install the Terraform Patch.<br />
* If you're unable to move your character, pause the game and then unpause.<br />
* This app release is not tested thoroughly so please be patient & report any bugs to rast1234.<br />
<br />
=== Saving Space ===<br />
<br />
* After you've updated to the current latest version of the patch it's safe to delete the <code>\data\.syncfaction\mod_xxx</code> folders.<br />
* This is because previous patch versions are cached there and not needed since last update is not incremental.<br />
<br />
=== Confirming Patch Installed Correctly === <br />
<br />
* On the first loading screen before the main menu you should see <code>Terraform Patch v1.075 ALPHA</code> at the bottom right. Example: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/misc.vpp_pc/E_TEXTURE_CHANGES/SOURCE/ui_loading_init.png?raw=true<br />
* When creating a custom match the default options should have fleetfoot selected as the starting backpack.<br />
* You should see DLC Wrecking Crew & custom maps when going through map selection such as Storage, Abandoned, Nordic Bonus, Ruins, Imperial etc.<br />
* You should see DLC Weapons when going through weapons such as the Subverter, Spiker, Misslepod etc.<br />
* You should see new characters in the multiplayer customization screen such as Jenkins, Sam, Voice of Mars etc.<br />
<br />
=== Networking Issues === <br />
<br />
* As the game relies on THQN servers and it seems NAT punching isn't always reliable some connection issues like not being able to join certain players, players not being able to join you or an unusual issue where you're stuck spectating when the game begins may require manual configuration of your network to resolve.<br />
* Ensure <code>rfg.exe</code> isn't blocked by the Windows Firewall for both inbound and outbound connections. You can make a new rule by searching for <code>Windows Defender Firewall with Advanced Security</code>. See the guide below for more advanced instructions.<br />
* Ensure all the games ports are forwarded in your routers firewall: you will need to setup a Static IP on your computer and forward the following ports in your router: <code>TCP: 80</code>, <code>UDP: 88</code>, <code>TCP/UDP: 443</code>, <code>TCP/UDP: 3074</code>, <code>UDP: 3478</code>, <code>UDP: 4379-4380</code>, <code>TCP/UDP: 23022</code>, <code>TCP/UDP: 38888</code>, <code>TCP/UDP 27000-27100</code> & <code>TCP/UDP: 61111</code>. Consult your routers manual on how to do this and see the guide below for detailed instructions on setting up a Static IP.<br />
* You can also setup DMZ for your Static IP but this is less secure. Consult your routers manual on how to do this.<br />
* It's possible your ISP is blocking ports, you can try using their app if they provide one or calling them and asking them to unblock all ports.<br />
* It's possible issues may be caused by a bad router/modem.<br />
* [https://www.howtogeek.com/19249/how-to-assign-a-static-ip-address-in-xp-vista-or-windows-7/ How to Assign a Static IP Address in Windows 10 or 11]<br />
* [https://www.howtogeek.com/112564/how-to-create-advanced-firewall-rules-in-the-windows-firewall/ How to Create Advanced Firewall Rules in the Windows Firewall]<br />
<br />
=== Configs & Save Data Corruption ===<br />
<br />
* It's unknown if this is required but it might be worth a try if you've followed all previous troubleshooting steps and you're still having issues with your game.<br />
* Delete <code>config.ini</code> in <code>%APPDATA%\kaiko\rfg\</code>. This will reset all your settings to default and you will have to reconfigure them the next time you start your game.<br />
* Steam save: <code><Steam-folder>\userdata\<user-id>\667720\remote\</code> or <code><Steam-folder>\userdata\<user-id>\667720\remote\autocloud\save</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* GOG save: <code>%LOCALAPPDATA%\GOG.com\Galaxy\Applications\51153410217180642\Storage\Shared\Files\autocloud\save\</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* Note: It's possible to transfer the Steam save to GOG or vice versa so you can try that also.<br />
<br />
=== Improving Game Stability ===<br />
<br />
# Right click <code>rfg.exe</code> in your game folder.<br />
# Select <code>Properties</code> in the context menu.<br />
# Select the <code>Compatibility</code> tab.<br />
# Tick <code>Disable fullscreen optimizations</code>.<br />
# Click <code>Change high DPI settings</code>.<br />
# Tick <code>Override high DPI scaling Behavior. Scaling performed by: Application</code>.<br />
# Click ok to both windows.<br />
# If on Windows 11 follow the below additional steps.<br />
# Open the <code>Settings</code> app.<br />
# Navigate to System > Display > Graphics > Add an app > Desktop app > Find <code>rfg.exe</code>.<br />
# Once it's added, search for rfg and click <code>Options</code>.<br />
# Tick <code>Don't use optimizations for windowed games</code>.<br />
# Make sure you select exclusive fullscreen inside the games option menu.<br />
[[File:GameStabilityFix.jpeg|frameless|512px]]<br />
<br />
=== Microstuttering Fix ===<br />
<br />
* Disable '''VSYNC''' in the games option menu.<br />
* Force '''VSYNC''' in your graphics card control panel. <br />
* Cap the framerate to your refresh rate in your graphics card control panel.<br />
* Make sure you select exclusive fullscreen inside the games option menu.<br />
<br />
== Terraform Patch Info ==<br />
<br />
* Changelog: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/changelog.txt<br />
* Known Issues: https://github.com/users/CamoRF/projects/3/views/1<br />
* Github: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch<br />
* This patch is an alpha version so you may encounter bugs, please ping Camo in the rfg-modding channel to report any issues.<br />
<br />
== Recommended Competitive Game Settings ==<br />
<br />
* Note: settings are always personal preference but this should serve as a decent starting guide if you want to play more competitively.<br />
* The default keybindings for RF:G are unusual compared to other shooters, most members in the community recommend the following settings:<br />
* All options are found under <code>Main Menu</code> --> <code>Options</code><br />
<br />
* Controls & Keybindings<br />
* Zoom: Right Click<br />
* Melee Attack: F<br />
* Melee Attack 2: Side Mouse Button if your mouse has one<br />
* Shoulder Switch: Side Mouse Button if your mouse has one<br />
* Zoom: Hold<br />
* Crouch: Toggle<br />
<br />
* Audio Options (These will allow you to hear enemy movement more clearly)<br />
* Ambience: 50%<br />
* Music: 0%<br />
* Voice: 50%<br />
* SFX: 100%<br />
<br />
* Graphics Options<br />
* FOV: 85<br />
* Depth of Field: Disabled<br />
* Motion Blur: Disabled<br />
<br />
* Game Options<br />
* Camera Shake: Disabled<br />
<br />
== Run game ==<br />
<br />
All maps are included in the Terraform Patch and you don't need to install anything else. Join the [https://discord.gg/factionfiles FactionFiles Discord] and subscribe to RF:G Game Night event!</div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Game_Night_News&diff=8947RF:G Game Night News2023-06-10T02:48:30Z<p>Camo: /* Improving Game Stability */</p>
<hr />
<div>{{Under construction}}<br />
<br />
== News ==<br />
<br />
* Terraform Patch v1.07.5 was recently released on the 8th of June, 2023. Please update before game night!<br />
* SyncFaction v9 was recently released on the 14th of March, 2023. Please update before game night!<br />
<br />
== Multiplayer Server Status ==<br />
<br />
* Steam version: Fix already included in latest update from Steam.<br />
* GOG version: You will need to manually replace <code>sw_api.dll</code> in the <code>Red Faction Guerrilla Re-Mars-tered</code> folder with the one from here: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/debug/mp_fix/gog/sw_api.dll<br />
<br />
== Installing Terraform Patch ==<br />
<br />
# Download https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
# Open SyncFaction.<br />
# The first time you run it SyncFaction will take some time verifying your game files are vanilla, if you encounter any errors please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game in Steam. You can quickly find your game folder by right clicking RF:G in your Steam library, selecting properties, clicking Local files and finally Browse. Verify integrity of game files is also found here.<br />
# After SyncFaction is done verifying you will see a button at the bottom middle <code>Update to latest Community Patch</code>, click it & SyncFaction will automatically download and install the patch; you will see the progress tracked in the log.<br />
# When it has successfully installed the patch you will see this wiki page instead of the log along with <code>Run Game</code>, <code>Apply</code> & <code>Refresh</code> buttons, you don't need to do anything else and can close SyncFaction now.<br />
<br />
== Updating Terraform Patch ==<br />
<br />
* If you've played game nights before, get latest SF version and let it do the update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* No need to waste time verifying game with Steam!<br />
<br />
== Troubleshooting ==<br />
<br />
* Make sure you're on the latest SF version and update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* If you suspect your game is corrupted, please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game.<br />
* Sometimes after installing the required .NET version you will need to restart your computer for SF to work.<br />
* '''DON'T''' install any mods or maps on top of the patch or you'll corrupt your game!<br />
* If you have both the Steam & GOG versions installed, lots of drives or SF is having issues finding your game install try putting <code>SyncFaction.exe</code> with <code>rfg.exe</code> in the respective game versions folder.<br />
* If your anti virus detects <code>SyncFaction.exe</code> as malware you can be assured it's a false positive, it's open source on github and developed by a trusted member of the community. You can safely make an exception in your anti virus software.<br />
* If SyncFaction has trouble downloading the patch and shows an error starting with <code>System.Net.Http.HttpRequestException</code> it's probably being blocked by your firewall.<br />
* If your game crashes on startup it's possible you incorrectly replaced <code>sw_api.dll</code> for the Steam version when that is only needed for the GOG version, try restoring it to the Steam version: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/debug/mp_fix/steam/sw_api.dll<br />
* Nuclear option if other troubleshooting steps above fail: delete the entire <code>data</code> folder and verify game in Steam. If using GOG completely uninstall the game and install from scratch and then use the latest SF version to re-install the Terraform Patch.<br />
* If you're unable to move your character, pause the game and then unpause.<br />
* This app release is not tested thoroughly so please be patient & report any bugs to rast1234.<br />
<br />
=== Saving Space ===<br />
<br />
* After you've updated to the current latest version of the patch it's safe to delete the <code>\data\.syncfaction\mod_xxx</code> folders.<br />
* This is because previous patch versions are cached there and not needed since last update is not incremental.<br />
<br />
=== Confirming Patch Installed Correctly === <br />
<br />
* On the first loading screen before the main menu you should see <code>Terraform Patch v1.075 ALPHA</code> at the bottom right. Example: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/misc.vpp_pc/E_TEXTURE_CHANGES/SOURCE/ui_loading_init.png?raw=true<br />
* When creating a custom match the default options should have fleetfoot selected as the starting backpack.<br />
* You should see DLC Wrecking Crew & custom maps when going through map selection such as Storage, Abandoned, Nordic Bonus, Ruins, Imperial etc.<br />
* You should see DLC Weapons when going through weapons such as the Subverter, Spiker, Misslepod etc.<br />
* You should see new characters in the multiplayer customization screen such as Jenkins, Sam, Voice of Mars etc.<br />
<br />
=== Networking Issues === <br />
<br />
* As the game relies on THQN servers and it seems NAT punching isn't always reliable some connection issues like not being able to join certain players, players not being able to join you or an unusual issue where you're stuck spectating when the game begins may require manual configuration of your network to resolve.<br />
* Ensure <code>rfg.exe</code> isn't blocked by the Windows Firewall for both inbound and outbound connections. You can make a new rule by searching for <code>Windows Defender Firewall with Advanced Security</code>. See the guide below for more advanced instructions.<br />
* Ensure all the games ports are forwarded in your routers firewall: you will need to setup a Static IP on your computer and forward the following ports in your router: <code>TCP: 80</code>, <code>UDP: 88</code>, <code>TCP/UDP: 443</code>, <code>TCP/UDP: 3074</code>, <code>UDP: 3478</code>, <code>UDP: 4379-4380</code>, <code>TCP/UDP: 23022</code>, <code>TCP/UDP: 38888</code>, <code>TCP/UDP 27000-27100</code> & <code>TCP/UDP: 61111</code>. Consult your routers manual on how to do this and see the guide below for detailed instructions on setting up a Static IP.<br />
* You can also setup DMZ for your Static IP but this is less secure. Consult your routers manual on how to do this.<br />
* It's possible your ISP is blocking ports, you can try using their app if they provide one or calling them and asking them to unblock all ports.<br />
* It's possible issues may be caused by a bad router/modem.<br />
* [https://www.howtogeek.com/19249/how-to-assign-a-static-ip-address-in-xp-vista-or-windows-7/ How to Assign a Static IP Address in Windows 10 or 11]<br />
* [https://www.howtogeek.com/112564/how-to-create-advanced-firewall-rules-in-the-windows-firewall/ How to Create Advanced Firewall Rules in the Windows Firewall]<br />
<br />
=== Configs & Save Data Corruption ===<br />
<br />
* It's unknown if this is required but it might be worth a try if you've followed all previous troubleshooting steps and you're still having issues with your game.<br />
* Delete <code>config.ini</code> in <code>%APPDATA%\kaiko\rfg\</code>. This will reset all your settings to default and you will have to reconfigure them the next time you start your game.<br />
* Steam save: <code><Steam-folder>\userdata\<user-id>\667720\remote\</code> or <code><Steam-folder>\userdata\<user-id>\667720\remote\autocloud\save</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* GOG save: <code>%LOCALAPPDATA%\GOG.com\Galaxy\Applications\51153410217180642\Storage\Shared\Files\autocloud\save\</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* Note: It's possible to transfer the Steam save to GOG or vice versa so you can try that also.<br />
<br />
=== Improving Game Stability ===<br />
<br />
# Right click <code>rfg.exe</code> in your game folder.<br />
# Select <code>Properties</code> in the context menu.<br />
# Select the <code>Compatibility</code> tab.<br />
# Tick <code>Disable fullscreen optimizations</code>.<br />
# Click <code>Change high DPI settings</code>.<br />
# Tick <code>Override high DPI scaling Behavior. Scaling performed by: Application</code>.<br />
# Click ok to both windows.<br />
# If on Windows 11 follow the below additional steps.<br />
# Open the <code>Settings</code> app.<br />
# Navigate to System > Display > Graphics > Add an app > Desktop app > Find <code>rfg.exe</code>.<br />
# Once it's added, search for rfg and click <code>Options</code>.<br />
# Tick <code>Don't use optimizations for windowed games</code>.<br />
# Make sure you select exclusive fullscreen inside the games option menu.<br />
[[File:GameStabilityFix.jpeg|frameless|512px]]<br />
<br />
=== Microstuttering Fix ===<br />
<br />
* Disable VSYNC in the games option menu.<br />
* Force VSYNC in your graphics cards control panel. <br />
* Cap the framerate to your refresh rate in your graphics cards control panel.<br />
* Make sure you select exclusive fullscreen inside the games option menu.<br />
<br />
== Terraform Patch Info ==<br />
<br />
* Changelog: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/changelog.txt<br />
* Known Issues: https://github.com/users/CamoRF/projects/3/views/1<br />
* Github: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch<br />
* This patch is an alpha version so you may encounter bugs, please ping Camo in the rfg-modding channel to report any issues.<br />
<br />
== Recommended Competitive Game Settings ==<br />
<br />
* Note: settings are always personal preference but this should serve as a decent starting guide if you want to play more competitively.<br />
* The default keybindings for RF:G are unusual compared to other shooters, most members in the community recommend the following settings:<br />
* All options are found under <code>Main Menu</code> --> <code>Options</code><br />
<br />
* Controls & Keybindings<br />
* Zoom: Right Click<br />
* Melee Attack: F<br />
* Melee Attack 2: Side Mouse Button if your mouse has one<br />
* Shoulder Switch: Side Mouse Button if your mouse has one<br />
* Zoom: Hold<br />
* Crouch: Toggle<br />
<br />
* Audio Options (These will allow you to hear enemy movement more clearly)<br />
* Ambience: 50%<br />
* Music: 0%<br />
* Voice: 50%<br />
* SFX: 100%<br />
<br />
* Graphics Options<br />
* FOV: 85<br />
* Depth of Field: Disabled<br />
* Motion Blur: Disabled<br />
<br />
* Game Options<br />
* Camera Shake: Disabled<br />
<br />
== Run game ==<br />
<br />
All maps are included in the Terraform Patch and you don't need to install anything else. Join the [https://discord.gg/factionfiles FactionFiles Discord] and subscribe to RF:G Game Night event!</div>Camohttps://www.redfactionwiki.com/w/index.php?title=File:GameStabilityFix.jpeg&diff=8946File:GameStabilityFix.jpeg2023-06-10T02:46:26Z<p>Camo: </p>
<hr />
<div></div>Camohttps://www.redfactionwiki.com/w/index.php?title=RF:G_Game_Night_News&diff=8945RF:G Game Night News2023-06-10T02:29:10Z<p>Camo: /* Troubleshooting */</p>
<hr />
<div>{{Under construction}}<br />
<br />
== News ==<br />
<br />
* Terraform Patch v1.07.5 was recently released on the 8th of June, 2023. Please update before game night!<br />
* SyncFaction v9 was recently released on the 14th of March, 2023. Please update before game night!<br />
<br />
== Multiplayer Server Status ==<br />
<br />
* Steam version: Fix already included in latest update from Steam.<br />
* GOG version: You will need to manually replace <code>sw_api.dll</code> in the <code>Red Faction Guerrilla Re-Mars-tered</code> folder with the one from here: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/debug/mp_fix/gog/sw_api.dll<br />
<br />
== Installing Terraform Patch ==<br />
<br />
# Download https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
# Open SyncFaction.<br />
# The first time you run it SyncFaction will take some time verifying your game files are vanilla, if you encounter any errors please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game in Steam. You can quickly find your game folder by right clicking RF:G in your Steam library, selecting properties, clicking Local files and finally Browse. Verify integrity of game files is also found here.<br />
# After SyncFaction is done verifying you will see a button at the bottom middle <code>Update to latest Community Patch</code>, click it & SyncFaction will automatically download and install the patch; you will see the progress tracked in the log.<br />
# When it has successfully installed the patch you will see this wiki page instead of the log along with <code>Run Game</code>, <code>Apply</code> & <code>Refresh</code> buttons, you don't need to do anything else and can close SyncFaction now.<br />
<br />
== Updating Terraform Patch ==<br />
<br />
* If you've played game nights before, get latest SF version and let it do the update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* No need to waste time verifying game with Steam!<br />
<br />
== Troubleshooting ==<br />
<br />
* Make sure you're on the latest SF version and update: https://github.com/Rast1234/SyncFaction/releases/download/v9/SyncFaction.exe<br />
* If you suspect your game is corrupted, please delete the <code>.syncfaction</code> folder in <code>data</code> and verify your game.<br />
* Sometimes after installing the required .NET version you will need to restart your computer for SF to work.<br />
* '''DON'T''' install any mods or maps on top of the patch or you'll corrupt your game!<br />
* If you have both the Steam & GOG versions installed, lots of drives or SF is having issues finding your game install try putting <code>SyncFaction.exe</code> with <code>rfg.exe</code> in the respective game versions folder.<br />
* If your anti virus detects <code>SyncFaction.exe</code> as malware you can be assured it's a false positive, it's open source on github and developed by a trusted member of the community. You can safely make an exception in your anti virus software.<br />
* If SyncFaction has trouble downloading the patch and shows an error starting with <code>System.Net.Http.HttpRequestException</code> it's probably being blocked by your firewall.<br />
* If your game crashes on startup it's possible you incorrectly replaced <code>sw_api.dll</code> for the Steam version when that is only needed for the GOG version, try restoring it to the Steam version: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/raw/main/debug/mp_fix/steam/sw_api.dll<br />
* Nuclear option if other troubleshooting steps above fail: delete the entire <code>data</code> folder and verify game in Steam. If using GOG completely uninstall the game and install from scratch and then use the latest SF version to re-install the Terraform Patch.<br />
* If you're unable to move your character, pause the game and then unpause.<br />
* This app release is not tested thoroughly so please be patient & report any bugs to rast1234.<br />
<br />
=== Saving Space ===<br />
<br />
* After you've updated to the current latest version of the patch it's safe to delete the <code>\data\.syncfaction\mod_xxx</code> folders.<br />
* This is because previous patch versions are cached there and not needed since last update is not incremental.<br />
<br />
=== Confirming Patch Installed Correctly === <br />
<br />
* On the first loading screen before the main menu you should see <code>Terraform Patch v1.075 ALPHA</code> at the bottom right. Example: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/misc.vpp_pc/E_TEXTURE_CHANGES/SOURCE/ui_loading_init.png?raw=true<br />
* When creating a custom match the default options should have fleetfoot selected as the starting backpack.<br />
* You should see DLC Wrecking Crew & custom maps when going through map selection such as Storage, Abandoned, Nordic Bonus, Ruins, Imperial etc.<br />
* You should see DLC Weapons when going through weapons such as the Subverter, Spiker, Misslepod etc.<br />
* You should see new characters in the multiplayer customization screen such as Jenkins, Sam, Voice of Mars etc.<br />
<br />
=== Networking Issues === <br />
<br />
* As the game relies on THQN servers and it seems NAT punching isn't always reliable some connection issues like not being able to join certain players, players not being able to join you or an unusual issue where you're stuck spectating when the game begins may require manual configuration of your network to resolve.<br />
* Ensure <code>rfg.exe</code> isn't blocked by the Windows Firewall for both inbound and outbound connections. You can make a new rule by searching for <code>Windows Defender Firewall with Advanced Security</code>. See the guide below for more advanced instructions.<br />
* Ensure all the games ports are forwarded in your routers firewall: you will need to setup a Static IP on your computer and forward the following ports in your router: <code>TCP: 80</code>, <code>UDP: 88</code>, <code>TCP/UDP: 443</code>, <code>TCP/UDP: 3074</code>, <code>UDP: 3478</code>, <code>UDP: 4379-4380</code>, <code>TCP/UDP: 23022</code>, <code>TCP/UDP: 38888</code>, <code>TCP/UDP 27000-27100</code> & <code>TCP/UDP: 61111</code>. Consult your routers manual on how to do this and see the guide below for detailed instructions on setting up a Static IP.<br />
* You can also setup DMZ for your Static IP but this is less secure. Consult your routers manual on how to do this.<br />
* It's possible your ISP is blocking ports, you can try using their app if they provide one or calling them and asking them to unblock all ports.<br />
* It's possible issues may be caused by a bad router/modem.<br />
* [https://www.howtogeek.com/19249/how-to-assign-a-static-ip-address-in-xp-vista-or-windows-7/ How to Assign a Static IP Address in Windows 10 or 11]<br />
* [https://www.howtogeek.com/112564/how-to-create-advanced-firewall-rules-in-the-windows-firewall/ How to Create Advanced Firewall Rules in the Windows Firewall]<br />
<br />
=== Configs & Save Data Corruption ===<br />
<br />
* It's unknown if this is required but it might be worth a try if you've followed all previous troubleshooting steps and you're still having issues with your game.<br />
* Delete <code>config.ini</code> in <code>%APPDATA%\kaiko\rfg\</code>. This will reset all your settings to default and you will have to reconfigure them the next time you start your game.<br />
* Steam save: <code><Steam-folder>\userdata\<user-id>\667720\remote\</code> or <code><Steam-folder>\userdata\<user-id>\667720\remote\autocloud\save</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* GOG save: <code>%LOCALAPPDATA%\GOG.com\Galaxy\Applications\51153410217180642\Storage\Shared\Files\autocloud\save\</code>. Backup <code>keen_savegame_0_0.sav</code> and delete it. Warning: this will reset both your singleplayer and multiplayer progress.<br />
* Note: It's possible to transfer the Steam save to GOG or vice versa so you can try that also.<br />
<br />
=== Improving Game Stability ===<br />
<br />
# Right click <code>rfg.exe</code> in your game folder.<br />
# Select <code>Properties</code> in the context menu.<br />
# Select the <code>Compatibility</code> tab.<br />
# Tick <code>Disable fullscreen optimizations</code>.<br />
# Click <code>Change high DPI settings</code>.<br />
# Tick <code>Override high DPI scaling Behavior. Scaling performed by: Application</code>.<br />
# Click ok to both windows.<br />
# If on Windows 11 follow the below additional steps.<br />
# Open the <code>Settings</code> app.<br />
# Navigate to System > Display > Graphics > Add an app > Desktop app > Find <code>rfg.exe</code>.<br />
# Once it's added, search for rfg and click <code>Options</code>.<br />
# Tick <code>Don't use optimizations for windowed games</code>.<br />
# Make sure you select exclusive fullscreen inside the games option menu.<br />
<br />
=== Microstuttering Fix ===<br />
<br />
* Disable VSYNC in the games option menu.<br />
* Force VSYNC in your graphics cards control panel. <br />
* Cap the framerate to your refresh rate in your graphics cards control panel.<br />
* Make sure you select exclusive fullscreen inside the games option menu.<br />
<br />
== Terraform Patch Info ==<br />
<br />
* Changelog: https://raw.githubusercontent.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch/main/changelog.txt<br />
* Known Issues: https://github.com/users/CamoRF/projects/3/views/1<br />
* Github: https://github.com/CamoRF/Red-Faction-Guerrilla-Terraform-Patch<br />
* This patch is an alpha version so you may encounter bugs, please ping Camo in the rfg-modding channel to report any issues.<br />
<br />
== Recommended Competitive Game Settings ==<br />
<br />
* Note: settings are always personal preference but this should serve as a decent starting guide if you want to play more competitively.<br />
* The default keybindings for RF:G are unusual compared to other shooters, most members in the community recommend the following settings:<br />
* All options are found under <code>Main Menu</code> --> <code>Options</code><br />
<br />
* Controls & Keybindings<br />
* Zoom: Right Click<br />
* Melee Attack: F<br />
* Melee Attack 2: Side Mouse Button if your mouse has one<br />
* Shoulder Switch: Side Mouse Button if your mouse has one<br />
* Zoom: Hold<br />
* Crouch: Toggle<br />
<br />
* Audio Options (These will allow you to hear enemy movement more clearly)<br />
* Ambience: 50%<br />
* Music: 0%<br />
* Voice: 50%<br />
* SFX: 100%<br />
<br />
* Graphics Options<br />
* FOV: 85<br />
* Depth of Field: Disabled<br />
* Motion Blur: Disabled<br />
<br />
* Game Options<br />
* Camera Shake: Disabled<br />
<br />
== Run game ==<br />
<br />
All maps are included in the Terraform Patch and you don't need to install anything else. Join the [https://discord.gg/factionfiles FactionFiles Discord] and subscribe to RF:G Game Night event!</div>Camo