question:'Is this title free of useless information?',
shown:true,
rules:[
'No unnecessary data (mod loaders, game versions, etc)',
'No emojis / useless text decorators',
],
examples:[
'✅ NoobMod [1.8+] • Kill all noobs in your world!',
'[FABRIC] My Optimization Pack',
'[1.17-1.20.4] LagFixer ⚡️ Best Performance Solution! ⭕ Well optimized ✅ Folia supported! (BETA)',
],
exceptions:[
'Loaders and/or game versions allowed if this project is a port of another mod. (ex: Gravestones for 1.20)',
'Loaders allowed if they choose to separate their project into Forge and Fabric variants (discouraged)',
],
options:[
{
name:'Contains useless info',
resultingMessage:`## Misuse of Title
Persection5.2of[Modrinth'sContentRules](https://modrinth.com/legal/rules#miscellaneous) we ask that you limit the title to just the name of your project. Additional information, such as themes, tags, supported versions or loaders, etc. should be saved for the Summary or Description. When changing your project title, remember to also ensure that your project slug (URL) matches and accurately represents your project.`,
},
],
},
{
id:'slug',
question:'Is the slug accurate and appropriate?',
shown:true,
rules:['Matches title / not misleading (acronyms are OK)'],
options:[
{
name:'Misused',
resultingMessage:`## Misuse of Slug
Persection5.2of[Modrinth'sContentRules](https://modrinth.com/legal/rules#miscellaneous) your project slug (URL) must accurately represent your project. `,
},
],
},
{
id:'summary',
question:`Is the project's summary sufficient?`,
shown:true,
rules:[
'The summary should provide a brief overview of your project that informs and entices users.',
`Should not be the exact same as the project's title`,
'Should not include any markdown formatting.',
],
options:[
{
name:'Insufficient',
resultingMessage:`## Insufficient Summary
Persection5.3of[Modrinth'sContentRules](https://modrinth.com/legal/rules#miscellaneous) Your project summary should provide a brief overview of your project that informs and entices users.
Persection5.3of[Modrinth's Content Rules](https://modrinth.com/legal/rules#miscellaneous) your Summary can not be the same as your project'sTitle.Yourprojectsummaryshouldprovideabriefoverviewofyourprojectthatinformsandenticesusers.
Persection5.3of[Modrinth'sContentRules](https://modrinth.com/legal/rules#miscellaneous) your Summary can not include any extra formatting such as lists, or links. Your project summary should provide a brief overview of your project that informs and entices users.
'Should answer what the project specifically does or adds ',
'Should answer why someone should want to download the project ',
'Should indicate any other critical information the user must know before downloading',
'Should be accessible (no fancy characters / non-standard text, no image-only descriptions, must have English component, etc)',
],
options:[
{
name:'Insufficient',
resultingMessage:`## Insufficient Description
Persection2.1of[Modrinth's Content Rules](https://modrinth.com/legal/rules#general-expectations) your project'sDescriptionshouldclearlyinformthereaderofthecontent,purpose,andappealofyourproject.
Currently,itlooksliketherearesomemissingdetails.
%EXPLAINER%`,
fillers:[
{
id:'EXPLAINER',
question:'Please elaborate on how the author can improve their description.',
Persection2.1of[Modrinth's Content Rules](https://modrinth.com/legal/rules#general-expectations) your project'sDescriptionshouldclearlyinformthereaderofthecontent,purpose,andappealofyourproject.
Seedescriptionslike[SimplyOptimized](https://modrinth.com/modpack/sop) or [Aged](https://modrinth.com/modpack/aged) for examples of what a good description looks like.
`,
},
{
name:'Insufficient (default projects)',
resultingMessage:`## Insufficient Description
Persection2.1of[Modrinth's Content Rules](https://modrinth.com/legal/rules#general-expectations) your project'sDescriptionshouldclearlyinformthereaderofthecontent,purpose,andappealofyourproject.
Seedescriptionslike[Sodium](https://modrinth.com/mod/sodium) or [LambDynamicLights](https://modrinth.com/mod/lambdynamiclights) for examples of what a good description looks like.
Persection2.2of[Modrinth's Content Rules](https://modrinth.com/legal/rules#accessibility) a project'sSummaryandDescriptionmustbeinEnglish,unlessmeantexclusivelyfornon-Englishuse,suchastranslations.Youmayincludeyournon-EnglishDescriptionifyouwouldlikebutweaskthatyoualsoaddanEnglishtranslationoftheDescriptiontoyourDescriptionpage,ifyouwouldliketouseanonlinetranslatortodothis,werecommend[DeepL](https://www.deepl.com/translator).`,
},
{
name:'Unfinished',
resultingMessage:`## Unfinished Description
ItlookslikeyourprojectDescriptionisstillaWIPseeingas%REASON%.Pleaseremembertosubmitonlywhenready,asitisimportantyourprojectmeetstherequirementsofSection2.1of[Modrinth'sContentRules](https://modrinth.com/legal/rules#general-expectations), if you have any questions on this feel free to reach out!`,
},
{
name:'Headers as body text',
resultingMessage:`## Description Accessibility
Inaccordancewithsection2.2of[Modrinth'sContentRules](https://modrinth.com/legal/rules) we request that \`# header\`s not be used as body text. Headers are interpreted differently by screen-readers and thus should generally only be used for things like separating sections of your Description. If you would like to emphasize a particular sentence or paragraph, instead consider using \`**bold**\` text using the **B** button above the text editor.`,
},
{
name:'Image-only',
resultingMessage:`## Image Descriptions
Inaccordancewithsection2.2of[Modrinth'sContentRules](https://modrinth.com/legal/rules) we ask that you provide a text alternative to your current Description. It is important that your Description contains enough detail about your project that a user can have a full understanding of it from text alone. A text-based transcription allows for those using screen readers, and users with slow internet connections unable to load images to be able to access the contents of your Description. This also acts as a backup in case the image in your Description ever goes offline for some reason.
WeappreciatehowmucheffortyouputintoyourDescription,butaccessibilityisimportanttousatModrinth,ifyouwouldlikeyoucouldputthetranscriptionofyourDescriptionentirelyina\`details\` tag, so as to not spoil the visuals of your Description.`,
},
{
name:'Non-standard text',
resultingMessage:`## Description Accessibility
Persection2of[Modrinth'sContentRules](https://modrinth.com/legal/rules#clear-and-honest-function) your description must be plainly readable and accessible. Using non-standard text characters like Zalgo or "fancy text" in place of text anywhere in your project, including the Description, Summary, or Title can make your project pages inaccessible. This is important for users who rely on Screen Readers and for search engines in order to provide relevant results to users. Please remove any instances of this type of text.`,
},
],
},
{
id:'links',
question:`Are the project's links accessible and not misleading?`,
shown:
props.project.issues_url||
props.project.source_url||
props.project.wiki_url||
props.project.discord_url||
props.project.donation_urls.length>0,
rules:[
`All links must be accessible.`,
`All links must correspond correctly with a label (ex: Discord link should not go to a YouTube channel)`,
],
options:[
{
name:'Links are misused',
resultingMessage:`## Misuse of External Resources
Persection5.4of[Modrinth'sContentRules](https://modrinth.com/legal/rules#miscellaneous) all links must lead to correctly labeled publicly available resources that are directly related to your project.`,
},
{
name:'Not accessible (source)',
resultingMessage:`## Unreachable Links
Persection5.4of[Modrinth'sContentRules](https://modrinth.com/legal/rules#miscellaneous) all links must lead to correctly labeled publicly available resources that are directly related to your project.
Persection5.4of[Modrinth'sContentRules](https://modrinth.com/legal/rules#miscellaneous) all links must lead to correctly labeled publicly available resources that are directly related to your project.
Currently,your%LINK%linkisinaccessible!`,
fillers:[
{
id:'LINK',
question:'Please specify the link type that is inaccessible.',
},
],
},
],
},
{
id:'categories',
question:`Are the project's tags/categories accurate?`,
Persection5.1of[Modrinth'sContentRules](https://modrinth.com/legal/rules#miscellaneous), it is important that the metadata of your projects is accurate. Including that selected tags honestly represent your project.`,
},
],
},
{
id:'side-types',
question:`Is the project's environment information accurate?`,
resultingMessage:`## Incorrect Environment Information
Persection5.1of[Modrinth'sContentRules](https://modrinth.com/legal/rules#miscellaneous), it is important that the metadata of your projects is accurate, including whether the project runs on the client or server side.
Persection5.1of[Modrinth'sContentRules](https://modrinth.com/legal/rules#miscellaneous), it is important that the metadata of your projects is accurate, including whether the project runs on the client or server side.
question:`Are the project's gallery images relevant?`,
shown:props.project.gallery.length>0,
options:[
{
name:'Not relevant',
resultingMessage:`## Unrelated Gallery Images
Persection5.5of[Modrinth's Content Rules](https://modrinth.com/legal/rules#miscellaneous) any images in your project'sGallerymustberelevanttotheprojectandalsoincludeaTitle.`,
'A multi-loader project should not use additional files for more loaders',
'Modpacks must be uploaded as MRPACK files. Be sure to check the project type is modpack (if not their file is malformed)',
],
options:[
{
name:'Incorrect additional files',
resultingMessage:`## Incorrect Use of Additional Files
Itlookslikeyou've uploaded multiple \`mod.jar\` files to one Version as Additional Files. Per section 5.7 of [Modrinth'sContentRules](https://modrinth.com/legal/rules#miscellaneous) each Version of your project must include only one \`mod.jar\` that corresponds to its respective Minecraft and loader versions. This allows users to easily find and download the file they need for the version they're on with ease. The Additional Files feature can be used for things like a \`Sources.jar\`.
Itlookslikeyou've uploaded your Modpack as a \`.zip\`, unfortunately, this is invalid and is why your project type is "Mod". I recommend taking a look at our support page about [Modrinth Modpacks](https://support.modrinth.com/en/articles/8802250-modpacks-on-modrinth), and once you'rereadyfeelfreetoresubmityourprojectasa\`.mrpack\`. Don't forget to delete the old files from your Versions!`,
"The following content has attribution requirements, meaning that you must link back to the page where you originally found this content in your modpack description or version changelog (e.g. linking a mod's CurseForge page if you got it from CurseForge):"
)
printMods(
noMods,
'The following content is not allowed in Modrinth modpacks due to licensing restrictions. Please contact the author(s) directly for permission or remove the content from your modpack:'
)
printMods(
permanentNoMods,
"The following content is not allowed in Modrinth modpacks, regardless of permission obtained. This may be because it breaks Modrinth's content rules or because the authors, upon being contacted for permission, have declined. Please remove the content from your modpack:"
)
printMods(
unidentifiedMods,
'The following content could not be identified. Please provide proof of its origin along with proof that you have permission to include it:'