Skip to content

Latest commit

 

History

History
56 lines (35 loc) · 2.71 KB

README.md

File metadata and controls

56 lines (35 loc) · 2.71 KB

SpongeOnRails - A Mod bringing compatibility between the Railcraft Mod and the Sponge API.

Here you will find the source and issue tracker for SpongeOnRails. SpongeOnRails is not affliated with SpongeAPI; its cause is supported by CovertJaguar, for it may improve the playability of Railcraft and user experiences.

What is Railcraft?

Railcraft is a mod written for the hit game Minecraft. It is built on top of the Minecraft Forge API.

It greatly expands and improves the Minecart system in Minecraft. Adding many new blocks, entities, and features. It has been in development since 2012 and contains over 800 class files and hundreds of thousands of lines of code.

The mod was created and is still currently maintained by the user going by the name CovertJaguar.

What is Sponge API?

Go to Sponge API's official repo here: https://github.com/SpongePowered/SpongeAPI#spongeapi-

Why does this repository exist?

Once, Github user @gabizou made a project called ThaumicSponge. This becomes the primary motivation to make a similar project to provide plugins with abilities to integrate with mods. The expected use cases are use of mod moving sounds, particles, jobs plugins that work with players' uses of machines, etc. They are not supposed to impose limits on Railcraft but to increase the playability of it.

The name of the repository is suggested by liach and kashike.

Official Links

Patreon

Issues

Post only confirmed bugs here. Do not paste crash logs, but post pastebin or Github Gist links to FML logs. Crash logs are often inconclusive, compared to full logs.

More information about issue Labels can be found here. SpongeOnRails uses the exact same labels as Railcraft.

Building

The SpongeOnRails Project follows standard Forge conventions for setting up and building a project.

Initial Setup from the Command Line (Windows):

gradlew setupDecompWorkspace

License

SpongeOnRails, like Railcraft API and Sponge API, is licensed under the MIT License.