vampy / stk-editor

SuperTuxKart - Track Editor

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

stk-editor

Build Status

SuperTuxKart - Track Editor.

How to use it:

BUILD

Linux

To build the editor on linux you need zlib and physfs development packages. If you use distribution based on Debian, you can install it using following command:

sudo apt-get install build-essential libxxf86vm-dev libphysfs1 libphysfs-dev \
libgl1-mesa-dev mesa-common-dev zlib1g zlib1g-dev cmake

If you have it already installed, just follow the next instructions:

  1. Change into the stk-editor directory: cd stk-editor

  2. Create the build directory and change into it: mkdir build && cd build

  3. Run cmake with default options for a RELEASE build: cmake ..

  4. (Optional) If you want a DEBUG build of the editor run: cmake .. -DCMAKE_BUILD_TYPE=Debug

  5. Compile (in this example we use 2, but if you have a machine with 4 threads/cores you could use -j4 to compile faster): make -j2

  6. Run: ./supertuxkart-editor

Windows

If you have Windows operating system, it uses static physfs and zlib libraries. You don't need to install any dependencies.

  1. Install VS 2013 (or later). The free express versions work fine. Older versions may or may not work.
  2. Download and extract the stk-editor source - either a released package or from our git/svn repositories
  3. Download cmake and install it. Start cmake-gui and select the 'stk-editor' root directory as 'Where is the source code', and a new directory 'build' under the 'stk-editor' root directory (next to lib, src, etc) as the build directory ('Where to build the binaries').
  4. Click on 'Generate'. If the build directory doesn't exist, you will be asked to create it, then asked to select your VS version. Make sure to select the right version (be aware of the easy to confuse version numbers: VS 2013 = version 12). Click on configure, then generate. This will create the directory 'build', and a VS solution in that directory.
  5. Run Visual Studio, and open the solution (.sln) file generated in the 'build' folder
  6. Right click on the 'stk-editor' project in the solution explorer, and select 'Set as StartUp Project.'
  7. (Optional) From the configuration type drop down menu, select 'Release.'
  8. Select Build->Build Solution (or press F7) to compile.

Troubleshooting

When you start the stk-editor the first time you should select the stk-assets directory. If you don't select the stk-assets directory you get the following failure message: Could not create archive for: textures

You can download the stk-assets by issusing the following command: svn checkout https://svn.code.sf.net/p/supertuxkart/code/stk-assets stk-assets

License

This software is released under the GNU General Public License (GPL) which can be found in the file LICENSE in the same directory as this file.

About

SuperTuxKart - Track Editor

License:GNU General Public License v3.0


Languages

Language:C++ 49.5%Language:C 39.6%Language:Makefile 3.2%Language:Shell 2.3%Language:Roff 1.9%Language:C# 1.1%Language:Java 0.6%Language:Objective-C++ 0.4%Language:CMake 0.3%Language:Awk 0.2%Language:Module Management System 0.1%Language:SAS 0.1%Language:M4 0.1%Language:Batchfile 0.1%Language:Ruby 0.1%Language:DIGITAL Command Language 0.1%Language:Python 0.1%Language:Assembly 0.1%Language:HTML 0.1%Language:Objective-C 0.1%Language:Perl 0.0%Language:GLSL 0.0%Language:Smalltalk 0.0%Language:HLSL 0.0%