Submitting your map

Note

This guide assumes you’ve done everything in I’m done, what now?, make sure you read it before continuing.

Submitting a new map

  1. Create a new release

    Before submitting your map, you need to create a release to indicate what version of your map should be considered ready for use

    • Open your map on GitHub

    • Click on Releases on the right and select Create a new release

    ../../_images/releases.png ../../_images/create.png
    • Click Select tag and create a new tag

    ../../_images/createtag.png ../../_images/nametag.png

    Important

    You should keep the names of your releases, tags, and version ID (from lebmod.json) consistent with each other.

    Tip

    If you have pushed commits after you pushed the version you consider ready and don’t want the new commits to be a part of the release, select Target: main next to the version tag and Recent Commits to find the version you’d like to use

    • If everything looks right, go ahead and click Publish release

    ../../_images/publish.png
  2. Go to The Modtools Database submission form

  3. Click Submit a mod.

    ../../_images/createissue.png
  4. Fill out the form with information about your mod.

    ../../_images/fillform.png
  5. Wait for a moderator to review your map, they will request changes if needed.

Submitting an update to your map

  1. Create a new release

    Before submitting your update, you need to create a release to indicate what version of your map should be considered ready for use

    • Open your map on GitHub

    • Click on Releases on the right and select Draft a new release

    ../../_images/releases.png ../../_images/draft.png
    • Click Select tag and create a new tag

    ../../_images/createtag.png ../../_images/nametag2.png

    Note

    You should keep in mind if your update is a major or minor update when picking a version number, for example:

    If the update is minor, you should only increase the second (or third) digit, such as 1.0 to 1.1

    If the update is major, you should increase the first digit and set the rest to 0, such as 1.1 to 2.0

    Important

    You should keep the names of your releases, tags, and version ID (from lebmod.json) consistent with each other.

    Tip

    If you have pushed commits after you pushed the version you consider ready and don’t want the new commits to be a part of the release, select Target: main next to the version tag and Recent Commits to find the version you’d like to use

    • Write a list of what this update changes in the description

    • If everything looks right, go ahead and click Publish release

    ../../_images/publish2.png
  2. Go to The Modtools Database

  3. Find your map that you want to submit an update to

    ../../_images/search.png
  4. Leave a comment mentioning that you have made an update with a changelog of the changes you have made.

  5. Wait for a moderator to review your map, they will request changes if needed.