Git Product home page Git Product logo

mcmapper's Introduction

mcmapper

A minecraft mapping experiment written in compose multiplatform. It reads minecraft player-created maps and joins them together into a mosaic which is viewable in a browser. A Nether subway route overlay can be shown as well, if route and stop data has been configured.

Prebuild development snapshots of the backend tool and web client are available. There is also a desktop client and an android client.

To build the backend tool

Run ./gradlew shadowJar and copy mcmapper-backend.jar and your backend JSON configs to your minecraft server. Look in the example-backend-config/ directory for an example config.

To build the webapp

Run ./gradlew jsBrowserWebpack then copy the contents of the js/ directory to your web root.

To use the webapp

To use the webapp you will need to periodically run the backend tool on the minecraft server. It will read your minecraft maps and write the resulting JSON and PNG data into the web root. If your web root is, for example, /var/www/html/ then you might want to copy the webapp into /var/www/html/mc/ and the map data into /var/www/html/mc/data/

java -jar mcmapper-backend.jar convert-map /path/to/my/worlds.json /var/www/html/mc/data/

To develop the webapp

Copy client/webpack.config.d/proxy.js.example to client/webpack.config.d/proxy.js and edit the proxy url to point to the data directory on the webserver where mcmapper-backend.jar runs. Run ./gradlew jsBrowserDevelopmentRun to build.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.