Skip to content

Latest commit

 

History

History
40 lines (28 loc) · 2.21 KB

README.md

File metadata and controls

40 lines (28 loc) · 2.21 KB

tokTales Engine - Templates

Contains template projects for getting started with tokTales Engine.

Projects

Project Name Description Build
tokTales-template-default The default template that supports all platforms. tokTales-template-default CI
tokTales-template-desktop A template with support for the Desktop platform. tokTales-template-desktop CI
tokTales-template-android A template with support for the Android platform. tokTales-template-android CI

How to Use

These templates are meant to be used as starting points from which to develop an application using this project. There are multiple templates, each for different use cases, focused mainly on the platform support they provide.

For more resources see Resource Hub.

Setup

Download a template project, replace all placeholder values with your own and start developing.

Step by step

  1. Clone or download this repository
  2. Choose template and copy project folder to target location
  3. Rename template project folder to target project name
  4. Rename Java packages to target project package names
  5. Android: Set value of package in AndroidManifest.xml to target application package
  6. Android: Set value of applicationId in Android build.gradle to target application id
  7. Desktop: Adjust value of mainClassName in Desktop build.gradle, if necessary

Optional

  • Android: Set app display name
    Replace the value of the app_name resource entry in res/values/strings.xml.
  • Set root project name explicitly
    Add line rootProject.name='<projectname>' to settings.gradle.
  • Prefix subproject names with target project name (e.g. desktop becomes <projectname>-desktop)
    Rename subproject folders and replace names in settings.gradle and build.gradle files.