A small Simrail scenario framework

[lars.oj.lindner]

 

Hi everyone.

I want to share my first ever made Simrail scenario. It is a short scenario, requiring the Cargo DLC, and it's main purpose is to show an example of how to use the scenario framework I have made.

This is a short example scenario where you will be shunting in odd places and bot trains will come and go in a perhaps unrealistic way. The purpose of this scenario is not to be realistic. It is more an example of how one can use the Framework to create a scenario in a simplified way.

This scenario starts in Lazy where you will be shunting to your carriages. As a first action, call the dispatcher who will create a route for you to the carriages. Call the dispatcher once more when you have coupled the locomotive to the carriages and you are ready to departure.

From Lazy you will be driving to Dąbrowa Górnicza Ząbkowice where you will add a couple of more carriages to the once you already have. Call the dispatcher again when arriving at the red light at Dąbrowa Górnicza Ząbkowice. When at the station, make sure to stop at an appropriate distance from the shunting signals so that you new carriages and locomotive can fit and not extend past the signal. The new carriages can be seen to the right and there are usually three och four carriages. Call the dispatcher when you have decoupled from your old carriages and the again when you have coupled the new carriages to the old once and you are ready to departure.

At Będzin you will park your carriages at a side track. Decouple the carriages from your locomotive and call the dispatcher, telling him/her that you are ready to drive to your final destination, Sosnowiec Glówny, where you will park the locomotive.

To finish the scenario you have to park the locomotive 50 meters or less from the signal. Turn off the locomotive and exit through the door.

In a couple of places you might not get a go signal and no response from the dispatcher. If this happens to you, try to drive slowly closer to the signal. It should the give you a go signal.

You will find more information of how to use the framework in the scenario readme file.

Any comments and/or suggestions of improvements are appreciated.

 

Simrail-ny.zip

Edited December 28, 2025 by lars.oj.lindner

[KIEROWNIK]

[eSPeIKaE]

There is Polish language?✌️

[mateusz424]

First and foremost, and quickly: my appreciation and thanks for the comments in your framework's code. It's clear what a given piece of code does. You don't have to wonder what the author meant.
Comments in Lua code are very helpful in finding the cause when something in a newly written script isn't working properly or isn't working at all.
Comments in code are also helpful for the script's author, because believe me – after a month or two, you can forget what you meant when writing the code.

Great job! 👍

[lars.oj.lindner]

Thank you.

 

I thought it had be clear what everything is used for if anyone should be able to use it and make their own scenarios.

Regarding a Polish version. I can't read or speak a single word of Polish but if Google Translate is alright it would not be impossible for me to add it. 

 

[mateusz424]

W dniu 29.12.2025 o 15:39, eSPeIKaE napisał(a):

There is Polish language?✌️

Wypakuj poniższszy plik pl.zip (zawiera plik pl.lang) do folderu Locales w folderze scenariusza, czyli do: 
...\Steam\steamapps\common\SimRail\SimRail_Data\StreamingAssets\Sceneries\Simrail-ny\Scenarios\Scenario_1\Locales 
Będziesz miał polskie napisy 🙂

 

pl.zip

Edited December 30, 2025 by mateusz424

[Piotr75]

.

Edited December 31, 2025 by Piotr75

[mateusz424]

W dniu 28.12.2025 o 09:07, lars.oj.lindner napisał(a):

(...) The purpose of this scenario is not to be realistic.
(...) Any comments and/or suggestions of improvements are appreciated.

Your framework seems to work fine.
When it comes to realism:

• In Poland, trains usually run on the right track. The left track is intended for traffic in the opposite direction and it's used for driving in the forward direction in exceptional situations.
• Tm semaphores (shunting semaphores) are used only for shunting signals (Ms1 and Ms2). They cannot be used to give a train a signal permitting it to leave a station onto a railway line. Nor can they be used to give a train a signal permitting it to enter a station from a railway line.

