diff --git a/content/docs/en/publishing/index.mdx b/content/docs/en/publishing/index.mdx index 6db13fe2..59b36c3c 100644 --- a/content/docs/en/publishing/index.mdx +++ b/content/docs/en/publishing/index.mdx @@ -10,6 +10,7 @@ We have compiled guides to publish for each marketplace, so you can easily get y - [Publishing on Modtale](./publishing/modtale) - [Publishing on CurseForge](./publishing/curseforge) - [Publishing on BuiltByBit](./publishing/builtbybit) +- [Publishing on Modifold](./publishing/modifold) If you run a marketplace, please reach out to us via our email `neil@hytalemodding.dev` to get your marketplace listed in our documentation. diff --git a/content/docs/en/publishing/meta.json b/content/docs/en/publishing/meta.json index 11e1197b..ce4e2d34 100644 --- a/content/docs/en/publishing/meta.json +++ b/content/docs/en/publishing/meta.json @@ -1,4 +1,4 @@ { "icon": "FileText", - "pages": ["modtale.mdx", "curseforge.mdx", "builtbybit.mdx"] + "pages": ["modtale.mdx", "curseforge.mdx", "builtbybit.mdx", "modifold.mdx"] } diff --git a/content/docs/en/publishing/modifold.mdx b/content/docs/en/publishing/modifold.mdx new file mode 100644 index 00000000..f720d792 --- /dev/null +++ b/content/docs/en/publishing/modifold.mdx @@ -0,0 +1,152 @@ +--- +title: "Modifold" +description: "A step-by-step guide to publishing your mod on Modifold." +--- + +# Publishing Your Mod on Modifold + +[Modifold](https://modifold.com) is a modding platform where modders can upload their mods and share them with the community. + +This guide follows the real project publishing flow: from signing in to your account to submitting for moderation. + +![](/assets/guides/modifold_home.png) + +## Step 1. Sign In + +First, you need to sign in. +In the site header, click **"Log in"** and choose your preferred sign-in method. + +Currently available: +- GitHub +- Discord +- Telegram + +![](/assets/guides/modifold_auth.png) + +## Step 2. Create a Project + +After signing in successfully, click **"Create Project"** in the site header. + +Fill in: +- **Project name** +- **Summary** (a short description in 1-2 sentences, for example: `This project adds...`) + +Then click **"Create Project"**. + +After creation, you will immediately be taken to the project settings page. + +![](/assets/guides/modifold_project_settings_general.png) + +## Step 3. Project Icon + +It is recommended to upload a project icon first. + +It is best to use an in-game preview of your mod so users can immediately understand what the project does. + +Uploading an icon is not required, but highly recommended. + +## Step 4. Description + +Make sure to fill in the project's **Description**. + +[Modifold](https://modifold.com) supports a convenient Markdown editor where you can describe in detail: +- what your mod does +- how to use it +- important details for users + +Banners linking to other platforms are allowed. +Minimum description length: **50 characters**. + +![](/assets/guides/modifold_project_settings_description.png) + +## Step 5. Upload a Mod Version + +This is the most important step. + +Upload your project version file (for example, `.jar`) through the upload block: +- drag and drop the file, or +- click the block and select a file from your computer + +![](/assets/guides/modifold_project_settings_upload_version.png) + +Then fill in: +- **Version number** (for example, `1.0.1` if this is a fix) +- **Changelog** (optional, in Markdown format) +- **Release channel**: `Release`, `Beta`, or `Alpha` + +After that, click **"Upload Version"**. + +Congratulations, your first version is uploaded. + + +If you publish on Modifold, keep your project page updated so users can quickly understand what your mod does and which version they should install. + + +## Step 6. Gallery + +In the **"Gallery"** tab (recommended), you can upload images showcasing your mod's features. + +One image can be marked as **Featured**. + +The featured gallery image appears in search results and on your project card. + +This image will be used as your project's cover. + +## Step 7. Links + +In the **"Links"** tab, you can add useful project links: +- Issue Tracker +- Source Code +- Wiki (linking to external resources) +- HytaleModding Wiki +- Discord + +These links are shown in a separate block on the project page. + +![](/assets/guides/modifold_project_settings_links.png) + +## Step 8. Tags + +In the **"Tags"** tab (recommended), select relevant project tags. +For example, if your mod adds decorative elements, choose the `Decoration` tag, then click **"Save"**. + +## Step 9. License + +In the **"License"** tab, you can set the project license. + +By default, the license is **ARR (All Rights Reserved)**, but you can choose another available license. + +## Step 10. Moderation + +The final required step is the **"Moderation"** tab. + +There, you can make sure all required fields are completed and submit the project for review. + +![](/assets/guides/modifold_project_settings_moderation.png) + +After submission, moderators check: +- compliance with Modifold content rules +- project versions for malware + +When the review is complete, you will receive a notification: +- if the project is approved, it becomes public +- if it is rejected, moderators will provide a reason, and you can resubmit after making fixes + +# Integration with HytaleModding Wiki + +If your mod uses [HytaleModding Wiki](https://wiki.hytalemodding.dev), just add the wiki link in your Modifold project settings. + +After that, your project will have a **Wiki** tab with synchronized pages and Markdown content. + +Wiki configuration and editing remain on the [HytaleModding Wiki](https://wiki.hytalemodding.dev) website. + +![](/assets/guides/modifold_project_wiki.png) + +The screenshot above shows the Voile project wiki page: [modifold.com/mod/voile/wiki](https://modifold.com/mod/voile/wiki) + +# Getting Help + +If you run into issues while uploading your project, please: + +- Contact the official Modifold Discord server +- Or email `support@modifold.com` with a description of the issue. \ No newline at end of file diff --git a/public/assets/guides/modifold_auth.png b/public/assets/guides/modifold_auth.png new file mode 100644 index 00000000..9f9b6121 Binary files /dev/null and b/public/assets/guides/modifold_auth.png differ diff --git a/public/assets/guides/modifold_home.png b/public/assets/guides/modifold_home.png new file mode 100644 index 00000000..86d7726c Binary files /dev/null and b/public/assets/guides/modifold_home.png differ diff --git a/public/assets/guides/modifold_project_settings_description.png b/public/assets/guides/modifold_project_settings_description.png new file mode 100644 index 00000000..c37fbcfc Binary files /dev/null and b/public/assets/guides/modifold_project_settings_description.png differ diff --git a/public/assets/guides/modifold_project_settings_general.png b/public/assets/guides/modifold_project_settings_general.png new file mode 100644 index 00000000..b8638373 Binary files /dev/null and b/public/assets/guides/modifold_project_settings_general.png differ diff --git a/public/assets/guides/modifold_project_settings_links.png b/public/assets/guides/modifold_project_settings_links.png new file mode 100644 index 00000000..2e52af3c Binary files /dev/null and b/public/assets/guides/modifold_project_settings_links.png differ diff --git a/public/assets/guides/modifold_project_settings_moderation.png b/public/assets/guides/modifold_project_settings_moderation.png new file mode 100644 index 00000000..53e5d6a2 Binary files /dev/null and b/public/assets/guides/modifold_project_settings_moderation.png differ diff --git a/public/assets/guides/modifold_project_settings_upload_version.png b/public/assets/guides/modifold_project_settings_upload_version.png new file mode 100644 index 00000000..4ffae58c Binary files /dev/null and b/public/assets/guides/modifold_project_settings_upload_version.png differ diff --git a/public/assets/guides/modifold_project_wiki.png b/public/assets/guides/modifold_project_wiki.png new file mode 100644 index 00000000..00ed59a3 Binary files /dev/null and b/public/assets/guides/modifold_project_wiki.png differ