Skip to content

This is a free open-source plugin for Godot Engine 4.x designed for convenient creation and use of "railways" in 2D space.

License

Notifications You must be signed in to change notification settings

Miskler/Train-API

Repository files navigation

Train-API

Это бесплатный open-source плагин для Godot Engine 4.x предназначенный для удобного создания и использования "железных дорог" в 2D пространстве.

This is a free open-source plugin for Godot Engine 4.x designed for convenient creation and use of "railways" in 2D space.

Архитектурная основа / Architectural basis

Этот плагин предоставляет базовые инструменты для создания, редактирования, настройки дорог в вашем проекте и его использования. Плагин предоставляет только логику движения, скорость и различную информацию о составе. Остальное вы должны сделать сами подключив скрипты с логикой заточенной под ваш проект (действуют как расширители существующего кода).

This plugin provides basic tools for creating, editing, configuring roads in your project and using it. The plugin provides only the logic of movement, speed and various information about the composition. The rest you have to do yourself by connecting scripts with logic tailored to your project (act as extenders of existing code).

Документация / Documentation

На данный момент документация выполнена при помощи возможностей движка. Планируется продублировать документация на веб сайт.

At the moment, the documentation is done using the capabilities of the engine (only on Russian). It is planned to duplicate the documentation on the website.

Контакты / Contacts

Telegram

Discord

YouTube

Дорожная карта / Road map

🟢 1. Базовая логика движения состава. / The basic logic of the train movement.

🟢 2. Базовый интерфейс для удобного редактирования. / Basic interface for easy editing.

🟢 3. Логирование. / Logging.

🔴 4. Функция "подмагничивания" концов дорог рядом. / The function of "magnetizing" the ends of roads nearby.

❗ Советую использовать попиксельную привязку. / I advise to use pixel-by-pixel binding.

🟢 5. Поддержка произвольной длины вагона. / Support for arbitrary car length.

🟢 6. Система возвращения на исходную ветку при обратном движении во время незаконченного поворота. / The system of returning to the original branch during the reverse movement during an unfinished turn.

🛠️ 7. Система "колизии" вагонов друг с другом.

🟡 8. Система следования вагонов друг за другом (сцепка/расцепка). / The system of cars following each other (coupling/uncoupling)

🟡 9. Функция отключения логирования. / The function of disabling logging.

🟡 10. Работа над API (множество сигналов, переменные-переключатели логики) для лучшей работы. / Working on the API (lots of signals, logic switch variables) for better performance.

🟡 11. Отладка. / Debugging.

🟡 12. Документирование. / Documentation.

🟢 13. Перевод плагина на английский. / Translation of the plugin into English.

🟡 14. Серия обучающих видео на ютуб по работе с плагином. / A series of tutorial videos on YouTube on working with the plugin.

🟡 15. Стадия пассивной поддержки. / The stage of passive support.