Skip to content

[About] Modules

Tokelon edited this page Mar 6, 2020 · 3 revisions

The engine is divided into modules: Core, Desktop, Android, etc.
Each module contains one or more libraries: core-library and core-test in Core, desktop-library and desktop-test in Desktop, and so on.

The modules are built as a hierarchical structure in which platform libraries have dependencies on Core libraries, but never one platform on another. Meaning that, for example, you can use the Desktop libraries without ever getting involved with Android. But you can also develop for both and put the shared code into a core library.

There are also mixed modules like Tools, that contain libraries for more than one platform.

Modules Table

Module Library Description Artifact ID
Core Platform independent functionality
core-library Core implementation tokTales-core-library
core-test Core implementation tests tokTales-core-test
Desktop Desktop platform support
desktop-library Desktop implementation tokTales-desktop-library
desktop-test Desktop implementation tests tokTales-desktop-test
Android Android platform support
android-library Android implementation tokTales-android-library
android-test Android implementation tests tokTales-android-test
Extensions High level functionality / specific implementations
extensions-core Platform independent extensions tokTales-extensions-core
extensions-desktop Desktop platform extensions tokTales-extensions-desktop
extensions-android Android platform extensions tokTales-extensions-android
extensions-core-test Core extensions tests tokTales-extensions-core-test
extensions-desktop-test Desktop extensions tests tokTales-extensions-desktop-test
extensions-android-test Android extensions tests tokTales-extensions-android-test
Tools Collections of engine independent types
tools-core Core tools tokTales-tools-core
tools-core-inject Core tools dependency injection tokTales-tools-core-inject
tools-desktop Desktop tools tokTales-tools-desktop
tools-android Android tools tokTales-tools-android
tools-assets Asset management tokTales-tools-assets
tools-script Scripting tokTales-tools-script
tools-tiled Tiled level editor support tokTales-tools-tiled
Test Integration tests
test-core Platform independent integration tests tokTales-test-core
test-desktop Desktop platform integration tests tokTales-test-desktop
test-android Android platform integration tests tokTales-test-android
Clone this wiki locally