{"id":28906360,"url":"https://github.com/architects-land/minecraft-scaleway-frontend","last_synced_at":"2025-07-20T04:36:31.838Z","repository":{"id":300067881,"uuid":"1005064235","full_name":"architects-land/minecraft-scaleway-frontend","owner":"architects-land","description":"Fake Minecraft Server used as a frontend to hourly paid Scaleway servers","archived":false,"fork":false,"pushed_at":"2025-07-09T15:57:43.000Z","size":230,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-07-09T16:52:24.151Z","etag":null,"topics":["minecraft","minecraft-server","minestom","scaleway","server-management","serverless"],"latest_commit_sha":null,"homepage":"https://architects-land.github.io/minecraft-scaleway-frontend/","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/architects-land.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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,"zenodo":null}},"created_at":"2025-06-19T15:54:59.000Z","updated_at":"2025-07-09T15:56:28.000Z","dependencies_parsed_at":"2025-07-09T16:52:38.590Z","dependency_job_id":null,"html_url":"https://github.com/architects-land/minecraft-scaleway-frontend","commit_stats":null,"previous_names":["architects-land/minecraft-scaleway-frontend"],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/architects-land/minecraft-scaleway-frontend","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/architects-land%2Fminecraft-scaleway-frontend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/architects-land%2Fminecraft-scaleway-frontend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/architects-land%2Fminecraft-scaleway-frontend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/architects-land%2Fminecraft-scaleway-frontend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/architects-land","download_url":"https://codeload.github.com/architects-land/minecraft-scaleway-frontend/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/architects-land%2Fminecraft-scaleway-frontend/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266067487,"owners_count":23871356,"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":["minecraft","minecraft-server","minestom","scaleway","server-management","serverless"],"created_at":"2025-06-21T14:31:23.229Z","updated_at":"2025-07-20T04:36:31.830Z","avatar_url":"https://github.com/architects-land.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Minecraft Scaleway Frontend\n\nFake Minecraft Server used as a frontend to hourly paid Scaleway servers.\n\nIt automatically starts the server if a player is waiting.\nIf the server is started, it transfers the player to the server.\nIf the server is `stopped in place` (powered off, but still in Scaleway's hypervisor), it removes it from Scaleway's hypervisor.\n\n## Usage\n\nA complete documentation is hosted [here](https://architects-land.github.io/minecraft-scaleway-frontend/)\n\nVocabulary:\n- \"server\" for this software\n- \"instance\" for the server hosted by Scaleway (that is the product's official name)\n- \"Minecraft server\" for the Minecraft server hosted on the instance \n\nThe program requires 4 arguments to run:\n- [your API key](https://www.scaleway.com/en/docs/iam/how-to/create-api-keys/), it's a UUID\n- instance's ID (available on the instance's dashboard), it's a UUID\n- [instance's zone](https://www.scaleway.com/en/docs/instances/concepts/#availability-zone) (they call it \"Availability Zones\")\n- Minecraft's host that is used during the player's transfer; in most cases, this is the instance's IP\n\nYou can pass these optionals arguments:\n- port of the server (default: `25565`)\n- port of the Minecraft server (default: `25565`)\n- name of the server visible in the debug screen (default: `Minecraft Scaleway Frontend`)\n- whitelist (default: no whitelist), separate each user with a coma (`,`); you can use their Minecraft's username and their UUID\n- Discord Webhook's link to use when sending update (default: not connected to Discord)\n\nThe icon used if the Minecraft server is offline is `server-icon.png`.\nIt must follow [these rules](https://minecraft.wiki/w/Tutorial:Server_maintenance#Setting_the_server's_icon).\n\nLogs are in `logs/`.\n\nThe current logs are in `latest.log`.\nThis file is compressed with GZip when the program is stopped.\nIts new name is `yyyy-MM-dd HH:mm.log.gz` (program launch date).\n\n### Version\n\nEach version of the project supports only one version of Minecraft.\nThe supported version is indicated in its name.\nFor example, `1.0.0+1.21.6` supports Minecraft 1.21.6 and `1.1.0+1.21.7` supports Minecraft 1.21.7.\n\n### CLI\n```bash\njava -jar server.jar \\\n  --zone instance-zone \\\n  --instance instance-id \\\n  --api-key your-api-key \\\n  --minecraft-host ip-of-minecraft-server\n```\n\n### Docker\n\nYou can use the official Docker image `ghcr.io/architects-land/minecraft-scaleway-frontend`.\n\nTags:\n- `latest` is always the latest one\n- `main` is for the main branch\n- `v*` is for a specific tag (e.g., `v1.0.3-1.21.6`)\n\nEnvironments:\n- `ZONE` is the instance's zone\n- `INSTANCE` is the ID of the instance\n- `API_KEY` is your API key\n- `MINECRAFT_HOST` is the host of your Minecraft server\n\nTo save the logs, bind a volume to `/app/logs`.\n\nExample `docker-compose.yml`:\n```yml\nservices:\n  frontend:\n    image: ghcr.io/architects-land/minecraft-scaleway-frontend:v1.0.3-1.21.6\n    ports:\n      - 25565:25565\n    environment:\n      ZONE: fr-par-2\n      SERVER: 00000000-0000-0000-0000-000000000000\n      API_KEY: 00000000-0000-0000-0000-000000000000\n      MINECRAFT_HOST: 198.51.100.0\n    volumes:\n      - ./logs:/app/logs\n```\n\n## Technology\n\n- Minestom\n- Kotlin\n- Gradle (Kotlin DSL)\n- kotlinx-serialization-json\n- kotlinx-coroutine-core\n- Log4J 2\n- lenni0451's MCPing","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farchitects-land%2Fminecraft-scaleway-frontend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Farchitects-land%2Fminecraft-scaleway-frontend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Farchitects-land%2Fminecraft-scaleway-frontend/lists"}