Skip to content

Latest commit

Β 

History

203 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

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.
  • Releases are available for Android, Windows, macOS, and Linux. The hosted web app runs from the same Flutter codebase with browser-specific networking and certificate restrictions.
  • 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.

Settings β†’ Data & Sync 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

This section is for contributors and custom-build maintainers. App users should start with the user documentation; server operators should use the server setup guides.

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:

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

Admincraft version 2.0.0 and later is source-available under the PolyForm Shield License 1.0.0. See LICENSING.md for the version boundary and third-party components.

Admincraft logo Disclaimer

NOT AN OFFICIAL MINECRAFT PRODUCT. NOT APPROVED BY OR ASSOCIATED WITH MOJANG OR MICROSOFT.

Minecraft is a trademark of Mojang Synergies AB. Admincraft is an independent project with no affiliation to Mojang, Microsoft, or the maintainers of any server image it works with.

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