olavim-MapsExtended icon

MapsExtended

Custom map core functionality

Last updated 5 months ago
Total downloads 975954
Total rating 6 
Categories Utilities Custom Maps
Dependency string olavim-MapsExtended-1.4.2
Dependants 260 other packages depend on this package

This mod requires the following mods to function

BepInEx-BepInExPack_ROUNDS-5.4.1100 icon
BepInEx-BepInExPack_ROUNDS

BepInEx pack for ROUNDS. Preconfigured and ready to use.

Preferred version: 5.4.1100
willis81808-UnboundLib-3.2.8 icon
willis81808-UnboundLib

This is a helpful utility for ROUNDS modders aimed at simplifying common tasks.

Preferred version: 3.2.8

README

MapsExtended

Map editor mod for ROUNDS.

Usage

You can access the editor from the game's main menu. Maps are saved to path/to/ROUNDS/maps. Maps are loaded from path/to/ROUNDS/maps and path/to/ROUNDS/BepInEx/plugins.

Sharing maps

Since maps are loaded from the BepInEx plugin folder, you can easily share your maps via Thunderstore. See the Thunderstore manifest docs for instructions on how to create a valid manifest zip file.

Since custom maps must be loaded with this mod, you need to add it to your manifest's dependencies. Example manifest.json:

{
    "name": "MyMaps",
    "version_number": "1.0.0",
    "website_url": "https://github.com/thunderstore-io",
    "description": "This is a description for a mod. 250 characters max",
    "dependencies": [
        "olavim-MapsExtended-<version>"
    ]
}

In the above example, you should change "<version>" with the latest version of MapsExtended.

Development

Before building the project, copy and rename Config.props.dist to Config.props and change the properties inside it to match your configuration.

Project structure

The mod has been split into two separate BepInEx plugins. The MapsExtended plugin consists of the core logic for loading custom maps. The Editor plugin adds the actual map editor to the game. Splitting the mod into two plugins allows for custom map mods to only depend on the core plugin: the editor is not needed if all you want to do is to play custom maps.

Folders:

  • MapsExtended.Core: The core plugin C# project
  • MapsExtended.Editor: The editor plugin C# project

Custom map objects

See the wiki for a guide on how to add custom map objects (and more) in MapsExtended.