File Hosting Your Mod

This page will cover how to use Github, Gitlab, and Gitgud as a zip file host for your mod, without having to use git.

To begin, make an account on your platform of choice:

  • Gitgud has no restrictions on NSFW content, and has many of their top repositories as examples, though smaller and less proven than the alternative hosts.

  • Gitlab is a larger platform than Gitgud with the same interface, but has the open risk of less permissive use policies.

  • Github is the largest platform. While historically fairly permissive of various NSFW projects, keep in mind their use policies. It also requires 2-factor authentication to use.

Then use the respective tab for your chosen platform to create a new repository for your mod:

  1. Create a project.

  2. Follow the prompts for naming, initializing a README, and making it Public:

../../_images/GitgudCreation.png

  1. Press Create Project

After creating your repo, create a release:

  1. Pin the releases section.

../../_images/GitgudRelease1.png

  1. Enter the releases section.

../../_images/GitgudRelease2.png

  1. Create a new Release.

../../_images/GitgudRelease3.png

On the release creation page, fill in its contents accordingly:

  1. Add and create a Tag name equivalent to the version number of your release.

../../_images/GitgudWriteRelease1.png ../../_images/GitgudWriteRelease2.png

  1. In Release Title, provide the name of your mod along with the version number.

  2. In Release notes, use markdown to provide a brief and eye-catching summary of the update. Make sparing use of bold words to help visually prioritize points of your release.

## Highlights
- Updated the mod's Perpetua monster json to feature the new markup syntax introduced in MGD v25.6.
- Nothing else really happened, the Example Mod is the epitome of perfection.

## Instructions
- Right-click the link of the zip below.
- Press `Copy Link`
- Paste into the mod installer in-game.

Tip

You can copy/paste the same relevant markdown contents of your release notes here and for your post on the MGD Discord, as the formatting is the same.

  1. While at the bottom of your Release notes, attach the zip file of your mod by clicking the paperclick icon in the bar above.

../../_images/GitgudAttach1.png

  1. Ensure the link is prepended with a ``# `` to make it a header, ensuring it is as big and noticeable as possible.

../../_images/GitgudAttach2.png

  1. Press Create Release at the bottom.

Tip

If at any point you make a mistake or want to change something, you can always edit the post via the pencil icon in the top right.

../../_images/GitgudEdit.png

Lastly, to help prevent people from getting lost on the homepage of your repo:

  1. Click on your README File.

../../_images/GitgudREADME1.png

  1. Click Edit and then Open in Web IDE to change its contents.

../../_images/GitgudREADME2.png

  1. Delete all of its contents and use this template to promptly direct the user to the Releases page of your repository (Ensure it does not lead to a specific release):

# <Mod Title Here>

## To download the mod, [go to the releases page here.](<Paste releases page link here>)
../../_images/GitgudREADME3.png

  1. Publish the changes to your repository by going to Source Control, writing a description of the change, and pressing Commit to 'master'. On the prompt, press Continue.

../../_images/GitgudREADME4.png

  1. Press the Go to Project prompt at the button on the bottom right and review your changes.