Skip to content

Latest commit

 

History

History
58 lines (36 loc) · 4.81 KB

README.md

File metadata and controls

58 lines (36 loc) · 4.81 KB
Raw

Traincraft - A mod for Minecraft

Here you will find the source code for the Official Traincraft Project.

This repository is only for release versions. Pull requests, bugs, and sugguestions should be sent to the repository at https://github.com/EternalBlueFlame/Traincraft-5.

What is Traincraft?

Traincraft is a mod written for Minecraft. It is built on top of the Minecraft Forge API.

It adds new functionality and looks to the vanilla trains, and some other areas of the game. It adds over 80+ trains, wagons, and other vehicles. It also ads a completely new railway system with curved tracks and slopes. It was originaly started by Spitfire4466, then jointly developed with Mrbrutal, and now maintained by me, Mrbrutal. It has had well over 1,000,000 downloads and has been in development since 1.2.x versions of Minecraft.

Why are you posting the Source Code?

Since Spitfire4466 and me are exceedingly low on time to work on this project, open source was the only viable sollution. But since open source is something I've never done on this level or size, I'm a bit hessitant to do so. But in the hopes that I can still be a part of this and so that we can make Traincraft great again, I'm opening the source code for everyone to see. Furthermore, both versions of Traincraft will be open sourced, so that anyone willing to contribute will be able to contribute on both fronts.

Official Links

Issues

Issues opened up in this repo are intended to be for the 1.11 version. For 1.7.10 see https://github.com/EternalBlueFlame/Traincraft-5

Contributing

Traincraft Project welcomes contributions from anyone, provided they have signed the Contributor Licensing Agreement (CLA) found here.

Signing the CLA is simple, just follow the link, and hit the "I Agree" button and you are good to go.

Regarding new features/behavior changes, please submit a Suggestion Issue to the Tracker before you write a single line of code. Keeping everyone on the same page saves time and effort and reduces negative experiences all around when a change turns out to be controversial.

For now, the focus should be on updating the mod to the 1.7.x and 1.11.x (master) branches, before adding any new features. Those will be added when the rewrite version is being done.

Building

Setting up the project was made easy with the setup.bat file (doesn't always work for eclipse, blame forge). Otherwise this project will follow standard Forge conventions. See http://www.minecraftforge.net/wiki/Installation/Source After you finish the tutorial or setup, if it has not already been defined, you must manually define the root path of your JDK installation folder, and the location of your :ForgeBin: If your IDE asks for a deobfuscator, select the folder: C:\Users[USERNAME].gradle\caches\minecraft\net\minecraftforge\forge\1.7.10-10.13.4.1558-1.7.10\unpacked\conf

License

Traincraft is licensed under a custom usage license tailored specifically for the project. It can be read here.

  • You MAY you remix, transform, or build upon the sources material, but you MUST distribute your contributions under the same license as the original. Forks and edits of the Github Project SHOULD be for the purpose of contributing to the Official Traincraft Project.
  • You MUST give appropriate credit, provide a link to the license, and indicate if changes were made. You may do so in any reasonable manner, but not in any way that suggests the licensor endorses you or your use.
  • Contributors should work along to distribute only one Official Traincraft build created from a fork.
  • Official website is available for distribution of the Official Traincraft builds: contact spitfire4466@gmail.com
  • Unofficial builds may NOT be named or distributed under the name "Traincraft" but MUST contain a statement explicitely showing it is a derivative of the Official Traincraft mod.
  • You may NOT use the material for commercial purposes.
  • You may NOT use Traincraft Art Assets in other projects unless the project is intended to operate alongside Traincraft or is the Official continuation of Traincraft. Examples are Addons and InterMod Integration. Art assests include and are not limited to: Textures, Models(.obj or source code), Sounds, Any other art part of Traincraft.
  • All contributions to the Official Traincraft Project must be covered by a Contributor Licensing Agreement signed by the contributor.