Information Requirements for OMSI Download Centre Submissions (1 Viewer)

Status
Not open for further replies.

Road-hog123

An Orange Bus
Administrator
UKDT
Founding Member
1,904
2,709
Please note that these requirements apply to uploads to the OMSI category only.

LAST UPDATED 2020-04-14
All submissions to our Download Centre first need to be reviewed by a member of staff, to ensure they meet some basic requirements. These requirements protect you as an author, and attempt to minimise the number of support requests you receive.

For your update or submission to be approved, it must meet all of the below (applicable) standards. Should your file not meet the requirements, a member of staff will open a ticket with you outlining the reasons why.

Summary of Basic Requirements
Your submission MUST have:
  • An appropriate file name (i.e. not repaint.zip)
  • An appropriate file listing name
  • A file description including all of the following:
    • brief description of the file
    • an overview screenshot
    • list of dependencies it needs to work, with links.
  • A README file containing:
    • installation instructions
    • redistribution and usage rights, your (author’s) details
    • list of all dependencies with links.
Detailed Requirements
The Submitted File

  • MUST be a ZIP file. 7z is permitted for files over 128MB;
  • MUST include a README file within the first two directory levels (see below);
  • MUST be named, packaged and structured appropriately. Grounds for rejection would be, but not limited to:
    • Files named repaint.zip, or similar;
    • Files with archives inside the main archive;
    • Not installing correctly when the download instructions and requirements are followed;
    • Including unnecessary files.
  • MUST NOT overwrite existing files except where required for functionality;
  • MUST have readily available dependencies.
The README File
There is a template for OMSI repaints available HERE, which we recommend you use. If you are uploading other content, you may also wish to base your readme on this remplate.
  • MUST be a TXT or PDF file;
  • MUST contain installation instructions and details of readily available dependencies required for the file to function correctly;
  • MUST state if existing files will be overwritten;
  • MUST list all authors of content contained within the file;
  • MUST explain how the file may be redistributed or used.
The File Description
  • MUST list and link to all dependencies required for the file to function correctly;
  • MUST include an appropriate title, description of the file, and screenshots relative to the content;
  • MUST provide all information in English. Additional translations are permitted.
Additional Information
  • Resources (e.g. PDF timetables for a map) may be uploaded without being in an archive format or without a README file.
Disclaimer
By uploading you grant a permanent, irrevocable, unlimited license for us to redistribute your content through our service. Any files you upload must only contain content that you have permission to redistribute. Fellowsfilm reserves the right to reverse the approval of a file, and staff members are entitled to use their professional judgement for any other reason not outlined above. You are liable for the accuracy of the information that you provide, as Fellowsfilm are not responsible for files which do not install or function correctly. Repeated non-compliant submissions, or not complying with forum rules may result in warnings, bans or the removal of submitting privileges. The content you submit should be of quality that you are proud of!
 
Last edited by a moderator:

Advertisement

Road-hog123

An Orange Bus
Administrator
UKDT
Founding Member
1,904
2,709
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 the folders directly within "OMSI 2" 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:
  • Like
Reactions: DaCookie! // MFF76

Road-hog123

An Orange Bus
Administrator
UKDT
Founding Member
1,904
2,709
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:
  • Like
Reactions: 0118999

Road-hog123

An Orange Bus
Administrator
UKDT
Founding Member
1,904
2,709
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. ;)
 

Road-hog123

An Orange Bus
Administrator
UKDT
Founding Member
1,904
2,709
Revision as of 2017-09-02:
Added a new rule:
The Submitted File
  • MUST NOT contain any further archives within the main archive
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:).
 
  • Like
Reactions: 0118999

Road-hog123

An Orange Bus
Administrator
UKDT
Founding Member
1,904
2,709
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)
 

0118999

Street cleaner
Forum Moderator
Premium Subscriber
589
1,062
Revision as of 2018-11-03:
The Submitted File
  • Any required dependencies MUST be readily available
This formalises a position Fellowsfilm have held for some time; submissions with dependencies that cannot be easily obtained, downloaded or purchased through authorised channels cannot be accepted - this means no mods for Lowlander21's Wright Eclipse 1, etc.
 
Last edited:
  • Like
Reactions: Lakitu

0118999

Street cleaner
Forum Moderator
Premium Subscriber
589
1,062
Revision as of 2018-26-03:
  • Repeated non-compliant submissions, particularly of the same file when content controller feedback has not been addressed, may result in disciplinary action including suspension of submission privileges.
The file approval rate is hovering around 50%, and following staff meetings it is apparent our volunteer content controllers waste a lot of their time looking multiple times at the same files that are repeatedly submitted with the same basic mistakes (e.g. no readme, no dependency links), which holds up the whole approval queue.

We want to encourage everyone to share their work with the community and do not take disciplinary action lightly but it's unfair on others if their file approvals are held up by someone who keeps submitting a file again and again with the same basic mistakes.

