Ara: History Untold Wiki - User contributions [en]

Modding for fun and profit

2024-10-10T22:27:46Z

Frogboy: Created page with " = Modding Guide for ''Ara: History Untold'' = == Introduction == ''Ara: History Untold'' is a new game, and modding possibilities are still evolving as the game stabilizes and expands. What can be modded today will grow in the future. This guide provides the basic structure for modding the game, along with examples to help modders get started. == Chapter 0: ZNO, ZSchema, & ZData == ''Ara: History Untold'' uses a unique data structure called ZNO, integrated into the Ni..."

= Modding Guide for ''Ara: History Untold'' =

== Introduction ==
''Ara: History Untold'' is a new game, and modding possibilities are still evolving as the game stabilizes and expands. What can be modded today will grow in the future. This guide provides the basic structure for modding the game, along with examples to help modders get started.

== Chapter 0: ZNO, ZSchema, & ZData ==
''Ara: History Untold'' uses a unique data structure called ZNO, integrated into the Nitrous Engine that powers the game. Key components for modding include:

* '''ZSchema''' - Defines the fields and formatting rules for a data type.
* '''ZData''' - Used to implement new elements and content. Modders will work with .ZData files, similar to working with .JSON files.

=== Tools Required ===
Any text editor will work for editing .ZData files. Popular editors include Microsoft Visual Studio Code and Notepad++.

== Chapter 1: Data Modding ==

=== 1.1 Adding New Content ===
To add new content like items, resources, or units, create new .ZData files using existing .ZSchema templates.

'''Example: Adding a New Item (Pet Frog)'''

# Create a folder named '''PetFrogsMod'''.
# In your text editor, create a new .ZData file (e.g., '''PetFrogItems.zdata''').
# Reference the schema:

<syntaxhighlight lang="json"> schema Items; export ItemTemplate itm_petFrog = {
.Name = "Pet Frog",
.Description = "A happy, jumping boy that brings everyone joy.",
.FlavorText = "He jumps, he brings joy",
.RecipeID = "rcp_AIAssistants",
.AtlasID = "AIAssistants",
.uiRarity = RulesTypes.eRarity.Common,
.uiType = RulesTypes.ItemType.Luxury,
.uiHarvestType = RulesTypes.HarvestType.NoneOfTheAbove,
.Flags = (Flags.HasActive | Flags.Resource | Flags.Consumable),
.ActivateBuffs = {"buf_Item_Happiness_15", "", "", "", "", "", "", ""},
.uiGiveConsumeItemsForNumTurns = 300u,
.ActivateBuffsForImprovements = {"buf_Item_Happiness_15", "", "", "", "", "", "", ""}
}; </syntaxhighlight>

=== 1.2 Editing Existing Content ===
To modify existing data, create a new file that references the schema, and update the necessary elements.

'''Example: Updating Resources'''

# Create a new file (e.g., '''PetFrogResources.zdata''').
# Reference the existing schema and modify as needed:

<syntaxhighlight lang="json"> schema NaturalResources; export NaturalResourceTemplate nrc_Dyes = {
.Name = "TXT_ITM_NATURAL_DYES",
.Description = "TXT_ITM_DESC_NATURAL_DYES",
.HarvestOptions = {
{
.Item = "itm_Dyes",
.ProductionRequired = 150u,
.HarvestCount = 1u
},
{
.Item = "itm_petFrog",
.ProductionRequired = 10u,
.HarvestCount = 1u
}
}
}; </syntaxhighlight>

=== 1.3 ZData Cheat Sheet ===
An overview of the various schema files and what they control:

* '''Buffs.zschema''' - Defines buffs used by items and improvements.
* '''Governments.zschema''' - Controls government types and their impact on gameplay.
* '''Items.zschema''' - Defines items, from resources to amenities.
* '''Technologies.zschema''' - Defines technologies and research in the game.

== Chapter 2: Setting Up the Mod ==

=== 2.1 GameCoreData Setup ===
To properly load a mod, create a file called '''GameCoreData.zdata''' in your mod folder, and include references to the files in your mod.

