2martens
/
timetable
mirror of https://github.com/2martens/tsw-timetable.git
1
0
Fork 0
Code Issues

Added README

This commit is contained in:
Jim Martens 2023-10-26 21:26:44 +02:00
parent 26bb3e0654
commit 31855a870f
1 changed files with 26 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
README.md
View File

@ -1,15 +1,30 @@
# Template
# Timetable tool (backend) for Train Sim World
Contains a template for a new Java project. By utilising the buildSrc Gradle pattern,
this template provides a fast start for plain Java projects as well as Spring Boot projects.
## Motivation
It also contains some modules which each show a different way to use the template:
- module-server: A Spring Boot server project
- module-plain: A plain Java project
- module-lib: A Java library that can be used in other modules
With the release of the Public Editor for Train Sim World 4 it is now possible to create
24h timetables in the Unreal Engine and then play those in the game. However, a lot of
planning has to happen before the first service SHOULD be created in the engine.
To use the template, simply copy the contents of this repository into a new repository.
Then, replace all occurrences of `template` and `Template` with the name of your project.
Finally, replace the contents of this README with the README of your project.
Until now, even Dovetail Games is manually copying timetable information to Excel sheets.
This is a time-consuming process that takes the fun away and makes it a very laborious process.
The settings.gradle file needs to be changed to import the modules that you want to use.
What if all the timetable data of passenger services could be automatically fetched without
manual copying? This timetable tool intents to do just that.
## Limitations
Some manual work in the planning
stage will remain: creating routes with portals and depots, formations, and providing some
data for services once they are fetched. This data includes formations and linking them together
into rotations.
The public timetable isn't enough? Freight trains, empty coaching stock movements or light loco
movements are not in the timetable and have to be entered manually. But the tool will support
as good as possible.
For starters, only the Deutsche Bahn API and hence Germany are supported. More countries could
be added later on once reliable data sources are identified.
Even then, this tool can only support with present day timetables. Vintage timetables are not
available via APIs or similar sources and the manual work will remain there.