Getting started

If you already know how to C++ and are very good at it, you should be able to compile the code that can be found in the Tramway SDK repository.

This article will cover the usage of the framework for beginners who are either scared of C++ or just bad at it. I tried to create the LUA scripting API in a way that is very close to the underlying C++ API, so after you overcome your fear of C++ or get better at it, you should be able to switch to it rather easily.

Before starting, evaluate yourself and make sure that you possess the following qualities:

• Good computer skills;
• Decent programming skills;
• Basic maths;
• Knowledge of game engine concepts.

If you do not meet these requirements, consider visiting your local public library, signing up for computer literacy courses or finishing your secondary education (if applicable).

Setting up your workspace

Before beginning, it would be worthwhile to set up your virtual workspace. My personal preference is to dump everything into a directory located on my Desktop on Windows or in my home directory on Linux.

Decide where you will put your workspace directory and create it. Name it something descriptive, like tramsdk, projects, my_games or IMPORTANT. Customize the icon. Add a shortcut to your start menu or a start menu equivalent.

Next up, you will need to acquire the framework source code. Even if you use pre-built binaries, the source code repository contains many useful Python scripts.

Download the repository, either as a .zip file from the Github web interface, or clone it through the git program. After that, download the template repository, just like you downloaded the main framework repository.

Creating your first app.

Copy the directory and name it something descriptive, like my-app. You will probably do this every time you create a new app using the framework. Navigate into this directory.

If you're using Windows, then the template repository already contained binaries for you. On Linux, you should take a look at the contents of the maketool.ini file. Try running maketool.py found in the devtools directory of the main framework repository, while having this directory as the working directory. If you are using Linux, then you're probably very clever, you should be able to figure this out.

The executable of the app is named template.exe, you might want to rename it. Double-click on it or run it through command line and a window with a teapot should appear. You can rotate the teapot by pressing the arrow keys on your keyboard.

This is what you should be seeing.

If a window does not appear, check if your monitor is plugged in and turned on. Many users make this simple mistake.