Mineflake

NixOS flake for easy declarative creation of minecraft server containers.

Examples

Docker container with a Paper and AuthMe

{ pkgs, ... }:

with pkgs; mineflake.buildMineflakeContainer {
  package = mineflake.paper;
  command = "${jre_headless}/bin/java -Xms1G -Xmx1G -jar {} nogui";
  plugins = with mineflake; [ luckperms ];
  configs = [
    (mineflake.mkMfConfig "mergeyaml" "plugins/LuckPerms/config.yml" {
      server = "vanilla_1";
    })
  ];
}

Installation

Install Nix:

bash <(curl -L https://nixos.org/nix/install)

Install Cachix and add the mineflake cache to speed up builds (optional):

nix-env -iA cachix -f https://cachix.org/api/v1/install
cachix use nix-community

Initialize the flake:

nix flake init --template github:nix-community/mineflake

Contributing

You can read the contributing guide for more information.

License

This project is licensed under the MIT License. See the LICENSE file for details.

In short, you can do whatever you want with this project. You must include the license file with your distribution, but you don't have to include the source code. But if you include a link to the original project, the author will be immensely pleased.

In addition, this project uses the following third-party software:

• nixpkgs - Licensed under the MIT. Used as a package repository.
• rust-overlay - Licensed under the MIT. Used to set up the Rust toolchain in developer environment.
• import-cargo - No license. Used to build Mineflake CLI.
• flake-utils - Licensed under the MIT. Simplifies the creation of flake outputs.

Contributors

If you contribute to this project, please add your name to the list below.

• cofob - Author and maintainer.
• IogaMaster - Crafted logo.

Sponsors and sponsorship

If you want to support this project author directly, you can donate with cryptocurrency:

• Tron: TH2DAzhpe82TmwnhdtgDsyExTT1BBgpkyD
• Monero: 8B33vTVddZFitR33QY3bWe2tq4Q7o1ajdAz4wx831kr9e13fXTC14ur6caPYXm5fnijjsZ1aXvGvMFx2B1YgowWHJbfgcxQ
• Bitcoin: bc1qcqqh02ctvq5z2v5ksv9rc0fza4gpr3pqy3uhdf
• Ethereum: 0xB2c854EBC480FB7cE9Be5f0dcD63F897ca49961b

Please notify the author about your donation by sending a message to the telegram @cofob or by email cofob@riseup.net and your name will be added to the list of sponsors.