{"id":19215848,"url":"https://github.com/movingblocks/terasologylauncher","last_synced_at":"2025-04-12T16:37:59.577Z","repository":{"id":6976530,"uuid":"8230327","full_name":"MovingBlocks/TerasologyLauncher","owner":"MovingBlocks","description":"Terasology Launcher is the official launcher for the open source game Terasology.","archived":false,"fork":false,"pushed_at":"2024-10-08T10:14:04.000Z","size":10895,"stargazers_count":156,"open_issues_count":47,"forks_count":75,"subscribers_count":41,"default_branch":"master","last_synced_at":"2025-04-03T17:11:42.451Z","etag":null,"topics":["game","hacktoberfest","java","javafx","launcher","terasology"],"latest_commit_sha":null,"homepage":"http://terasology.org/","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MovingBlocks.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"docs/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"docs/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2013-02-16T02:40:00.000Z","updated_at":"2025-02-17T23:06:47.000Z","dependencies_parsed_at":"2023-11-24T00:20:32.265Z","dependency_job_id":"7ffd3e54-84c5-44ce-ab09-6808c0d3f3b4","html_url":"https://github.com/MovingBlocks/TerasologyLauncher","commit_stats":{"total_commits":914,"total_committers":53,"mean_commits":"17.245283018867923","dds":0.6586433260393874,"last_synced_commit":"7d0d2415d2dfef999d60e605d3b64a45120b428a"},"previous_names":[],"tags_count":36,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MovingBlocks%2FTerasologyLauncher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MovingBlocks%2FTerasologyLauncher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MovingBlocks%2FTerasologyLauncher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MovingBlocks%2FTerasologyLauncher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MovingBlocks","download_url":"https://codeload.github.com/MovingBlocks/TerasologyLauncher/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248597704,"owners_count":21130928,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["game","hacktoberfest","java","javafx","launcher","terasology"],"created_at":"2024-11-09T14:14:59.094Z","updated_at":"2025-04-12T16:37:59.544Z","avatar_url":"https://github.com/MovingBlocks.png","language":"Java","funding_links":["https://www.patreon.com/Terasology"],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\u003cimg src=\"./docs/images/logo.png\" height=400px/\u003e\u003c/\u003e\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"https://github.com/MovingBlocks/TerasologyLauncher/workflows/Push%20Validation/badge.svg\" alt=\"Build Status\"/\u003e\n    \u003ca href=\"https://github.com/MovingBlocks/TerasologyLauncher/releases/latest\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/v/release/MovingBlocks/TerasologyLauncher\" alt=\"Release\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"http://www.apache.org/licenses/LICENSE-2.0.html\"\u003e\n        \u003cimg src=\"https://img.shields.io/github/license/MovingBlocks/TerasologyLauncher\" alt=\"License\" /\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n\u003ch3 align=\"center\"\u003e\u003cb\u003e\n    \u003ca href=\"#community\"\u003eCommunity\u003c/a\u003e | \n    \u003ca href=\"#installation-\"\u003eInstallation\u003c/a\u003e | \n    \u003ca href=\"#features\"\u003eFeatures\u003c/a\u003e  |\n    \u003ca href=\"#troubleshooting\"\u003eTroubleshooting\u003c/a\u003e  |\n    \u003ca href=\"#development\"\u003eDevelopment\u003c/a\u003e  | \n    \u003ca href=\"#acknowledgements\"\u003eAcknowledgements\u003c/a\u003e  | \n    \u003ca href=\"#license-\"\u003eLicense\u003c/a\u003e \n\u003c/b\u003e\u003c/h3\u003e\n\n[_Terasology Launcher_][github terasologylauncher] is the official launcher for the open source game [Terasology][github terasology]. It 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][github movingblocks].\n\n## Community\n\nIf you want to get in contact with the **Terasology** community and the whole **MovingBlocks** team, you can easily connect with us, share your ideas, report and solve problems.\nWe are present in nearly the complete round-up of social networks. Follow/friend us wherever you want, chat with us and tell the world.\n\n\u0026nbsp;\n\n\u003cp align=\"center\"\u003e\n    \u003ca title=\"Terasology Forum\" href=\"https://forum.terasology.org\"\u003e\n        \u003cimg src=\"./src/main/resources/org/terasology/launcher/images/forum.png\" width=\"48px\"/\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\n    \u003ca title=\"Discord\" href=\"https://discord.gg/terasology\"\u003e\n        \u003cimg src=\"./src/main/resources/org/terasology/launcher/images/discord.png\" width=\"48px\"/\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\n    \u003ca title=\"Twitter\" href=\"https://twitter.com/Terasology\"\u003e\n    \u003cimg src=\"./src/main/resources/org/terasology/launcher/images/twitter.png\" width=\"48px\"/\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\n    \u003ca title=\"Facebook\" href=\"https://www.facebook.com/Terasology\"\u003e\n        \u003cimg src=\"./src/main/resources/org/terasology/launcher/images/facebook.png\" width=\"48px\"/\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\n    \u003ca title=\"Reddit\" href=\"http://www.reddit.com/r/Terasology\"\u003e\n        \u003cimg src=\"./src/main/resources/org/terasology/launcher/images/reddit.png\" width=\"48px\"/\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\n    \u003ca title=\"Youtube\" href=\"https://www.youtube.com/user/blockmaniaTV\"\u003e\n        \u003cimg src=\"./src/main/resources/org/terasology/launcher/images/youtube.png\" width=\"48px\"/\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\n    \u003ca title=\"Patreon\" href=\"https://www.patreon.com/Terasology\"\u003e\n        \u003cimg src=\"./src/main/resources/org/terasology/launcher/images/patreon.jpg\" width=\"48px\"/\u003e\n    \u003c/a\u003e\n    \u0026nbsp;\u0026nbsp;\u0026nbsp;\u0026nbsp;\n    \u003ca title=\"GitHub Issues\" href=\"https://github.com/MovingBlocks/TerasologyLauncher/issues\"\u003e\n        \u003cimg src=\"./src/main/resources/org/terasology/launcher/images/github.png\" width=\"48px\"/\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\n## Installation [![](https://img.shields.io/github/v/release/MovingBlocks/TerasologyLauncher)][latest-release]\n\n1. Download the corresponding archive for your platform from the [latest release][latest-release]\n1. Extract the archive to the path where the launcher should be installed\n1. Start _Terasology Launcher_\n\n\u003ctable align=\"center\"\u003e\n  \u003cthead align=\"left\"\u003e\u003ctr\u003e\n    \u003cth width=\"40%\"\u003eOperating System\u003c/th\u003e\n    \u003cth width=\"60%\"\u003eExecutable\u003c/th\u003e\n  \u003c/tr\u003e\u003c/thead\u003e\n  \u003ctr\u003e\n    \u003ctd width=\"40%\"\u003e\u003cb\u003eWindows\u003c/b\u003e\u003c/td\u003e\n    \u003ctd width=\"60%\"\u003e\u003ccode\u003eTerasologyLauncher.exe\u003c/code\u003e or \u003ccode\u003ebin/TerasologyLauncher.bat\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd width=\"40%\"\u003e\u003cb\u003eUnix, Linux, Mac OS X\u003c/b\u003e\u003c/td\u003e\n    \u003ctd width=\"60%\"\u003e\u003ccode\u003ebin/TerasologyLauncher\u003c/code\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n## Features\n\nThe *launcher installation directory* is the folder you extracted the launcher archive into.\nThis directory will also hold different versions of _Terasology_ that are installed via the launcher.\n\nOn first start-up, the _Terasology Launcher_ will prompt you with the selection of the _Terasology_ data directory.\nThe *data directory* is the place for configuration data and user-specific files such as key bindings and save games.\nThe suggested default is a new directory in the user's home directory.\n\n![Terasology Launcher UI](docs/images/200314_TerasologyLauncher_UI.png)\n\nThe *Terasology Launcher UI* provides functionality to download, start, and delete different game versions.\nThe game versions are grouped by the type of build they belong to:\n\n\u003ctable align=\"center\"\u003e\n  \u003cthead align=\"left\"\u003e\u003ctr\u003e\n    \u003cth width=\"40%\"\u003eBuild Type\u003c/th\u003e\n    \u003cth width=\"60%\"\u003eExplanation\u003c/th\u003e\n  \u003c/tr\u003e\u003c/thead\u003e\n  \u003ctr\u003e\n    \u003ctd width=\"40%\"\u003e\u003cb\u003eTerasology\u003c/b\u003e\u003c/td\u003e\n    \u003ctd width=\"60%\"\u003eReleased version of Terasology core game bundled with modules\u003c/td\u003e\n  \u003c/tr\u003e  \n  \u003ctr\u003e\n    \u003ctd width=\"40%\"\u003e\u003cb\u003eTerasology Lite\u003c/b\u003e\u003c/td\u003e\n    \u003ctd width=\"60%\"\u003eReleased version of Terasology core game only\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\nIn addition to this main functionality, the UI displays information about new changes of the selected game version (\"Changelog\"), launcher information concerning changes, licensing and contribution guidelines (\"About\"), and logging data for the current launcher execution.\nFurther, you have access to the social media representation of _Terasology_.\n\n![Terasology Launcher Settings UI](docs/images/200314_TerasologyLauncher_UI-settings.png)\n\nThe *settings view* enables you to open the launcher installation, game installation and data directories for quick access.\nYou can configure the memory settings for the game and even specify additional Java or game arguments as well as the logging level for the game.\nPlease note, that the \"Initial Game Memory\" and \"Maximum Game Memory\" settings only apply to the game itself.\nThe actual resource consumption may be higher due to additional resources required by the Java Virtual Machine (JVM).\n\nThe remaining settings can be used to configure the launcher.\nYou can set the launcher language and decide whether the launcher should search for updates, close when a game is started and save downloaded game package files.\n\n## Troubleshooting\n\nFind below common issues you may run into and how to resolve or work around them.\nIf you cannot find help for an issue you might be facing, please open a [GitHub Issue](https://github.com/MovingBlocks/TerasologyLauncher/issues/new) including the information available in the \"Logging\" tab.\n\n\u003cdetails closed\u003e\n\u003csummary\u003e:arrow_down: Download Issues\u003c/summary\u003e\n\u003cbr\u003e\n\nAn indication of a download issue is the download starting but at some point suddenly stopping / failing.\nFirst information about the failure can be found in the \"Logging\" tab.\nThe most common indicator you'll see there is a log message similar to \"request timed out\".\n\nDownloading Terasology via the launcher can fail for multiple reasons including:\n1. GitHub being unavailable\n2. the Terasology artifact being unavailable\n3. your internet connection being slow\n4. something on your computer or in your network slowing down the download\n\nTo check whether GitHub is available, please refer to https://www.githubstatus.com/.\n\nTo check whether the Terasology artifact is available, please go to our [Terasology release page](https://github.com/MovingBlocks/Terasology/releases) and look for the version you were trying to download.\nYou should find it at `https://github.com/MovingBlocks/Terasology/releases/tag/v\u003cversion\u003e`, for example, https://github.com/MovingBlocks/Terasology/releases/tag/v5.3.0.\nAt the bottom of the release information below the changelogs, there should be an \"Asset\" section.\nIf this section includes a `TerasologyOmega.zip` file, the Terasology artifact is available.\nIf not, please open up a [GitHub Issue](https://github.com/MovingBlocks/TerasologyLauncher/issues/new) or inform us about this on [Discord](https://discord.gg/terasology).\n\nIf the Terasology artifact and GitHub are available, but your download timed out, this is likely due to a slow internet connection or something on your computer or in your network slowing down the download.\nIn this case, you can either try to hunt down the issue yourself or try to work around the issue manually\n\n### Manual Download Timeout Workaround\n\nYou can work around the launcher's timeout logic by downloading the Terasology artifact manually.\n\nWorkaround steps:\n1. Download the desired Terasology artifact from GitHub: `https://github.com/MovingBlocks/Terasology/releases/download/v\u003cversion\u003e/TerasologyOmega.zip`\n2. Extract the artifact (zip archive)\n3. Rename the archive\u003cbr/\u003e\n   For stable releases to `terasology-omega-\u003cversion\u003e-stable.zip`, for example, `terasology-omega-5.3.0-stable.zip`\u003cbr/\u003e\n   For nightly and pre-releases to `terasology-omega-\u003cversion\u003e-nightly.zip`, for example, `terasology-omega-5.3.0-rc.2-nightly.zip`\n4. Copy the renamed archive into the `cache` directory located in the launcher managed directory\u003cbr/\u003e\n   On Windows: `C:\\Users\\AppData\\Roaming\\TerasologyLauncher\\cache`\u003cbr/\u003e\n   On Linux/Unix: `/home/\u003cuser\u003e/.terasologylauncher`\n5. Start the launcher and select the version you downloaded the artifact for, click on the download icon (:arrow_down:) and wait for the download to complete.\n   This should happen quickly as the launcher should use the already downloaded Terasology artifact from the cache.\u003cbr/\u003e\n   On completion the download icon (:arrow_down:) should turn into a play icon (:arrow_forward:)\n6. Click on the play icon (:arrow_forward:) to start Terasology\n\n\u003c/details\u003e\n\n## Development\n\nTo be able to run **TerasologyLauncher** from source follow these steps.\nThis guide is designed for [IntelliJ IDEA][intellij] (you can use the free community edition), but alternative setups are possible.\n\n\u003cdetails closed\u003e\n\u003csummary\u003e:octocat: Get Ready\u003c/summary\u003e\n\u003cbr\u003e\n\nTo contribute to this repo, please open a [pull request][github guide] from your fork of this repository.\n\nFor more information on building and developing the Terasology Launcher, make sure to read the rest of this README and [CONTRIBUTING.md][contributing].\n\n### Requirements\n\nYou'll need the following tools:\n\n- Java SE Development Kit (JDK) 11. It should be possible to use a later version of the JDK for local development, please see the definition of [push validation] for the exact CI setup.\n- Git to clone the repo and commit changes.\n\nDevelopment is possible on all common platforms (Windows, Linux, MacOS).\n\n\u003c/details\u003e\n\n\u003cdetails closed\u003e\n\u003csummary\u003e:nerd_face: Start developing\u003c/summary\u003e\n\u003cbr\u003e\n    \nFamiliarise yourself with Git's concept of repositories, branches, and commits. To get the latest changes from remote repositories you need to *fetch* all remote data via `git fetch --all`. This does not change your workspace, it just loads up your local Git database.\n\nApart from Git, basically everything can be done using the [Gradle][gradle] [wrapper][gradle wrapper]. The following list is an excerpt of some commonly used tasks.\n\n\u003ctable align=\"center\"\u003e\n  \u003cthead align=\"left\"\u003e\u003ctr\u003e\n    \u003cth width=\"50%\"\u003eCommand\u003c/th\u003e\n    \u003cth width=\"50%\"\u003e\u003ci\u003eDescription\u003c/i\u003e\u003c/th\u003e\n  \u003c/tr\u003e\u003c/thead\u003e\n  \u003ctr\u003e\n      \u003ctd width=\"50%\"\u003e\u003ccode\u003egradlew build\u003c/code\u003e\u003c/td\u003e\n      \u003ctd width=\"50%\"\u003e\u003ci\u003eCompile the source code, run tests and build a JAR.\u003c/i\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n      \u003ctd width=\"50%\"\u003e\u003ccode\u003egradlew install\u003c/code\u003e\u003c/td\u003e\n      \u003ctd width=\"50%\"\u003e\u003ci\u003eCreate a local runnable installation (placed in \u003ccode\u003e./build/install/TerasologyLauncher\u003c/code\u003e).\u003c/i\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n      \u003ctd width=\"50%\"\u003e\u003ccode\u003egradlew run\u003c/code\u003e\u003c/td\u003e\n      \u003ctd width=\"50%\"\u003e\u003ci\u003eBuild and run the launcher.\u003c/i\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n      \u003ctd width=\"50%\"\u003e\u003ccode\u003egradlew createRelease\u003c/code\u003e\u003c/td\u003e\n      \u003ctd width=\"50%\"\u003e\u003ci\u003eCreate a local development release (located in \u003ccode\u003e./build/distributions\u003c/code\u003e).\u003c/i\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n      \u003ctd width=\"50%\"\u003e\u003ccode\u003egradlew tasks\u003c/code\u003e\u003c/td\u003e\n      \u003ctd width=\"50%\"\u003e\u003ci\u003eDisplay other available build script tasks.\u003c/i\u003e\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\nAssume you have pushed some changes to your fork into a branch `myFeature`.\nIn order to let us know about your work and give us the possibility to incorporate your changes you should send us a _pull request_.\nYou can do this by selecting the `myFeature` branch on your GitHub repo and click the button which says \"Open pull request\".\n\nMore information on how to contribute can be found in [CONTRIBUTING.md][contributing].\nRemember, that all submissions must be licensed under [Apache License, Version 2.0][license].\n\n\u003c/details\u003e\n\n\u003cdetails closed\u003e\n\u003csummary\u003e:flags: Translation\u003c/summary\u003e\n\u003cbr\u003e\n\nIf you want to contribute by translating the Terasology Launcher to a new language or by improving an existing translation check out the [Translation Guide](./docs/i18n.md).\n\n\u003c/details\u003e\n\n\u003cdetails closed\u003e\n\u003csummary\u003e:books: Related Resources\u003c/summary\u003e\n\u003cbr\u003e\n\nTutorials and further information on Git:\n\n- http://www.vogella.de/articles/Git/article.html\n- http://gitref.org/\n- http://progit.org/\n\nDeveloper setup tutorials for our main project, [**Terasology**][github terasology]:\n\n- [Contributor Quick Start Guide](https://github.com/MovingBlocks/Terasology/wiki/Contributor-Quick-Start)\n- [Dealing with Forks](https://github.com/MovingBlocks/Terasology/wiki/Dealing-with-Forks)\n\n\u003c/details\u003e\n\n## Acknowledgements\n\n_Terasology Launcher_ is driven by its [contributors][github terasologylauncher contributors]!\n\nThis project uses\n\n- Font Awesome Icon for Webchat (`fa-comments`), CC BY 4.0 License, [Font Awesome Free License](https://fontawesome.com/license/free)\n- [Mark James' Flag Icons Pack](http://www.famfamfam.com/lab/icons/flags/)\n- [Bellsoft Liberica JDK 11](https://bell-sw.com/pages/downloads/#/java-11-lts) is bundled with the launcher\n\n## License [![](https://img.shields.io/github/license/MovingBlocks/TerasologyLauncher)][license]\n\n_Terasology Launcher_ is licensed under the [Apache License, Version 2.0][license].\n\n\u003c!-- References --\u003e\n\n[latest-release]: https://github.com/MovingBlocks/TerasologyLauncher/releases/ \"TerasologyLauncher (official releases)\"\n[license]: http://www.apache.org/licenses/LICENSE-2.0.html \"Apache License, Version 2.0\"\n[contributing]: docs/CONTRIBUTING.md \"CONTRIBUTING.md\"\n[push validation]: .github/workflows/push-validation.yml\n\n[github movingblocks]: https://github.com/MovingBlocks/ \"MovingBlocks\"\n[github terasology]: https://github.com/MovingBlocks/Terasology/ \"Terasology\"\n[github terasologylauncher]: https://github.com/MovingBlocks/TerasologyLauncher/ \"TerasologyLauncher\"\n[github terasologylauncher contributors]: https://github.com/MovingBlocks/TerasologyLauncher/graphs/contributors/ \"TerasologyLauncher contributors\"\n\n[gradle]: http://gradle.org \"Gradle\"\n[gradle wrapper]: http://gradle.org/docs/current/userguide/gradle_wrapper.html \"Gradle Wrapper\"\n[intellij]: http://www.jetbrains.com/idea/ \"IntelliJ IDEA\"\n\n[github guide]: https://docs.github.com/en/get-started/quickstart/contributing-to-projects \"GitHub Contributing to projects\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmovingblocks%2Fterasologylauncher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmovingblocks%2Fterasologylauncher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmovingblocks%2Fterasologylauncher/lists"}