• Only semi-automatic semaphores mounted on poles (masts) painted with red and white stripes can be used as station entry and exit signals. However, they can also give the Ms2 signal permitting shunting.

• Shunting usually takes place within a railway station; shunting is not performed on a railway line (between stations). The shunting limits within a station are marked by W5 signs:

Without special permission from the Train Dispatcher, a shunting locomotive or EMU may not pass (cross) a W5 sign.

• Shunting begins after passing the Tm semaphore displaying the Ms2 signal, not after the narrator says: "you are now shunting." 😉 The Ms2 shunting signal limits the speed to 25 km/h.
• The Sz signal (substituting signal):

is displayed on semi-automatic semaphores by Train Dispatcher only when, for some reason (usually a malfunction), the signal allowing for drive cannot be displayed, or no signal at all, or when the semaphore has previously displayed a signal that doesn't match to any pattern, a so-called "doubtful signal".

Edited December 29, 2025 by mateusz424

[lars.oj.lindner]

 

[EN]
Thank you for the description of the Polish signaling system. As you already have noticed I have very little experience of it. 😉

I will post an update of the framework here with some new functionality, for instance the ability to select date, time and weather, select cargo types for the random train sets and the possibility to do brake checks and leak checks. There will also be a Polish version of the readme and lang files then.

After that I will create a longer and more realistic scenario and post it in another thread.

Thanks again for all your help.

[PL]
Dziękuję za opis polskiego systemu sygnalizacji. Jak już zauważyłeś, mam z nim bardzo małe doświadczenie. 😉

Opublikuję tutaj aktualizację frameworka z kilkoma nowymi funkcjami, na przykład możliwością wyboru daty, godziny i pogody, wyboru rodzaju ładunku dla losowych składów pociągów oraz możliwością przeprowadzania kontroli hamulców i szczelności. Będzie też polska wersja plików readme i językowych.

Potem stworzę dłuższy i bardziej realistyczny scenariusz i opublikuję go w innym wątku.

Jeszcze raz dziękuję za wszelką pomoc.

 

[lars.oj.lindner]

 

 

[EN]
The first real version of the framework is now released and can be downloaded from GitHub (https://github.com/aptolil/ScenarioFramework). It is also published as an attachment here.
The scenario is almost the same as before. Only small changes has been made, like a brake check has been added and one can select weather at scenario start. 
There is also a Polish version of the scenario and of the ReadMe file which describes how to use the framework.

This is a small framework I have developed with the intention to make it simpler for any one to make their own scenarios in Simrail. (https://wiki.simrail.eu/).
For a description of how to use the framework se the scenario readme file in `Scenarios/Scenario_1/ReadMe/en/README.md`.
The scenario readme files can be viewed within Simrail but code examples seams to be formated incorrectly so it is better to open the file directly in an editor.

[PL]
Pierwsza, prawdziwa wersja frameworka jest już dostępna i można ją pobrać z GitHuba (https://github.com/aptolil/ScenarioFramework). Jest ona również opublikowana jako załącznik tutaj.
Scenariusz jest prawie taki sam jak poprzednio. Wprowadzono jedynie drobne zmiany, takie jak dodanie kontroli hamulców i możliwość wyboru pogody na początku scenariusza.
Dostępna jest również polska wersja scenariusza oraz plik ReadMe, który opisuje, jak korzystać z frameworka.

To niewielki framework, który opracowałem z myślą o ułatwieniu każdemu tworzenia własnych scenariuszy w Simrail. (https://wiki.simrail.eu/).
Opis korzystania z frameworka można znaleźć w pliku readme scenariuszy w `Scenarios/Scenario_1/ReadMe/pl/README.md`.
Pliki readme scenariuszy można przeglądać w Simrail, ale przykłady kodu wydają się być niepoprawnie sformatowane, dlatego lepiej otworzyć plik bezpośrednio w edytorze.

 

 

ScenarioFramework-0.1.0.zip

Edited 16 hours ago by lars.oj.lindner