https://github.com/angeloanan/bmap-server

🗾 | External Web Server for BlueMap
https://github.com/angeloanan/bmap-server

bluemap minecraft minecraft-bluemap minecraft-plugin minecraft-server

Last synced: about 1 year ago
JSON representation

🗾 | External Web Server for BlueMap

• Host: GitHub
• URL: https://github.com/angeloanan/bmap-server
• Owner: angeloanan
• License: gpl-3.0
• Created: 2024-04-10T20:57:49.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2025-03-10T06:27:02.000Z (over 1 year ago)
• Last Synced: 2025-05-12T21:13:00.811Z (about 1 year ago)
• Topics: bluemap, minecraft, minecraft-bluemap, minecraft-plugin, minecraft-server
• Language: Rust
• Homepage:
• Size: 95.7 KB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
[![wakatime](https://wakatime.com/badge/github/angeloanan/bmap-server.svg)](https://wakatime.com/badge/github/angeloanan/bmap-server)

# BlueMap Server

A simple external web server for [BlueMap](https://bluemap.bluecolored.de/).

The motivation of this project is to provide a simple but robust solution on serving BlueMap's live data to multiple clients.

## Usage

Download the latest release from the [releases page](https://github.com/angeloanan/bmap-server/releases).

Allow the app to be runnable by `chmod +x bmap-server`.

Run the app with the path to your BlueMap data directory as an argument:

```sh

$ ./bmap-server /path/to/bluemap/data

```

You can also use the `--help` flag to get a list of all available options:

```

$ bmap-server --help

Usage: bmap-server [OPTIONS] 

Arguments:

    Path to Bluemap's data directory

Options:

      --host                   Host to listen [default: 0.0.0.0]

  -p, --port                   Port to listen [default: 31283]

      --bluemap-host   Bluemap's Live Server host [default: 127.0.0.1]

      --bluemap-port   Bluemap's Live Server port [default: 8100]

      --tls-cert           TLS certificate file - If not provided, server will run without TLS

      --tls-key             TLS key file - If not provided, server will run without TLS

  -h, --help                         Print help

  -V, --version                      Print version

```

## Building

This project uses [Rust](https://www.rust-lang.org/) and [Cargo](https://doc.rust-lang.org/cargo/).

You do not need to have OpenSSL installed to build the project as the project uses the [rustls](https://github.com/rustls/rustls) crate to provide TLS support.

To build the project, clone the repository and run `cargo build`.

## Contributing

Contributions are welcome, though not expected and not guaranteed to be merged; this is a personal project after all.

Feel free to fork and adapt this project to your needs.