Skip to content
This repository has been archived by the owner on Dec 21, 2023. It is now read-only.
/ aternos-api Public archive

Unofficial aternos.org API/library to start & stop servers programmatically

License

Notifications You must be signed in to change notification settings

sleeyax/aternos-api

Repository files navigation

!! NO LONGER MAINTAINED !!

DO NOT CONTACT ME ABOUT THIS PROJECT YOU WILL BE IGNORED AND LAUGHED AT

People have been reporting a lot of bans recently and at this point I lack the time and interest to continue maintaining this project as I no longer use Aternos.

If you're a developer and would like to continue this project, feel free to fork it.

If you're a user, please strongly consider exaroton instead. It's a reliable Minecraft server hosting solution for dirt cheap by the people behind Aternos and they have an official discord bot that (obviously) doesn't break TOS.


Aternos API

Unofficial aternos.org API, initially inspired by the now deprecated AternosAPI python library. Also 'bypasses' cloudflare without resorting to browser automation or other stupid hacks.

Disclaimer

This is NOT an AFK bot and never will be! Please be respectful and don't abuse an awesome free service such as Aternos. I do not take any responsibility for what you do with this solution, but I will gladly take this repository down if it results in abuse of the service.

By using this package you are automatically breaking the TOS. In other words your account could be suspended at any time. Use at your own risk.

Usage

Library

See examples (easy) or the CLI source code (advanced). See also the auto-generated pkg.go.dev reference documentation here.

CLI

This project also comes with a simple command line application to start and stop your server.

Download the binary for your operating system from releases.

OR:

Manual build & usage instructions:

$ git clone https://github.com/sleeyax/aternos-api.git
$ cd aternos-api
$ go mod download
$ go run cmd/main.go

Unfortunately the command go install github.com/sleeyax/aternos-api@latest is not supported due to a limitation in go regarding 'replace directives'.

Projects

Projects that are using this package:

Made something cool? Let me know or create a PR to add your project to this list!

License

Licensed under GNU General Public License v3.0.

TL;DR:

You may copy, distribute and modify the software as long as you track changes/dates in source files. Any modifications to or software including (via compiler) GPL-licensed code must also be made available under the GPL along with build & install instructions.