<syntaxhighlight lang="json"> schema ZNODataLibrary; export Library Root = {
.Groups = {
.ItemTemplates = {
.FromFiles = { "PetFrogItems.zdata" }
},
.NaturalResourceTemplates = {
.FromFiles = { "NaturalResources0.zdata" }
}
}
}; </syntaxhighlight>

=== 2.2 Mod Folder Placement ===
Move the mod folder into the '''Mods''' folder at '''%LOCALAPPDATA%\Ara History Untold'''. If the Mods folder does not exist, create one.

=== 2.3 Updating Settings & Loading the Mod ===
Navigate to the '''Settings''' file under the '''Local App Data''' directory. Enable the mod by updating the following:

<syntaxhighlight> EnabledMods=1 GameCoreMod0Source=PetFrogsMod </syntaxhighlight>

== Chapter 3: Modding Technologies ==
Technologies in ''Ara'' are controlled by a single file, '''Technologies0.zdata'''.

'''Example: Increasing Research Costs'''

# Find the research cost entry for a technology (e.g., Archery) and increase the cost:

<syntaxhighlight lang="json"> export TechnologyTemplate tch_Archery = {
.Name = "TXT_TCH_ARCHERY",
.uiResearchCost = 100
}; </syntaxhighlight>

== Conclusion ==
Your mod should now be ready for testing! Place the files as directed, launch the game, and enjoy your custom modifications.

Modding

2024-10-10T22:27:17Z

Frogboy:

[[File:SettingsFile.png|thumb|Example of the Settings_v121.txt file]]

= Ara Modding Setup Guide =
This document will show you how to get started with modding Ara: History Untold.

In this initial version of mod support, we provide a copy of our source game data files in the Ara installation directory. You can install these source files as a mod in your Documents folder and enable mod loading in the Ara settings. We will walk through each step below.

== QuickStart ==
# Find the game data source mod zip in the Ara installation folder at `assets\SourceMods\GameDataSource_v1.0.4.zip`.
# Extract it into `Documents\My Games\Ara History Untold\Mods\` so that the file `GameCoreData.zdata` is in the `Documents\My Games\Ara History Untold\Mods\GameDataSource_v1.0.4` folder. Create the "Mods" folder first if it does not exist.
# Navigate to `%LOCALAPPDATA%\Ara History Untold` with File Explorer (open File Explorer with WinKey + E) and open the latest settings text file (e.g. `Settings_V122.txt`).
# Set the line `EnableMods=0` to `EnableMods=1`. If this line is missing, add it to the end of the file.
# Set the line `GameCoreMod0Source=` to `GameCoreMod0Source=GameDataSource_v1.0.4`. If this line is missing, add it to the end of the file.
# Start Ara – it will load your modified source files from your Documents folder into the game. Multiplayer and achievements will be disabled while mods are enabled.
== Step 1: Find the game data source zip file ==
If you own the game through Steam, you can get to your installation files quickly through the Steam Library tab. For Windows Store installations (e.g. from Game Pass), you can find the top-level Ara folder by starting at `%LOCALAPPDATA%\Microsoft\WindowsApps`.

=== Find Ara in your Steam library ===
Right-click the game in the library list, select Manage -> Browse Local Files.

You should have a File Explorer window (WinKey + E) open with the following folder:

Open the `assets\SourceMods` folder and locate the `GameDataSource_v1.0.4.zip` file. Right-click on the `GameDataSource_v1.0.4.zip` file and select the 'Copy' menu item.

== Step 2: Unzip into Mods folder ==
Use File Explorer to open your Documents folder and navigate to `My Games` and then, in a separate window, the `Ara History Untold` folder.

In `Documents\My Games\Ara History Untold`, create a `Mods` folder (if it does not already exist).

Right-click in the Mods folder and select the Paste menu item to make a copy of `GameDataSource_v1.0.4.zip` in the Mods folder. Extract the contents of the .zip file by right-clicking and selecting the 'Extract All' option.

You should end up with a folder `GameDataSource_V1.0.4` in the Mods folder, containing all of the game data files.

