1. This site uses cookies. By continuing to use this site, you are agreeing to our use of cookies. Learn More.

Requirements for Uploads to the Download Centre

Discussion in 'Site Announcements' started by Road-hog123, Jul 14, 2016.

Thread Status:
Not open for further replies.
  1. Road-hog123

    Road-hog123 Code Fudger Administrator UKDT

    Joined:
    Dec 10, 2015
    Posts:
    1,158
    Likes Received:
    1,218
    LAST UPDATED 2017-09-02
    When you make a submission to our download centre, it must first be approved by a member of staff. This ensures members can be confident that files they download will work and we as staff can be proud of the content we offer. The below requirements protect you as an author and minimise support requests.

    To be approved, a file must meet all of the criteria applicable to it:

    The Submitted File
    • MUST be a *.zip file (compatible with Windows File Explorer), *.7z is permitted where a *.zip would be 128 MB or larger.
    • MUST NOT contain any further archives within the main archive
    • MUST contain a Read-Me document (see below for details) within the top two directory levels
    • MUST include only content for which the uploader has permission to distribute
    • MUST function fully and correctly when installed by exactly following the installation instructions, with only the listed required dependencies installed
    • MUST have a logical and intuitive folder structure (starting with "OMSI 2" or any of the directories immediately within is recommended)
    • MUST NOT overwrite default files or existing files from listed dependencies unless it is required
    • MUST be named sensibly (i.e. not "repaint.zip" or similar)
    • SHOULD contain as few unnecessary files as possible
    • SHOULD contain high-quality content you can be proud of. Unless you have relevant previous experience, your very first repaint won't meet this requirement.
    The Read-Me Document
    • MUST be a *.txt, *.pdf or *.rtf file. *.doc/*.docx is also permitted but not recommended.
    • MUST contain or link to clear installation instructions
    • MUST contain or link to a list of all dependencies with download links (for repaints, the original bus counts as a dependency)
    • MUST state when a file will overwrite existing files (no such statement is required for the inverse)
    • MUST list all authors of content in the file (may be provided in a separate credits file instead)
    • MUST explain how the file may be redistributed or used (may be provided in a separate license file instead)
    • There is a compliant Read-Me template at Resource - Read-Me template for repaints
    The File Description
    • MUST list all dependencies with download links
    • MUST include at least a brief description of the content of the submission
    • MUST explain how the file may be redistributed and used (may be provided in the form of a License)
    • MUST provide all information in English. Additional languages may be provided as supplementary translations of the main English content
    The Attached Images
    • MUST show the whole of the included content, or be indicative of the content included where the former is not feasible
    • MUST be in-game screenshots (screenshots of development or photos of the real thing may be included only to supplement in-game screenshots)
    • MUST NOT be photos of a monitor
    The Title
    • MUST include the name/abbreviation of the bus/map the file is for (where applicable)
    • MUST be descriptive of the content of the file
    Updates to Existing Submissions
    • MUST meet all the criteria of a new submission, including functioning without installing the previous version
    Resources
    • Single files may be uploaded without being in an archive format
    • A read-me may be omitted if it is not required
    • Other criteria not listed here may also not be applicable. If in doubt as to whether a criteria applies, ask for clarification.
    Additional Notes
    • In some occasional circumstances, approval of a file may be reversed (e.g. if a file is approved in error).
    • A file will not be approved if it is against the forum rules.
    • Users breaching the forum rules or wasting moderators' time are liable to be issued warnings and/or bans.
    • When a file is not able to be approved, the moderator who denies the file will send a PM to the uploader explaining why the file was not able to be approved so that they can address the issue and try again.
    • Please note that it is not possible to change the uploaded file between submission and approval, so if you need to make a change to the file it must be re-uploaded.
    • Meeting all of the criteria listed here is not a guarantee for approval, moderators may use their own discretion to decide not to approve a file.
     
    Last edited: Sep 3, 2017
    Jacobthebus and Admin like this.
  2. Road-hog123

    Road-hog123 Code Fudger Administrator UKDT

    Joined:
    Dec 10, 2015
    Posts:
    1,158
    Likes Received:
    1,218
    Our old requirements were vague and difficult to understand, so I've re-written them in manner that's hopefully easier to understand.
    Submissions will not be approved unless they meet all of the MUST and MUST NOT statements that are applicable to them.
    In a perfect world all submissions would also meet SHOULD statements, but these have a level on leniency to them, so you don't have to meet them entirely if it's not possible. However, these are not optional, you should still put effort into trying to meet these as best you can.
    Finally, "may" statements are optional additions or alternatives that we don't expect most users to need, but some will find them useful.

    A note about "recommended" or "preferred" choices
    • A folder structure starting with "OMSI 2" or the folders directly within is very intuitive and makes the installation process nice and simple. This helps users who may have comprehension difficulties or have simply not read the read-me to install and enjoy your creation.
    • *.doc/docx files can only be opened by Microsoft Word and similar programs, which is not default software. In addition, a *.pdf can easily be created using Word, but the created file cannot easily be edited and has fixed formatting, so will look the same on all computers it is viewed on.

    Clarification: "License" when referring to redistribution rights refers to a specific license (e.g. an Open Source license), not a phrase like "pleases do not distribute this" (quoted directly from a submission we got). If you are not specifying a license, specifying redistribution abilities can be done in the main body of the description, with a phrase like "Do not redistribute.".
     
    Last edited: Aug 20, 2017
    DaCookie! // MFF76 likes this.
  3. Road-hog123

    Road-hog123 Code Fudger Administrator UKDT

    Joined:
    Dec 10, 2015
    Posts:
    1,158
    Likes Received:
    1,218
    Revision as of 2017-08-20:
    *.rar and *.7z files are no longer permitted. This is for several reasons:
    • *.zip files can be opened on Windows without the need to install any software
    • Chrome version 61 and newer marks *.rar files as "potentially harmful to your computer", which may cause alarm to some members
    • *.rar files created with newer WinRAR versions don't open with older versions many people are using.
    • *.zip files created with software other than File Explorer may not be openable in File Explorer, reporting to the user that the file is corrupt or damaged. If you are creating a *.zip in another piece of software, test opening it before you submit it. :)
     
    Last edited: Aug 22, 2017
    0118999 likes this.
  4. Road-hog123

    Road-hog123 Code Fudger Administrator UKDT

    Joined:
    Dec 10, 2015
    Posts:
    1,158
    Likes Received:
    1,218
    Amendment to above:
    We've decided to allow an option to get higher compression ratios on large uploads.
    This means that particularly large content (like big repaint packs, scenery packs or maps) are permitted to be uploaded as *.7z files if they are larger than 128MB when in *.zip form.
    Obviously to open these users will need to download and use 7zip, but it's much better than WinRAR anyway. ;)
     
    Jacobthebus likes this.
  5. Road-hog123

    Road-hog123 Code Fudger Administrator UKDT

    Joined:
    Dec 10, 2015
    Posts:
    1,158
    Likes Received:
    1,218
    Revision as of 2017-09-02:
    Added a new rule:
    The download centre now rejects uploads in *.rar format entirely. Sticking your *.rar inside a *.zip gets around that nicely, but isn't permitted (I would have thought that was obvious, but evidently not... :tongueout:).
     
    0118999 likes this.
  6. Road-hog123

    Road-hog123 Code Fudger Administrator UKDT

    Joined:
    Dec 10, 2015
    Posts:
    1,158
    Likes Received:
    1,218
    Revision as of 2017-09-03:
    Externally hosted downloads are no longer permitted (the option has been removed) for new uploads.

    A recent submission resulted in us re-considering the problems associated with externally hosted files, after which we decided they weren't worth it.
    Notable issues with continuing to allow externally hosted files:
    • We'd have to curate and update a list of acceptable external sites (to avoid the use of sites where files expire, show obtrusive advertisement, are horrific to use, stop working if downloaded too many times, etc.)
    • Externally hosted files can be updated without going through Content Control (which mean broken, or more importantly virus-infested or rules-breaching, content could become present on the forum)
     
Thread Status:
Not open for further replies.

Share This Page