An open API service indexing awesome lists of open source software.

https://github.com/insprill/dv-gauge

A Derail Valley mod that allows the track gauge to be changed
https://github.com/insprill/dv-gauge

csharp derailvalley hacktoberfest unity

Last synced: about 1 year ago
JSON representation

A Derail Valley mod that allows the track gauge to be changed

Awesome Lists containing this project

README

          

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![Apache 2.0 License][license-shield]][license-url]


Gauge



A Derail Valley that allows the track gauge to be changed.




Report Bug
·
Request Feature


Table of Contents


  1. About The Project

  2. Roadmap

  3. Building

  4. Building the Asset Bundle

  5. Contributing

  6. License

## About The Project

Gauge a Derail Valley mod that allows you to change the track gauge to anything you want.

This changes the gauge of the tracks, rolling stock bogies, and track decorations like buffer stops.
Physics is unaffected, this mod is purely aesthetic.

## Building

Gauge uses the same build system as Mapify.
For instructions on how to build the project, please read the [Mapify building documentation][mapify-building-docs].

## Building The Asset Bundle

To build the AssetBundle for gauge, you'll need to install Unity **2019.4.40f1**.
You can then open up the `GaugeBundleBuilder` project in this repo.

To add the meshes to the project you'll need to export them yourself using something like [AssetStudio][asset-studio-url].
You can find all the meshes you need to export in `GaugeBundleBuilder/Assets/Meshes/meshes.txt`.

To build the bundle, go to `Gauge > Build Asset Bundle`.
If you're missing meshes, it won't let you build the bundle.

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create.
Any contributions you make are **greatly appreciated**!
If you're new to contributing to open-source projects, you can follow [this][contributing-quickstart-url] guide.

## License

Code is distributed under the Apache 2.0 license.
See [LICENSE][license-url] for more information.

AssetBundle assets are owned by Altfuture and are included with permission, for the purpose of having Read/Write protection on them removed, which is necessary for this mod to function.
These assets are not covered by the Apache 2.0 license and have different terms and conditions. Contact [support@altfuture.gg][altfuture-support-email-url] for more information.

[contributors-shield]: https://img.shields.io/github/contributors/Insprill/dv-gauge.svg?style=for-the-badge
[contributors-url]: https://github.com/Insprill/dv-gauge/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/Insprill/dv-gauge.svg?style=for-the-badge
[forks-url]: https://github.com/Insprill/dv-gauge/network/members
[stars-shield]: https://img.shields.io/github/stars/Insprill/dv-gauge.svg?style=for-the-badge
[stars-url]: https://github.com/Insprill/dv-gauge/stargazers
[issues-shield]: https://img.shields.io/github/issues/Insprill/dv-gauge.svg?style=for-the-badge
[issues-url]: https://github.com/Insprill/dv-gauge/issues
[license-shield]: https://img.shields.io/github/license/Insprill/dv-gauge.svg?style=for-the-badge
[license-url]: https://github.com/Insprill/dv-gauge/blob/master/LICENSE
[altfuture-support-email-url]: mailto:support@altfuture.gg
[contributing-quickstart-url]: https://docs.github.com/en/get-started/quickstart/contributing-to-projects
[asset-studio-url]: https://github.com/Perfare/AssetStudio
[mapify-building-docs]: https://dv-mapify.readthedocs.io/en/latest/contributing/building/