== Step 3: Enable modding in Ara settings ==
Open a File Explorer window and navigate to `%LOCALAPPDATA%\Ara History Untold`.

This folder contains a settings file, such as `Settings_v121.txt`. Open the one with the largest version number (the "v121" or similar at the end).

You can open this file using a text editor such as Notepad or Visual Studio Code.

In the file, you should find two lines: `EnableMods=0` and `GameCoreMod0Source=`. If you haven't run the game since the last update, you may need to do so for these to show up. Alternatively, you can also add them to the end of the file manually.

Change these lines to: EnableMods=1 GameCoreMod0Source=GameDataSource_v1.0.4

Save and close the file.

== Step 4: Run Ara ==
If you launch Ara again, you should now start with mods enabled and the source files from `GameDataSource_v1.0.4` loaded as your active game rules.

If there are errors loading the mod files, you will receive a data error popup, and the game will proceed loading only its built-in, un-modded data.

(Note: Pressing 'Ctrl-C' will copy all the text from the error popup)

`%LOCALAPPDATA%\Ara History Untold\logs\Ara.log` contains a diagnostic log of the mods loaded (if any) and errors found.

While you are running with mods enabled, achievements and multiplayer will be disabled.

== Guides ==

* [[Modding for fun and profit]]

Modding

2024-10-10T22:26:09Z

Frogboy:

Modding

2024-10-10T22:13:31Z

Frogboy:

Modding

2024-10-10T22:13:20Z

Frogboy:

[[File:SettingsFile.png|thumb|Example of the Settings_v121.txt file]]

= Ara Modding Setup Guide =
This document will show you how to get started with modding Ara: History Untold.

In this initial version of mod support, we provide a copy of our source game data files in the Ara installation directory. You can install these source files as a mod in your Documents folder and enable mod loading in the Ara settings. We will walk through each step below.

== QuickStart ==
# Find the game data source mod zip in the Ara installation folder at `assets\SourceMods\GameDataSource_v1.0.4.zip`.
# Extract it into `Documents\My Games\Ara History Untold\Mods\` so that the file `GameCoreData.zdata` is in the `Documents\My Games\Ara History Untold\Mods\GameDataSource_v1.0.4` folder. Create the "Mods" folder first if it does not exist.
# Navigate to `%LOCALAPPDATA%\Ara History Untold` with File Explorer (open File Explorer with WinKey + E) and open the latest settings text file (e.g. `Settings_V122.txt`).
# Set the line `EnableMods=0` to `EnableMods=1`. If this line is missing, add it to the end of the file.
# Set the line `GameCoreMod0Source=` to `GameCoreMod0Source=GameDataSource_v1.0.4`. If this line is missing, add it to the end of the file.
# Start Ara – it will load your modified source files from your Documents folder into the game. Multiplayer and achievements will be disabled while mods are enabled.

== Step 1: Find the game data source zip file ==
If you own the game through Steam, you can get to your installation files quickly through the Steam Library tab. For Windows Store installations (e.g. from Game Pass), you can find the top-level Ara folder by starting at `%LOCALAPPDATA%\Microsoft\WindowsApps`.

=== Find Ara in your Steam library ===
Right-click the game in the library list, select Manage -> Browse Local Files.

You should have a File Explorer window (WinKey + E) open with the following folder:

Open the `assets\SourceMods` folder and locate the `GameDataSource_v1.0.4.zip` file. Right-click on the `GameDataSource_v1.0.4.zip` file and select the 'Copy' menu item.

== Step 2: Unzip into Mods folder ==
Use File Explorer to open your Documents folder and navigate to `My Games` and then, in a separate window, the `Ara History Untold` folder.

In `Documents\My Games\Ara History Untold`, create a `Mods` folder (if it does not already exist).

Right-click in the Mods folder and select the Paste menu item to make a copy of `GameDataSource_v1.0.4.zip` in the Mods folder. Extract the contents of the .zip file by right-clicking and selecting the 'Extract All' option.

You should end up with a folder `GameDataSource_V1.0.4` in the Mods folder, containing all of the game data files.

