Modding:Maps

From Caves of Qud Wiki
Jump to: navigation, search
This page is about modding. See the modding overview for an abstract on modding.
This page is about modding. See the modding overview for an abstract on modding.



.rpm files[edit | edit source]

RPM files are stores of static map content. They are a simple XML format. You can create your own RPM files, or "patch" the ones shipped with the game in your mod folders by using the same filename for the .rpm file.

The in-game map editor loads and saves files in the .rpm XML format. It supports saving complete maps with all of the 80x25 cells included in the XML.

RPM files can represent a particular zone (such as the Grit Gate complex), but an RPM file is also used for the world map (currently JoppaWorldNew4.rpm), which is generated in similar fashion to other zones.

Adding something to an existing map[edit | edit source]

In the following example only a single cell is defined in the rpm. It also defines Load="Merge" on the map which tells the map reader to append the content to the cell without deleting what is already there (a floor tile, or other object for instance). You name the rpm file the same as the version from StreamingAssets/Base/.

Example Joppa.rpm from Two Ctesiphus tutorial mod

<?xml version="1.0" encoding="utf-8"?>
<Map
  Width="80"
  Height="25" Load="Merge">
  <cell
    X="41"
    Y="7">
    <object Name="Ctesiphus"></object>
  </cell>
</Map>

Replace a Terrain Tile in World Map[edit | edit source]

This example also only defines the one cell it wants to replace, however does not use the Load="Merge option. The world map expects only one terrain object per map cell, and not using Load="Merge" tells the game to replace the contents of that cell.

Example JoppaWorldNew4.rpm to replace a terrain tile

<?xml version="1.0" encoding="utf-8"?>
<Map
  Width="80"
  Hight="25">
  <cell
    X="12"
    Y="22">
    <object Name="My_TerrainEastJoppa"></object>
  </cell>
</Map>

My_TerrainEastJoppa would be an object you define in the object blueprints to render the cell however you want, and you can then define your own "sub zone" within Worlds.xml attached to that Terrain tile via <cell ApplyTo="My_TerrainEastJoppa">

Example of edited ObjectBlueprints.xml

<objects>
   
  <object Name="My_TerrainEastJoppa" Inherits="Terrain">
  <part Name="Render" 
        DisplayName="your display name here" 
        Tile="Terrain/yourcustomtile.png"  
        ColorString="&amp;G^k"  
        DetailColor="r"> <!-- sets a number or attributes such as the location of your custom tile (in a sub folder of your mod folder) and the colours to be applied to it -->
  </part>
  <part Name="Description" Short="your description here"></part>
  <tag Name="NoBiomes" Value="1"></tag>
  <tag Name="OverlayColor" Value="&amp;W"></tag>
  
</object>

Example of edited Worlds.xml

<worlds>
  <world Name="JoppaWorld" Load="Merge">


    <cell Name="some name" Inherits="WatervineCell" 
          ApplyTo="My_TerrainEastJoppa" 
          Mutable="false" > <!--sets whether or not procgen functions here -->
    
      <zone Level="10" x="0-2" y="0-2" Name="outskirts, Joppa" NameContext="Joppa">
        <builder Class="JoppaOutskirts"></builder>
        <encounter Table="JoppaOutskirtsEncounters" Amount="minimum"></encounter>
      </zone> <!-- this first part is borrowed from Joppa in this example -->

      <zone Level="10" x="1" y="1" Name="somename" ProperName="true">
        <map FileName="yournewmap.rpm"></map> <!-- put this map file in your mod folder -->
        <builder Class="Music" Track="MehmetsMorning" Chance="100"></builder>
      </zone> 
      
      <!-- more zones such as underground could be added here -->

    </cell>

  </world>
</worlds>

Using the Map Editor[edit | edit source]

The map editor is available as a utility from the main menu in-game when the Overlay UI is enabled.

  1. Start Qud
  2. Enable the Overlay UI (Options > Overlay UI > Enable overlay user interface elements)
  3. Enable mouse input (Options > Overlay UI > Allow mouse input)
    • The map editor won't work if you skip this step
  4. Return to the main menu.
  5. Click Modding Utilities in the lower right corner.
  6. Click Map Editor.
  7. Click New Map to start a new map design, or click Load Map to load an existing RPM file (there are some in the game directory if you want to open one to look at it as an example)

You can:

  • Use the search bar in the upper right corner to filter object blueprints for selection, and select items in the sidebar.
  • Ctrl+click to add the selected item to the map
  • Alt+click to select an existing item on the map
  • Click and drag to move the map around.

Examples[edit | edit source]

The Brainwraith mod (Nexus, Steam) is an example of a mod that makes extensive use of map and world modifications. It modifies the world map and also creates several new RPM-based zones.