Uploading Mods

Step 1: Request Upload Access

Upload access is granted on a per-user basis to maintain quality and security. To request access:

1. Visit our Contact page
2. Choose your preferred contact method (Email or Discord)
3. Include the following information in your request:
   • Your Discord username
   • Brief description of the mod(s) you want to upload
   • Links to any existing mods or projects (if applicable)
4. Wait for approval (typically 1-3 business days)

Step 2: Prepare Your Mod

Before uploading, make sure your mod is properly prepared:

File Structure

• Package your mod as a ZIP file
• Include all necessary files (DLLs, assets, config files, etc.)
• Ensure the ZIP can be extracted directly to the Railroader mods folder
• Test your mod locally before uploading

Metadata to Prepare

• Mod Name: Clear, descriptive name for your mod
• Version Number: Semantic versioning recommended (e.g., 1.0.0, 1.2.3)
• Description: Detailed explanation of what your mod does (supports Markdown)
• Changelog: List of changes in this version
• Dependencies: List any other mods required for yours to work

Step 3: Configure Access Permissions

Configure who can download your mod by setting role requirements. You can modify these permissions at any time from the mod edit page.

Access Control Options

• Public Access: Anyone can download your mod (no roles required)
  • Leave the "Required Roles" field empty
• Role-Restricted Access: Require specific Discord roles to download
  • Select the Discord server (guild) from the dropdown
  • Choose one or more roles from that server
  • Users must have at least one of the selected roles to download

When to Use Role Restrictions

Consider role-restricted access for:

• Beta/testing versions available to supporters or testers
• Premium mods for Patreon supporters or server boosters
• Private mods for specific communities
• Early access content before public release

Step 4: Create Mod Entry and Upload File

Once you have upload access and your mod is prepared:

1. Log in to the modding hub with your Discord account
2. Click "Admin" in the top navigation to access the Admin Panel
3. Click "Upload New Mod" in the admin sidebar
4. Fill out the initial mod information:
   • Enter your mod name
   • Write a description (Markdown supported)
5. Click "Create Mod" - you'll be redirected to the mod edit page
6. Click "Upload New File" button to open the upload dialog
7. In the upload dialog:
   • Select your ZIP file (drag & drop or click to browse)
   • Set version number (auto-extracted from filename, but you can edit it)
   • Add a changelog entry for this version (optional but recommended)
   • Click "Upload File"
8. After upload completes, configure remaining metadata:
   • Update description if needed
   • Configure access permissions (public or role-restricted)
   • Add additional changelog entries if needed
9. Click "Save Changes" to save your metadata

Step 5: Update Your Mod

To release a new version of an existing mod:

1. Go to the Admin Panel → "Manage Mods"
2. Find your mod in the list and click "Edit"
3. Click "Upload New File" button to open the upload dialog
4. In the upload dialog:
   • Select your new ZIP file (drag & drop or click to browse)
   • Update the version number (auto-extracted from filename, but you can edit it)
   • Add a changelog entry describing what's new (optional but recommended)
   • Click "Upload File"
5. After upload completes, update any other metadata (description, permissions) if needed
6. Click "Save Changes" to save metadata updates

Managing Your Mods

From the Admin Panel, you can:

• View Statistics: See download counts for each version
• Edit Details: Update description, changelog, or dependencies
• Update Version: Release new versions with updated files
• View Activity: See recent downloads and user activity (aggregate only, no personal data)

Best Practices

• Use Semantic Versioning: Follow the MAJOR.MINOR.PATCH format (e.g., 1.0.0 → 1.0.1 → 1.1.0)
• Write Detailed Changelogs: Help users understand what's new or fixed in each version
• Test Before Uploading: Verify your mod works correctly before publishing
• Document Dependencies: Clearly list all required and optional mods
• Include Installation Instructions: Add installation steps in your description if needed
• Keep Descriptions Updated: Update your mod description as features change
• Use Markdown Formatting: Make your description readable with headers, lists, and code blocks

Markdown Formatting Tips

Your mod descriptions support Markdown for rich formatting:

## Features
- Feature one
- Feature two

## Installation
1. Download the mod
2. Extract to your mods folder
3. Launch the game

## Configuration
Edit `config.json` to customize settings

Discord Notifications

When you upload a new version of your mod, Discord servers that have subscribed to mod updates will automatically receive notifications in their configured channels. This helps your community stay up-to-date with your releases!

Server owners can use the /subscribe slash command to receive update notifications for:

• All mods
• Only public mods
• Mods that require specific roles in their server

Troubleshooting

Upload Failed

• Verify the file is a valid ZIP archive
• Ensure you have a stable internet connection
• Try uploading again
• Check browser console for detailed error messages

Cannot Edit Mod

• You can only edit mods you uploaded yourself
• Check that you're logged in with the correct Discord account

Need More Help?

Visit our Contact page for support or to report issues with the upload system.

Next Steps

Ready to get started? Request upload access and join the growing community of Railroader mod creators!