scrik / terasologylauncher

Terasology Launcher is the official launcher for the open source game Terasology.

Terasology Launcher - ReadMe

Terasology Launcher is the official launcher for the open source game Terasology.

The Terasology Launcher provides easy access to the different game versions and build types.

Terasology and related projects are developed by a group of software enthusiast volunteers under the organization name MovingBlocks.

Usage

Terasology Launcher requires Java 8 and JavaFX. If you are using OpenJDK make sure you have the JavaFX runtime libraries installed, e.g., through an extra package often named openjfx (Ubuntu) or java-openjfx (ArchLinux).

1. Download and extract the ZIP file
   • official releases (recommended)
   • latest release ZIP
   • latest develop ZIP (only for testing)
2. Start Terasology Launcher
   • TerasologyLauncher.exe (Windows)
   • bin/TerasologyLauncher.bat (Windows)
   • bin/TerasologyLauncher (Unix, Linux, Mac OS X)
   • lib/TerasologyLauncher.jar (Java)
3. Use Terasology Launcher to download, config and start Terasology

License

Terasology Launcher is licensed under the Apache License, Version 2.0.

Building/Developing

Terasology Launcher uses a Gradle-based build system and provides a wrapper. It is a script which is called from the root of the source tree. It downloads and installs Gradle automatically. Depending on the system it may be necessary to call "./gradlew" instead of "gradlew".

gradlew build

Compile the source code, run tests and build a jar

gradlew install

Create a runnable installation (./build/install/TerasologyLauncher/)

gradlew run

Build and run

gradlew createRelease

Create a local development release (./build/distributions/)

gradlew tasks

Display available tasks

gradlew idea

Generate IntelliJ IDEA project files

Contributing

Please use GitHub or the forums (english or german) for contact, questions, feature suggestions, contributions and bug reports.

We welcome contributions, especially through pull requests on GitHub. Submissions must be licensed under the Apache License, Version 2.0.

See also CONTRIBUTING.md.

Contributors

Overview of contributors

• MrBarsack @MrBarsack
• Tobias Nett @skaldarnar
• Mathias Kalb @mkalb
• Rasmus Praestholm @Cervator
• Ian Macalinao @simplyianm
• Immortius @immortius
• Aldo Borrero @aldoborrero
• Martin Steiger @msteiger
• Anthony Kireev @small-jeeper
• Piotr Halama @Halamix2
• Many users of the german forum (ideas, testing, suggestions, bug reports)