We also have issues with people updating their files before they've even been approved, we implore you to take time and care developing your work and then testing your files and fixing obvious bugs before uploading, it's not a race and there's no prizes for uploading sooner; Content Control are not beta testers! And please use the readme template to ensure your documentation is compliant.
 

0118999

Street cleaner
Forum Moderator
Premium Subscriber
589
1,062
Recently we have received many uploads with a non-compliant readme, which has led to their rejection.

Once your file has been downloaded from Fellowsfilm it is separated from any information held here in the file listing, so:
  • it is important your readme identifies the author, otherwise you may lose rights to your work because ownership is unclear!
  • installation instructions must be clear for novices, to avoid unnecessary support requests and negative reviews. A simple "Copy to your OMSI directory" is not sufficient for newbies.
  • detail all required dependencies and where to get them, for the same reasons as above.
The above is a reminder of our two year old upload requirements detailed at the top of the page, these are not new conditions! Please use the readme template to ensure your documentation is compliant before you submit.
 
  • Like
Reactions: smi11083827

0118999

Street cleaner
Forum Moderator
Premium Subscriber
589
1,062
V3D has intimated they do not wish the B7TL download link to be shared at the moment, because the project is alpha and continually being updated, so the download link changes often and mods released now could break or regress the release version of the project. As such Fellowsfilm will not be accept files which require the B7TL ALX400 until there is a stable release with a fixed download link that can be listed as a dependency, at which point we will welcome your submissions.
 

Advertisement

Road-hog123

An Orange Bus
Administrator
UKDT
Founding Member
1,904
2,709
Very minor revision:
  • Some links were pointing to Fellowsfilm.co.uk or other old URLs, they have been updated to current URLs.
  • Some formatting has been adjusted without changing the meaning, for example replacing file endings with file types (e.g. "ZIP archive file" rather than "*.zip file").
  • "Intuitive directory structure" recommendation has been changed to suggest starting with the directories immediately within the OMSI 2 directory rather than the OMSI 2 directory itself, as the former results in much simpler installation instructions.
 

Road-hog123

An Orange Bus
Administrator
UKDT
Founding Member
1,904
2,709

ross4122

Staff Team Leader
Premium Subscriber
1,148
1,951
Minor Revision 02/04/2020

The following requirement has been removed:
The File Description MUST explain how the file may be redistributed and used (may be provided in the form of a License)
 

TAC

T
Administrator
Founding Member
215
212
Following some internal discussion based on feedback we've received for a while regarding the currently lengthy file approval process, we've decided to make some subtle but nevertheless prominent changes to the process, as follows:
  • We have now formally ended in-game testing as part of the Content Control approval flow - this should contribute massively towards reducing the time it takes to approve files, which we know is one of the main pet hates of the old system. It's important to still remember that your file must still be of a decent quality, and that we may still reject files if it's clear that they're inappropriate
  • We have removed some unnecessary upload requirements - making it easier for content creators to ensure their file meets all of the requirements
  • We have summarised all of the above Upload Requirements into short points that sufficiently cover the majority of requirements; as part of this change Content Control will also be exercising more leniency when enforcing each individual requirement, taking the reason for each requirement into account; we want to approve files, not reject them
The primary reason for us avoiding these changes up to now was a worry that, by relaxing the requirements, poorer quality files could be approved. Therefore, we have also introduced the following measures to shift some responsibility to content creators:
  • We've extended the current 'Upload Requirements Confirmation' on the file upload page to 6 tick-boxes, based on common reasons for rejections - we hope this will encourage more content creators to ensure each requirement is met
  • We'll be more open to making more common use of our existing policy of removing submission privileges (temporarily or permanently) to members who submit multiple files which have to be rejected - this will still however be used as a last resort, with the preferable solution being working with content creators to get their content approved
  • We're going to encourage users to report files of extremely poor quality or any clear violations of the Upload Requirements to us - this allows us to take a more reactive approach to violations of the requirements, which we understand may now go unnoticed during the less rigorous approval process
As part of these changes, alongside the recent welcoming of several new Content Control members, we are now setting ourselves the target of reviewing all files within 24 hours. All file authors also have a part to play in us consistently reaching this target by helping us to pass your files first time. It's worth noting that the standard disclaimer still applies; in some busy periods following high profile releases when we receive a high volume of submissions, this short turnaround time may not always be possible.

These changes will apply to all new submissions from this point onwards. All previous submissions still awaiting approval will still follow the old process.

We appreciate the efforts of the vast majority of file authors who have always followed the requirements, and thank you for continuing to trust us with your files.
 
  • Like
Reactions: Myles W and Bones

ross4122

Staff Team Leader
Premium Subscriber
1,148
1,951
Tickets
Although not a change to the requirements, as of 14/04/2020 we will no longer be sending PMs to users who've had their files approved/declined.

Instead, we will now open a ticket with the user. These are able to be viewed by all Content Control, Staff Leadership and Administration team members just as PMs were, and similarly you are able to converse with staff just like PMs.

If you've got any questions, please open a ticket and a staff member will respond :)
 
Last edited:
Status
Not open for further replies.

Members viewing Thread (Users: 0, Guests: 1)