Publishing on Modtale

Modtale is the Hytale community repository for plugins, data assets, art assets, worlds, and modpacks.

This guide follows the current web editor publishing flow: create a draft, complete the page, upload a version, add relationships, submit for review, and automate repeat releases when useful. It does not cover the separate modpack creation workflow.

Quick Checklist

Have these ready before opening the upload flow:

1. Create the Draft

Open modtale.net/upload and choose the project type.

Use the type that matches the artifact you plan to publish:

Then choose the owner and give the project its first public text.

Fill in:

• Owner: your account or an organization you can publish under.
• Title: the public project name.
• Short Summary: one readable sentence, 10-250 characters.

2. Complete the Details

The editor groups the publishing workflow into tabs. The header actions are View Project, Submit, and Save.

Use the Details tab for the page users read before downloading:

Save after edits. The submit check blocks unsaved required changes.

3. Upload a Version

Open Files and add the release artifact.

Set the version fields carefully:

For plugin .jar uploads, Modtale can inspect manifest.json and suggest:

• Version number.
• Matching game version.
• Dependency matches.

Review suggestions before accepting them. The editor stores version relationships as structured metadata, which helps users and tools install compatible projects together.

4. Add Dependencies

Use Dependencies when this version needs another Modtale project.

Dependency flow:

Use Incompatible Mods for projects that should not be installed alongside this version. This is useful when two projects patch the same behavior, replace the same content, or cause each other to stop functioning altogether.

5. Submit for Review

Use Submit when the page and first version are ready.

The checklist expects:

• Title.
• Summary between 10 and 250 characters.
• At least one tag.
• At least one uploaded version.
• License.
• Saved changes.
• Valid repository URL, if present.
• Valid slug, if present.
• Description under the current length limit.

After submit, the project enters review. If approved, it can become public. If rejected, apply the feedback, save, and submit again.

6. Add Gallery Media

Open Gallery to make the project understandable at a glance.

Gallery tools:

Good gallery items show the actual result: UI, commands, before/after visuals, generated terrain, world locations, models, textures, or setup screens.

7. Project Settings

Use Settings for project-level controls.

Main controls:

Pending projects cannot freely move through every visibility state while review is active.

8. Invite Contributors

Use Team when other maintainers need access.

Contributor workflow:

Permission groups include:

• Project Management: metadata, icon, banner, deletion.
• Versions & Releases: upload, edit, delete, download.
• Visibility & Publishing: submit, revert, publish, unlist, archive.
• Community & Media: gallery and comment actions.
• Team Management: invites, role changes, transfers.

Grant the smallest useful role. Release maintainers usually need version and submit permissions; media contributors often only need metadata, icon, banner, and gallery access.

9. API Keys and Automation

Open Developer Settings from your account menu to create API keys.

API key rules:

Useful endpoint families:

POST   /api/v1/projects
PUT    /api/v1/projects/{id}
POST   /api/v1/projects/{id}/submit
POST   /api/v1/projects/{id}/revert
POST   /api/v1/projects/{id}/archive
POST   /api/v1/projects/{id}/unlist
POST   /api/v1/projects/{id}/private
POST   /api/v1/projects/{id}/publish

POST   /api/v1/projects/{id}/versions
PUT    /api/v1/projects/{id}/versions/{versionId}
DELETE /api/v1/projects/{id}/versions/{versionId}
POST   /api/v1/projects/{id}/versions/dependency-suggestions

PUT    /api/v1/projects/{id}/icon
PUT    /api/v1/projects/{id}/banner
POST   /api/v1/projects/{id}/gallery
POST   /api/v1/projects/{id}/gallery/youtube
PUT    /api/v1/projects/{id}/gallery/caption
DELETE /api/v1/projects/{id}/gallery

Example:

curl \
  -H "X-MODTALE-KEY: mt_live_your_key_here" \
  https://modtale.net/api/v1/projects/{project-id}/versions

Reference Repositories

Use these when you want the upload workflow scripted:

Recommended automation setup:

1. Create the Modtale project manually.
2. Copy the Project ID from Settings.
3. Create a project-scoped API key.
4. Store the key in local secrets or CI secrets.
5. Publish the built artifact with either HytalePublisher or a direct /api/v1 upload.

Maintenance Rhythm

For each new release:

• Use a new SemVer version.
• Select accurate game versions.
• Update dependencies and incompatibilities.
• Write a focused changelog.
• Refresh gallery media when the visible result changes.
• Submit or wait for review when the workflow requires it.

Troubleshooting

If submit is blocked, open the requirements panel first. It tells you what is missing.

Common fixes:

If you need help, gather the project ID, the action you tried, and the exact editor or API error before contacting the Modtale team.