{"id":18436099,"url":"https://github.com/lanternpowered/terre","last_synced_at":"2025-04-07T20:32:37.236Z","repository":{"id":95663477,"uuid":"230156955","full_name":"LanternPowered/Terre","owner":"LanternPowered","description":"A proxy server for Terraria which adds support for cross-platform, multi-world and more.","archived":false,"fork":false,"pushed_at":"2024-08-19T17:07:20.000Z","size":844,"stargazers_count":19,"open_issues_count":3,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-08-19T20:16:56.830Z","etag":null,"topics":["desktop","mobile","multi-world","proxy","terraria"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LanternPowered.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"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":"2019-12-25T21:45:56.000Z","updated_at":"2024-08-19T17:07:23.000Z","dependencies_parsed_at":"2023-04-27T11:01:31.262Z","dependency_job_id":"ba4fa8cb-2ffc-4345-947e-87e539f23856","html_url":"https://github.com/LanternPowered/Terre","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LanternPowered%2FTerre","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LanternPowered%2FTerre/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LanternPowered%2FTerre/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LanternPowered%2FTerre/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LanternPowered","download_url":"https://codeload.github.com/LanternPowered/Terre/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223291629,"owners_count":17120965,"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":["desktop","mobile","multi-world","proxy","terraria"],"created_at":"2024-11-06T06:10:19.875Z","updated_at":"2024-11-06T06:10:20.691Z","avatar_url":"https://github.com/LanternPowered.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Terre [![Discord](https://img.shields.io/badge/chat-on%20discord-6E85CF.svg)](https://discord.gg/ArSrsuU)\n\nTerre is a Terraria proxy which aims to bring support for multi world and cross-platform play \nbetween mobile and desktop clients. It is possible to customize the proxy to your liking by \ninstalling plugins or even develop your own.\n\n* [Source]\n* [Issues]\n* [Discussions]\n* [Wiki]\n* [Docker Images]\n* [Helm Charts]\n\n**The proxy is still is a work in progress, bugs are to be expected. There is a getting started \npage on the [wiki] and downloads are available as\n[packages](https://github.com/orgs/LanternPowered/packages?repo_name=Terre).**\n \nThe following list gives an overview of each subproject in this repository.\n\n* **proxy** - The actual proxy server.\n* **image** - A docker image build containing the proxy and all the official plugins.\n* **standalone** - Packs terre and all its dependencies into a single jar.\n* **test** - A test environment which can be used in the IDE, which will include plugins from the \n  repository.\n* **portals** - A plugin that makes it possible to create portals to teleport between servers \n  (worlds).\n* **characters** - A plugin that allows configuration of character storages. As alternative to \n  client side characters. **WIP, is currently only used to test server side character \n  compatibility, no data is currently saved.**\n* **k8s-server-finder** A plugin that discovers Terraria servers on a kubernetes cluster and \n  automatically registers them.\n* **tshock-users** A plugin that hooks into the tShock user system to provide permission support\n  on the proxy. Also improves server side character support when sharing characters between backing \n  servers. Requires that the tShock backing servers and this plugin are connected to the same\n  MySQL database. The plugin only reads data from this database. **WIP, can be unstable, not all \n  login scenarios are tested.**\n\nIf you are looking for some more information, or you like to help out, feel free to hop on our \ndiscord server. You will find the button at the top.\n\n## Prerequisites\n* [Java 17] or newer, JDK 17 for development\n* [Docker Desktop] when building and testing the docker images locally\n\n## Clone\nThe following steps will ensure the project is cloned properly.\n1. `git clone https://github.com/LanternPowered/Terre.git`\n2. `cd Terre`\n\n## Building\n__Note:__ If you do not have [Gradle] installed then use `./gradlew` for Unix systems or Git Bash and \n`gradlew.bat` for Windows systems in place of any `gradle` command.\n\nIn order to build Terre you can use the following `gradle` commands.\n\n### Standalone\nBuild the standalone jar, which can be found in `./standalone/build/libs` after running the \nfollowing command. The jar is labeled similarly to `terre-standalone-x.x.x-SNAPSHOT.jar`.\n```\ngradle build\n```\nThis also builds portals and the other plugins, the jar of these plugins can for example be \nfound in `./portals/build/libs` and are labeled similarly to `terre-portals-x.x.x-SNAPSHOT.jar`. \nThese plugin jars can be put into the plugins directory of Terre to enable extra functionality.\n\n### Docker image\nBuild the docker image and publish it to the local docker daemon with the \n`cybermaxke/terre:latest` tag. The docker images contains all the official plugins by default, \nwhich can be disabled through the config.\n```\ngradle jibDockerBuild\n```\n\n[Source]: https://github.com/LanternPowered/Terre\n[Issues]: https://github.com/LanternPowered/Terre/issues\n[Discussions]: https://github.com/LanternPowered/Terre/discussions\n[Wiki]: https://github.com/LanternPowered/Terre/wiki\n[Docker Images]: https://hub.docker.com/r/cybermaxke/terre\n[Java 17]: https://www.oracle.com/java/technologies/javase/jdk17-archive-downloads.html\n[Docker Desktop]: https://www.docker.com/products/docker-desktop\n[Helm Charts]: https://github.com/Cybermaxke/terraria-helm-charts\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flanternpowered%2Fterre","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flanternpowered%2Fterre","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flanternpowered%2Fterre/lists"}