Modders Guide

Ashes is a large scale RTS where you wage war with huge armies over massive areas. You fight for regions to get resources, you fight to protect the areas you control and you fight to destroy your enemy’s armies and infrastructure. In the end you win by destroying their Nexas or controlling enough of the map to win via victory points.

There is a lot to do in Ashes. But it was also built from the ground up to be mod friendly. Modders have access to the gameplay elements to change and tweak as they desire. This document will introduce some of what is possible, and we will make a map and a mod to take advantage of this.

This is not always going to be a managed and curated editor with limited options. You can mod the game the same way the developers make changes to the game. Editors are nice because they typically keep you from doing “bad” things. But they also keep you from doing incredibly good things. An editor only allows you to do the things the developer set up for you to change. With direct access to the files you can do things the developer never expected. Sometimes that turns out horribly (okay, a lot of the time that turns out horribly), but sometimes it turns out brilliantly. We believe power trumps ease of use.

---

The Map Editor

Creating a new map

To enable the Map Editor add the “-modding” (without the quotes) to the Launch Options for the game (in Steam, right-click the game, go to Properties, click Set Launch Options in the General tab). That will add a Map Editor button to the main menu of the game. From there you can decide if you want to modify an existing map, or create a new one. If you create a new one the menu to the right is presented.

For your first map I’d select a smaller map size. You probably assume that you will run out of space quickly on small maps, you would be wrong. Ashes small maps are what other games would call huge. The large ones are ridiculous and will take a lot of time to design. Practice on some small ones first.

I selected Terran (grassland) terrain and default lighting. As you will see in the demo I change to Frozen terrain later, it’s easy to do so don’t worry too much about your selection here.

The following is the default map that you are given. It starts with two player Nexuses, a Turinium Generator and one other region. But we have lots of things we can add.

A new, blank map

The most useful functions in the above editor are:

• File - This is where you can edit the MapProperties.xml file, go to the folder where the map information is stored or exit the Map Editor. If you want to change the victory point limits for your map then use this option to modify the MapProperties.xml file and regenerate the map.
• Show/Hide Help - This displays some useful information for using the Map Editor. I have it set to display help in the above screenshot.
• Toggle Display Mode - This changes how you are viewing the map. In the above screenshot I’m not looking at modeled terrain. It’s often easier to layout the map in this mode. But you can switch over to realistic terrain if you want to see exactly what your map would look like to the player.
• Enable Symmetry - Enable this if you want your terrain painting to be symmetrical. If it is set you can choose to make is symmetrically mirrored or use a radial symmetry for multiple equal positions.
• Terran/Desert/Frozen - If you would like to switch your world type while building you can do it here.
• Brush Size - When painting terrain or cosmetics this is the brush size you would like to use. Also [ctrl+mousewheel]
• Edit Terrain - Ashes has 5 (7 in Escalation) base terrains:
  • Plain - Normal ground
  • Plateau - Higher ground that the player can still move and build on. Height is an advantage for many units so plateaus generally make for good defensive positions.
  • Hill - Hills connect Plains and Plateaus. Use them to determine where players can access one elevation from the other.
  • Mountain - Mountains are impassable by anything except flying units. Use them to block parts of the map.
  • Basin - Basins are also impassable to anything except for flying units. But units with long enough range can fire across basins.
  • Highlands (Esc) - Like Plateaus, but higher. Connect them to other terrain types with Hills.
  • Lowlands (Esc) - Like Plains, but lower. Connect them to other terrain types with Hills.

 

• Edit Buildings- Use this to place the following on the map:
  • Player Seed- A players starting location.
  • Relay- The heart of a region. Surround it with Metal and Radioactive deposits to decide what that region offers.
  • Turinium Generator- This is a special type of power generator that can provide victory points. Provided maps don’t put resources in Generator regions, but you are modding, so do whatever you like.
  • Metal Deposit- If players control regions with these, they provide Metal for the player.
  • Radioactive Deposit- If players control regions with these, they provide Radioactives for the player.

 

• Edit Cosmetic- To place the cosmetic details on the map, like trees on terran planets. NOTE: Turn off symmetry when editing cosmetic details!
• Edit Effects (Esc) - Place particle effects on the map. This is currently (Jan 2017) experimental.
• Build Quality/Erosion - Increasing these will increase the amount of time and memory required to generate the terrain. I recommend keeping them low until you are ready to make the final version of the map. We generate at terrain quality 3 or 4 for our final maps. Anything higher than 4 will probably crash your machine.
• Terrain Synth - The style of slopes and mountains generated by the erosion simulation. Anything other than 1 and 2 is experimental.
• Rebuild Terrain- This regenerates the map with any changes you have made so you can see how they look.

