GithubHelp home page GithubHelp logo

asdf1280 / edr Goto Github PK

View Code? Open in Web Editor NEW

This project forked from simrail/edr

0.0 0.0 0.0 27.54 MB

EDR timetable & driver view for Simrail

Home Page: https://edr.simrail.app

License: GNU General Public License v3.0

JavaScript 0.12% Lua 1.41% TypeScript 97.16% CSS 0.04% Makefile 0.35% HTML 0.67% Dockerfile 0.26%

edr's Introduction

Simrail Community - EDR

Enhanced timetable experience for Simrail dispatch posts

The project aims to provide a better, easier to understand and modern timetable experience for dispatchers compared to the official built-in timetable in the game. Created by @DKFN. Currently maintained by @Tallyrald

➡️➡️➡️The app is available right here.⬅️⬅️⬅️

Main features include but are not limited to:

  • Live delay / early estimations
  • Live distance from dispatch post and current next station for trains
  • Search for multiple train numbers at once
  • Multi-timetable posts merged into a single row for better and faster decision-making
  • Several pre-configured train filters for easy overview
  • Driver mode with checkpoint / station list and map integration
  • UI available in multiple languages
  • Light / dark mode

Issues, bugs, feature requests

Found any bugs or have new ideas? Open a new issue!

Contributing

If you feel like contributing, please take a look at current issues. Feel free to submit a PR!

Release cycle and branches

  • Starting from 1.0 each version is published on its own branch
  • The master branch is the development branch and it contains the latest changes since the last release
  • Hotfixes should be pushed to the respective release branch and later merged into the main branch

Reusing part of the code

You are welcome to use part or all the code for your own projects. But we kindly ask you to follow these rules:

  • State somewhere that part of the code uses this project's code
  • If you bring significant enhancements to the code, share it with us (either via DM / PR or an issue) and/or the SimRail modding community
  • If you directly use the API, don't be reckless in the amount of requests made

Of course, we will not send lawyers to your house if you don't follow these rules, we are all having fun with our favorite train game :)

Localization

Translations are happening via Transifex. If you wish to participate, we ask that you first contact @Tallyrald via email or on the Simrail forums.

Self Hosting

This is a very basic guide, more details may be added later if needed.

  1. Clone this repo
  2. Download and install Docker Desktop (or equivalent for your OS)
  3. Edit config and API files and replace URLs to match your system (backend, frontend, nginx)
  4. Create and run docker images (backend, nginx, osrm), remember to forward ports specified in Dockerfiles and add envvars to backend when running (LISTEN_PORT, STEAM_API_KEY)

Thank you

A big thank you to the game developers for making Simrail and providing the necessary data for this app to work.

Anorther big thanks to all the SimRail community that has made this project grow way beyond my wildest expectations!

License

GNU General Public License v3.0

edr's People

Contributors

tallyrald avatar dkfn avatar asdf1280 avatar quead avatar itsp33t avatar flows-c avatar frozentux avatar iwhite67 avatar mrquentinh avatar darknazz avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.