== Step 3: Enable modding in Ara settings ==
Open a File Explorer window and navigate to `%LOCALAPPDATA%\Ara History Untold`.

This folder contains a settings file, such as `Settings_v121.txt`. Open the one with the largest version number (the "v121" or similar at the end).

You can open this file using a text editor such as Notepad or Visual Studio Code.

In the file, you should find two lines: `EnableMods=0` and `GameCoreMod0Source=`. If you haven't run the game since the last update, you may need to do so for these to show up. Alternatively, you can also add them to the end of the file manually.

Change these lines to: EnableMods=1 GameCoreMod0Source=GameDataSource_v1.0.4

Save and close the file.

== Step 4: Run Ara ==
If you launch Ara again, you should now start with mods enabled and the source files from `GameDataSource_v1.0.4` loaded as your active game rules.

If there are errors loading the mod files, you will receive a data error popup, and the game will proceed loading only its built-in, un-modded data.

(Note: Pressing 'Ctrl-C' will copy all the text from the error popup)

`%LOCALAPPDATA%\Ara History Untold\logs\Ara.log` contains a diagnostic log of the mods loaded (if any) and errors found.

While you are running with mods enabled, achievements and multiplayer will be disabled.

Modding

2024-10-10T22:12:13Z

Frogboy: Update 1

[[File:SettingsFile.png|thumb|Example of the Settings_v121.txt file]]

= Ara Modding Setup Guide =
This document will show you how to get started with modding Ara: History Untold.

In this initial version of mod support, we provide a copy of our source game data files in the Ara installation directory. You can install these source files as a mod in your Documents folder and enable mod loading in the Ara settings. We will walk through each step below.

== Step 1: Find the game data source zip file ==
If you own the game through Steam, you can get to your installation files quickly through the Steam Library tab. For Windows Store installations (e.g. from Game Pass), you can find the top-level Ara folder by starting at `%LOCALAPPDATA%\Microsoft\WindowsApps`.

=== Find Ara in your Steam library ===
Right-click the game in the library list, select Manage -> Browse Local Files.

You should have a File Explorer window (WinKey + E) open with the following folder:

Open the `assets\SourceMods` folder and locate the `GameDataSource_v1.0.4.zip` file. Right-click on the `GameDataSource_v1.0.4.zip` file and select the 'Copy' menu item.

== Step 2: Unzip into Mods folder ==
Use File Explorer to open your Documents folder and navigate to `My Games` and then, in a separate window, the `Ara History Untold` folder.

In `Documents\My Games\Ara History Untold`, create a `Mods` folder (if it does not already exist).

Right-click in the Mods folder and select the Paste menu item to make a copy of `GameDataSource_v1.0.4.zip` in the Mods folder. Extract the contents of the .zip file by right-clicking and selecting the 'Extract All' option.

You should end up with a folder `GameDataSource_V1.0.4` in the Mods folder, containing all of the game data files.

== Step 3: Enable modding in Ara settings ==
Open a File Explorer window and navigate to `%LOCALAPPDATA%\Ara History Untold`.

This folder contains a settings file, such as `Settings_v121.txt`. Open the one with the largest version number (the "v121" or similar at the end).

You can open this file using a text editor such as Notepad or Visual Studio Code.

In the file, you should find two lines: `EnableMods=0` and `GameCoreMod0Source=`. If you haven't run the game since the last update, you may need to do so for these to show up. Alternatively, you can also add them to the end of the file manually.

Change these lines to: EnableMods=1 GameCoreMod0Source=GameDataSource_v1.0.4

Save and close the file.

== Step 4: Run Ara ==
If you launch Ara again, you should now start with mods enabled and the source files from `GameDataSource_v1.0.4` loaded as your active game rules.

If there are errors loading the mod files, you will receive a data error popup, and the game will proceed loading only its built-in, un-modded data.

(Note: Pressing 'Ctrl-C' will copy all the text from the error popup)

`%LOCALAPPDATA%\Ara History Untold\logs\Ara.log` contains a diagnostic log of the mods loaded (if any) and errors found.

While you are running with mods enabled, achievements and multiplayer will be disabled.