In this design the teal is plateau, red is mountains, blue is basins, yellow is hills and the green is plains.

The player Nexas’s are in the upper right and the lower left. The point of this map was to create a single channel for the players to battle through. The upper part is biased for the player on the left, giving him a plateau to fire down at enemy units driving by the area below and the reverse for the southern part of the map.

There are three Turinium Generators, one in the center of the map and one on each of the two plateaus overlooking the plains pass. The goal is to make one Turinium Generator easy for each player to grab so they need to battle over the one in the center (since victory points are awarded to the player who holds the majority of generators).

Rebuilding the terrain and toggling to map display mode gives us a look at what the map will look like. I like the pass, the mountains and the basin. But the rest looks a little bare. So I need to add more details to make that area more interesting. I often forget how big the Ashes maps are, so when I toggle to the real map they don’t seem as full as I imagined.

In this update I’ve added more opportunities for the defending player. The overlooking plateaus can only be accessed from the Nexas region so they get to attack in the central channel as well as attacking units forced to come by the plateau wall on their way to the Nexas.

I’ve also switched it over to the Frozen terrain. I think its brutal hostility fits the maps focus better. I put the build quality up to 4 and increased the erosion levels so it looks great. It took a lot more time to generate (btw: don’t attempt to use high build levels on the largest possible maps unless you have a lot of memory) but it looks great.

