Skip to content

Repository files navigation

Admincraft logo

Admincraft

Multiplatform app to control Minecraft Bedrock and Java servers, built with Flutter.

Admincraft WebSocket badge Minecraft badge Flutter badge Open issues PRs welcome! Build Documentation

Admincraft Mockup made with https://previewed.app/

Admincraft logo What is Admincraft?

Admincraft is a multiplatform app for managing Minecraft Bedrock and Java Edition servers. The Admincraft WebSocket bridge uses the Bedrock Docker console or Java RCON internally, while the app keeps the same secure WebSocket connection on every platform. It provides an intuitive GUI for issuing commands, performing server maintenance, and monitoring server logs.

Open Admincraft Web · Read the documentation

Current project status

  • Bedrock is optimized for docker-minecraft-bedrock-server; Java is optimized for docker-minecraft-server.
  • Development is focused on Android and Windows; other platforms may be unstable.
  • Runs in the browser too (flutter run -d chrome), with two limitations the browser imposes: self-signed certificates cannot be loaded, because the browser validates TLS itself and exposes no way to add a trust anchor, and a page served over HTTPS cannot open an unencrypted ws:// connection, so the Private network option only works when the app itself is served over http:// (such as a local build).

Admincraft logo Getting Started

You need a Minecraft server and Admincraft WebSocket. Visit the documentation for installation, connection, backup, and troubleshooting guides. Use the Bedrock setup guide or the Java setup guide.

Once you have your server ready, download Admincraft for your platform, add your server in the app, and you're good to go!

In the app settings, pick the Connection Security option matching your setup: Private network for Tailscale, a VPN or a LAN, Public certificate for a server with a publicly trusted certificate, and Self-signed certificate to load your own. The server setup guide walks through each one.

The Backup & Transfer section can copy/paste or export/import all saved server profiles. Transfers include server secret keys, so Admincraft always encrypts them with a passphrase you choose.

Admincraft logo Development

Build Android APK

Build Windows Executable

Build Web and Documentation

  • Install the documentation dependencies with python -m pip install -r requirements-docs.txt.
  • Run flutter build web --release --wasm --base-href /admincraft/.
  • Run python -m mkdocs build --strict --site-dir build/web/docs.
  • The combined GitHub Pages site will be available under build/web, with documentation in build/web/docs.

Pushes to main automatically test, build, and deploy both through the Deploy web app and docs workflow. In the repository's Pages settings, the source must be set to GitHub Actions.

Automatic Builds

Admincraft uses GitHub Actions to automate building and releasing the app. New releases are triggered by running the "Bump Version & Release" workflow from the GitHub Actions tab. This will automatically start the build and release process. The process consists of two workflows:

  • Bump Version & Release (.github/workflows/bump-version-and-release.yml): This workflow bumps the version in pubspec.yaml, commits the change, and creates a new tag. It can be triggered manually and supports major, minor, or patch version increments.
  • Build and Release (.github/workflows/build-and-release.yml): This workflow is triggered manually or automatically after the completion of the "Bump Version & Release" workflow. It builds the app for Android and Windows, names the artifacts with the version, and uploads them to the GitHub Releases page as downloadable files.

Admincraft logo Feature Roadmap

You can view the planned, started, and completed features in GitHub Projects.

Admincraft logo Community & Contributions

The community and team are available in GitHub Discussions, where you can ask for support, discuss the roadmap, and share ideas.

Our Contribution Guide describes how to contribute to the codebase and documentation.

Admincraft logo Credits

  • Item icons from mcicons by @themuhamed, used under the MIT License.

Docker tools

Fonts

Admincraft logo License

Licensed under the GPLv3 License.

About

📱 Multiplatform app to control Minecraft servers, built with Flutter.

Topics

Resources

Contributing

Stars

18 stars

Watchers

1 watching

Forks

Releases

Used by

Contributors

Languages