TrainSim.Com
Developer's Release Tips
If you have never released a file publicly before please carefully read the tips in the sections below.
Login before uploading is now required.
Go to the File Uploader
If you experience any difficulty with the new uploader, please PM eric with the details.
The maximum file size is 500 Mb for this upload method. If you need to upload files larger than that, please use a remote file sharing service (e.g. Google Drive, Dropbox, or your own website) and provide the link within the upload request. An excepton for complete routes can be made on request by contacting an administrator. Our file library can only accept files whose names have 60 letters or less before the ".zip". Please name your files appropriately! Also please remember that we only accept zip files; no rar files please!
If you've developed an add-on that you'd like to share with others you may be wondering what is the best way to do this? We at TrainSim.Com would like to offer some tips to help you do it the right way the first time (and not incidentally make things easier for our file librarian when he deals with your work!).
First thing to consider is how you want it released, as a paid for product ("shareware"), as something you own the rights to but don't charge for ("freeware") or something you completely and freely give away ("public domain"). Let's define the terms:
Shareware: Something distributed by the shareware method is a commercial product for which the developer expects to get paid. The developer holds the copyright and all other rights to the product, but allows some form of it (possibly limited in some way) to be freely distributed so that potential customers can evaluate it.
Freeware: Something designated as freeware is given away at no charge by the designer, however the designer retains the copyright and other rights. In the sim realm some people use the term freeware to also mean that no one may charge for copying, distributing or otherwise making available (i.e., through an online system of some sort); this extension to the actual meaning is contrary to usage outside the sim world and has been the cause of some confusion. A designer, as copyright holder, can include additional terms and conditions beyond those implied by the term "freeware" but should not assume that "freeware" means more than it actually does. For a sample freeware legal notice, click here.
Copyleft: A distribution concept developed by The GNU Project. Applying a "copyleft" to a release puts it somewhere between freeware and public domain. The legal terms allow the file to be improved on, but the source code must always be available for free. The standard legal notice that must be included provides strong protection for your release, much better than the legal mumbo jumbo that many hobbyists use. For the full details of copyleft visit the General Public License page at www.gnu.org/copyleft/gpl.html.
Public Domain: For something to be public domain the designer must specifically give up all rights to it and declare that it is public domain. By doing so anyone else can do anything they want with the item so designated. Note that anything you create is automatically given copyright protection, whether you remember to say so or not; it only becomes public domain by specifically saying so.
WHOSE WORK IS IT?
Some files are completely new work, developed from scratch. But many people base their work on someone else's earlier development. Repainted rolling stock is a prime example but other improved or modified files are common. If your release is not 100% your own work, consider the following carefully.
Unless the original developer has specifically given up all rights to his work by declaring it public domain he still owns the work and all rights to it. You cannot use or modify any such item without following the original designer's terms. Some designers include usage terms in the release documentation, but more often than not these terms are unclear so to be safe it would be strongly advised to directly contact the original author before releasing any modified works.
In freeware, copying other peoples textures, shapes, etc., whether you do or don't hack the internal names, or using even pieces of other peoples bitmaps, or any component without the written permission of the original author is breaking International Copyright Law. Just giving the original author a "Credit" is not sufficient.
It is never legal to modify and release as your own work anything based on commercial software, whether shareware or store bought. Just don't do it.
DOCUMENTATION
Whatever you release you need to include some documentation with it. How involved the documentation is will generally depend on what it is you're releasing. For example, if you release a route you'll want to include maps or some other form of description of the layout; if releasing rolling stock you'll want to describe how to install it and perhaps what routes or other rolling stock it goes with. These are just examples of course.
When writing your documentation remember not to assume anything! Your audience does not have your background and skills and may not have the software and other tools that you do. It doesn't hurt to include extra detail, especially on how to install. It also makes sense to make your docs a plain ASCII text file, not a Word or other word processor file (what if the recipient doesn't have the right word processor?). Be careful with file names too...names with special characters (pretty much anything other than letters and numbers) may cause problems when viewed on the Internet (i.e. using our file library's zip file viewer).
SCREEN SHOTS
Taking screen shots is easier than most people think--because the function is a standard feature built right into Windows itself. To take a screen shot of the active window all you need to do is hit the Alt key and the Print Screen key simultaneously. An image of the active window is then copied to the clipboard and from there you can paste the image into any program capable of handling graphics--including the Paint program that comes with Windows. Then, just save it as a file and you've got your screen shot.
Of course, that's just the absolute basics. You really should consider why you are taking a screen shot and how to make it come out looking as good as possible. For a picture that will end up as a tiny thumbnail image you should keep things simple. For example, if you're doing a screen shot of an locomotive put it in front of a very simple background so it really stands out. You also need to consider the same things that photographers do such as where the sun is located. It really makes a difference! You should take your screen shot so the sun is shining directly on the side of the object you are looking at as otherwise you tend to get a dull, gray image instead of a nice bright one. Put some thought and time into it and make your screen shot really look good!
RELEASE CHECKLIST
Ready to release? Here's a checklist to help keep you from forgetting anything:
| 1) Obtain all necessary permission(s) for anything you are using based on another designer's work. | Don't use other people's work without their permission. |
| 2) Include complete documentation in an ASCII text file. This way anyone can read the file (and it can also be viewed online at TrainSim.Com using the file library's View function). Don't forget to include your real name and email address (or some other way to contact you). | Use ASCII text: anyone can read it, no matter what their system or software. |
| 3) Write a brief description of the file. You will include this when uploading. |
For MSTS New Haven 40 Foot Single Door Box
Car 34537 repaint. A typical NYNH&H RR
box car with the older style script logo
and a Superior 7 foot wide sliding door.
Original model by Larry Goss and Roger
von Ahrens. Repainted by Nels Anderson.
Public Domain. |
| 4) Create a screen shot. During the upload you will be able to select a thumbnail image. The image should be cropped tightly to eliminate as much unnecessary background as possible and the background should be kept simple and uncluttered. Give the screen shot the same base name as the .zip file (i.e., if your main file is MYFILE.ZIP call your screen shot MYFILE.GIF). Please do not include animations in your thumbnail. | Sample Thumbnail Image
|
| 5) Save your files and docs into a zip file (also called a compressed file). When naming your .zip file avoid using anything other than letters and numbers. If you're releasing an updated version of a previous release try to include version numbers right in the .zip file name (i.e., MYFILE11.ZIP would be v1.1 and would replace MYFILE10.ZIP). | |
| 6) Unzip your .zip file and test it. Make sure you didn't leave anything out! You don't want to have an email box full of complaints and have to upload an emergency patch to fix things. | |
UPLOADING
WHAT WE DO WITH YOUR FILE
The file you upload is not immediately added to our main file library. All files are manually checked, so it may be one or two days after you upload before your file appears on our new files lists.
If any problems are found the file may be held or deleted. Please note, though, that no testing is perfect and we do not guarantee the safety or usability of files in our library.