This map is a lot of fun to play, but may favor aircraft to strongly (since they can bypass all of these defense and attack anywhere. In a later section we will talk about creating scripts where we could do things like disable aircraft so the players are forced to slug it out.

CSV and XML files – The Swarm Mod

---

Most of the data that drives Ashes is stored in CSV and XML files, and there are a lot of them.

You can find these in the in the place the game is installed under the ..\Ashes of the Singularity\Assets\ directories. Modifying files in a games directory isn’t for the faint of heart, so you will want to remember a few things:

1. If you modify any of these files you can always get back to the original by verifying your game cache in Steam (which will revert all your files to the original game files).
2. Conversely, if you verify your cache in steam you will lose any local changes you have made.
3. Game updates may overwrite any changes you have made locally, so make a backup of your changes.
4. We plan to add a modding directory that will overwrite the game files, so you don’t have to modify the game files directly. But at the time that this guide is being written that functionality doesn’t exist. It won’t change what you can do, but it will make the process easier and cleaner.
5. You cannot play multiplayer with modded games (that wouldn’t be fair or fun for the other player). So if you want to play multiplayer you will need to revert your changes. If you have forgotten about some of the changes you can use reverify your files to get them back to default.
   1. Note: Adding new maps and scenarios via mod shouldn't lock you out of multiplayer, as those don't affect the existing game experience.

 

1. You can modify the assets in Ashes but in general you cannot add new ones. This is because the UI wouldn’t show them in the build menus. So if you had a new unit you wanted to build at a factory it wouldn’t be displayed in the units the factory could produce. You could make a new unit to have the player start with, to reward the player with after he completes a trigger (more about those later), etc.

Note: Ashes can’t use a file if it is locked. If you have a file open with Excel and try to start Ashes, the game will crash. Close the file before starting Ashes.

There are a lot of files, with a lot of fields that can be tweaked and changed. For this demo we are going to mess with my favorite file, UnitTemplates.csv.

In this screenshot I’ve opened UnitTemplates.csv with Excel, because it makes it easier for me to work with, but Excel isn’t required. Notepad could be used to modify the file. If you use Excel remember to save it as a csv file.

There are a lot of fields that can be modified. In this screenshot we can see:

• Max HP’s
• Max Energy
• Energy Per Second
• Armor
• Heal Rate
• Max Shields
• Shield Regen Rate
• Radar Radius
• Cost Metal
• Cost Data
• Cost Energy
• Cost Logistics
• Construction Time

Some of these fields aren’t named the same as they are in game. Names change during the course of development, and we didn’t want to go back and change all these definitions to match each time they do. Because of that you may have to experiment a bit to see how things match. For example, PHC_T1_Light is the Brute, and Cost Data is actually the Radioactive cost of the unit. You can checkout the translation tables in ..\Ashes of the Singularity\Assets\UIText\ directory to see how raw assets relate to in game assets.

Using this file alone, and just the things in this screenshot (there are many more fields in Unittemplates.csv) we can dramatically alter the balance and design of the game. Let’s use the above to create a new game variant I call the Swarm Mod.

I love the scale of Ashes, I love large battles. So this mod is going to make even larger battles possible and we are going to get into them fast. To do that I’m going to make the following changes:

I’ve reduce the Metal, Radioactive, Logistics and Construction time costs by 90%. I’ve reduce the Logistics costs of T1 units to 0 (so you can have as many as you want). With these changes factories should produce 10 units in the time it took to produce 1 before. As long as you can keep feeding the (dramatically reduced) resource costs, units should come out of factories in an endless stream, like a tower defense game on steroids.

There are a lot of ways to tweak this concept. I could have kept the Metal and Radioactive costs the same and then the player would be strongly incented to claim and upgrade regions to keep his factories fed. I could have just halved the costs rather than dropping them by 90%. I could have increased the resource gathering rates of upgraded metal and radioactive mines rather than lowering costs to incent players to invest in their regions.

But for this we are going crazy. Everything gets very cheap. Massive armies can be built from the start of the game. Those poor creeps won’t know what hit them. And be prepared to be sieged by thousands of units.

This is 5 minutes into the game. I only have 2 factories putting out an endless stream of Brutes. I make an army out of them and in the time it takes to do that there are a bunch more waiting to be added. So I find that it works just as well to set the rally point of the factory to where I want to attack, so that my river of death flows out to destroy it.

The AI has adapted to the new lower costs and is meeting my endless streams with its own. Unlike me it has opted to go with some cheaply produced dreadnoughts. The game lasts for 45 minutes, and there is a battle waging between my endless armies and his at this chokepoint for nearly all of it. It isn’t until I win more minor battles on some of outskirt regions (to take the resources which even at 90% off still become critical) and I send a strike force around to take out his factories that I cause his production chain to falter and begin to break through.

I had to adjust away from my typical Artemis (long range missile ships) to Nemesis (which are really good against enemy dreadnoughts) to be able to begin killing them faster than he could produce them. I also needed to invest heavily in anti-air Apollos to counter the AI’s strike fleets of aircraft that nearly cost me the game.

Once the lines were broken I turned the biggest Ashes armada I had ever controlled against his Nexas. There were a lot of dreadnoughts fighting their way up that hill, and the explosions, missile trails and laser blasts cut through and won me the game.

Overall it is amazing how much game play can change with these changes. If I were to do it again I might keep the reduced cost overall, but maybe just 50% off rather than 90%. I liked the larger armies, but it was a crazy experience more like fighting a fire than playing chess.

If you decide to modify the csv files with a text editor (Notepad++ is my text editor of choice) you can do everything I was doing in Excel, it just isn’t formatted into columns to be easy to read. Instead it is raw text like the following:

Modifying the files this way works, you just need to count the amount of fields, remembering that commas separate the fields (CSV stands for Comma Separated Values) to get to the right values.

 

 

Scripting – Creating Scenarios

---

Scripting allows you a huge amount of control over what exactly happens on the map you are creating. You can restrict what buildings and units the players can use, setup triggers to lock or unlock them, spawn units or buildings for the players or their enemies. You can send units to attack specific targets and send dialog popups to the player. Everything you need to make your own custom scenarios.

All of this is stored in XML, not code. So you don’t need any special programming tools or experience to use it. The best advice for seeing what is possible is to look through the ..\Ashes of the Singularity\Assets\Campaign\ and \Scenario\ directories and see what the xml files are doing. Some examples are also included below.

There are three main elements in Ashes scripting: missions, players and triggers. Missions are the definition or the scenario. Players defines the players that are going to be used in the scenario. Triggers is where all the magic happens. Triggers have a lot of elements and options.

The following isn’t a complete list of scripting options in Ashes. But represents the most useful to get you up and creating your own scenarios right away. Note that all triggers and arguments are case-sensative.

Mission- Mission is the starting definition for this scenario.

• Title- Title of the mission (refers to a line in a .csv file in \Assets\UIText\ )
• Description- Description of the mission (refers to a line in a .csv file in \Assets\UIText\ )
• Synopsis - Brief description of the mission (refers to a line in a .csv file in \Assets\UIText\ )
• Map- What map this mission uses (must be the name of a folder in \Assets\Maps\ )
• EnableCreeps- Are creeps enabled in this map? [ Heavy | Random | Light | Normal ]
• HideTerrain- Should the world start revealed or not? [ 1 | 0 ]
• NoAttrition - Set this to make buildings not lose any health in uncontrolled regions. [ 1 | 0 ]
• NoVPVictory - Set this to disable the generic Turinium victory [ 1 | 0 ]
• NoSeedVictory - Set this to disable the generic Nexus-kill victory [ 1 | 0 ]
• PreMovie - Movie to play when loading the mission (must be a valid .webm path, starting in \Assets\)
• PostMovie - Movie to play on completing the mission (must be a valid .webm path, starting in \Assets\)

Menu Setup

• ImageBig- Campaign: The close up image of the planet | Scenario: The image used on the Ascendancy Wars screen
• Image- Campaign: The image displayed when this mission is selected
• ImageFade- Campaign: The image displayed when this mission isn’t selected
• CompImage - Campaign: The image displayed when the mission is selected and already completed
• CompImageFade - Campaign: The image displayed when the mission is not selected and already completed
• ImageRadius- Campaign: How big the image is
• PlanetPosition- Campaign: Where the planet is displayed in the campaign screen
• Prereq - Campaign: Title of the mission that must be completed to unlock this (refers to a line in a .csv file in \Assets\UIText\ )

Player- this area defines all the players that will be used in the Scenario.

• Name- Name of the player
• Faction- Faction the player belongs to [ PHC | SS ]
• Team- What team the player belongs to
• Color- What is the team color for the player [ 1-14 ]
• AIType- Set to “Player” if this is player controlled. "On" for AI control, "Off" for passive [ On | Off | Player ]
• AIDifficulty- What setting this AI player is on [ Beginner | Novice | Easy | Intermediate | Normal | Challenging | Tough | Painful | Insane ]
• NoSeed- Set this to 1 to disable a Nexus for the player. Note: Doing this will mean you need to manually set victory/loss triggers, as the generic Seed Victory condition won't trigger.
• NoEngineer- Set this to 1 if the player isn’t going to start with an Engineer.
• StartLocation- Which start location the player uses. Corresponds with what you see in the skirmish lobby.

Trigger- This is something that happens while the scenario is being played.

• Name- Name of the trigger.
• Owner- Which player is this trigger for.
• Inactive- If this trigger is inactive, to activate use the ActivateTrigger option from another Trigger.
• OtherTrigger- Name of another trigger that must have fired before this one will activate. Use this to set multiple conditions on a trigger occurring.
• NotOtherTrigger- Inverse of OtherTrigger. If the other trigger has fired this trigger won’t fire. Us this to create branching options in your scenario.
• Type- What type of trigger it is. See below.

Trigger Types

These are the types of triggers you can use in a script, and any specific arguments they support.

• ZoneCapture- Fires when a region is captured.
  • Owner- Player who must capture this region to fire the trigger.
  • Position- Map coordinates of the generator/nexas.

 

• Timer- Fires after a delay.
  • Time - Time in seconds after this gets triggered that it takes place.

 

• Build- Fires when a human player builds structures or units.
  • Target - The template of the building that will fire this trigger
  • IsBuilding - Set to "1" if the target is a building
  • Count - How many of the target template must be built to fire the trigger (default 1)

 

• Destruction- Fires when something specific dies.
  • IsBuilding- If this is a building (if not it refers to a unit).
  • Target- Name of the script-spawned unit or building.

 

• Research- Fires when a Quantum upgrade is researched.
  • Player- playerID of who can fire this trigger.
  • Target- Tech name that causes this trigger to fire.

 

• NamedCreate- Fires when a specific unit or building is spawned via a script.
  • Target- Name of the script-spawned unit or building.
  • IsBuilding- If this is a building (if not it refers to a unit).

 

• Area- Fires when the human player moves a unit into the area.
  • Center- Map coordinates of the center of the area.
  • Size- Size of the area.
  • Template- Template name of the unit that can trigger this. If you want it to fire if any unit enters the area, do not specify a Template argument.

ActivateTrigger- To activate another trigger, so you can create a series of triggers that have to be completed in order.

• Target- This is the name of another trigger that will be set from Inactive to Active.

AreaIndicator- This places a visible indicator on the map to help the player know where they should go to.

• Name- The name of the area.
• Position- The center of the area.
• Color- The color the area indicator is.
• Size- How big the area indicator will be.
• Duration- How long the area indicator should last, -1 means that it lasts forever.

AttackAttackMove- Order an army to move to a specific area.

• Name- The name of the army that will be given the order.
• Time- How long after the trigger occurs that the game will wait before issuing this order.
• Position- Where the army is ordered to move to.

Camera- Move the players view to a specific area.

• Position- Where the camera will be looking.
• RTP- The engineers tell me this is Rho/Theta/Phi for the camera angle settings. Since I’m pretty sure they made those words up we should just think of it as the Distance, Rotation and Pitch of the camera.
• Speed- Speed that the players view is switched to the new camera location.

Dialog- This creates a popup that can convey information or story to the player.

Entry- The actual text that will be displayed.

• Icon- The icon used with the text popup.
• Text- The actual text that is displayed.

EndMission- Use to force a win or loss of the scenario.

• Victory- Set to 0 to lose the scenario or 1 to win.
• String- The text that is displayed.

GrantStuff- Use this to give the player free resources when a trigger occurs.

• Metal- The amount of metal being granted.
• Quanta- The amount of quanta being granted.
• Radioactives- The amount of radioactives being granted.
• Tech- The amount of research being granted.
• Turinium- The amount of victory points being granted.

Objective- Use this to set objective notifications for the player (so they know what to do).

• Name- The name of the objective, use this name when checking or hiding it.
• Hide- If this objective should be hidden or not, usually this means the objective is complete.
• String- What the objective displays on the screen.
• SetCheck- If the objective checkbox is checked or not.

Restrict- To block the player from being able to access objects in the game.

• Type- Unit, Building, Research or Orbital. Whatever type of object that is being restricted.
• ID- The name of the object being restricted.
• Enable- Set this to 1 to enable the object. You can use this to restrict something early in the scenario and then enable it later on (for example: when the player accomplishes an objective or after a set amount of time).

SpawnBuilding- Places a building on the map.

• Name- The name you assign to the building.
• Template- The name of the building type being created.
• Player- The player who will own the building.
• Position- Where the building will be placed.
• NoDeath - Set this to "1" to make the unit immortal (you can still kill it with a scripted DestroyBuilding command)

SpawnUnit- Places a unit on the map.

• Name- The name you assign to the unit.
• Parent- The army the unit will belong to (used to make it easier to issue moves).
• Template- The type of unit being created.
• Player- The player that will own the unit.
• Position- Where the unit will be created.

How do you find out the position coordinates?

The UI for Ashes is defined in XML, it is as moddable as the rest of the game. But we just want to make one small change, we want the game to show us the coordinates. Fortunately there is already a field for that in the UI, it’s just marked hidden. You will find the following toward the end of AshesGameView.xml:

 To have the coordinates be displayed in game, change this to Hidden=”0”. 0 typically means False and 1 means True so by setting it to 0 we are setting it to “Not Hidden”. You may also want to reduce the FontSize, 20 tends to be fairly large but that is up to you.

This will help you get the exact coordinates when you are playing with your map to figure out where you want to place resources, starting locations for player, where you want events or trigger or where you want to spawn new units.

Putting it together

A single trigger can do any combination of the above options. It can popup some text, spawn some units, set an objective give the player some resources and unlock some new building options. It is up to you how you want to combine and use them. Let’s take a look at some examples.

Send an army to attack

The above trigger is inactive, meaning it needs another trigger to call it before it will activate. Once it does it will spawn 16 units into an army and send them to attack the defined map position. This is a relatively simple trigger, but a common one. With this alone you can create scenarios that spawn waves to attack the player, grant reinforcements to the player or create surprise ambushes.

 

Reward the player for capturing an area

The above trigger occurs when the player captures the region at the specified position. Notice that the trigger starts inactive, so it would need to be enabled by an earlier trigger before it could occur.

This trigger does the following:

• Checks the Cap_C_Obj objective in the player’s objective list.
• It disables the Cap_B_Ind Area Indicator by setting it’s duration to 0.
• It pops up some dialog for the player.
• It enables the player’s ability to build Metal Extractors.
• It spawns a free Engineer for the player.
• It moves the camera to look at the captured region.
• It adds a new objective for the player (Mex_Built_Obj).
• It gives the player 500 Metal.
• It makes the Cap_C_Trigger trigger active.

This is a great example of the kind of combinations that can be done with the trigger system. This is a reward to the player for capturing the region. But it could as easily have triggered an escalation for the enemy forces.

 

In Conclusion

Ashes of the Singularity gives you access to a powerful strategy game engine to create your own scenarios, objects and worlds. The designers have had a lot of fun creating scenarios for the game, and you will have access to the same features they had to create your own.