Giter Site home page Giter Site logo

rkben / minecraft-overviewer Goto Github PK

View Code? Open in Web Editor NEW

This project forked from overviewer/minecraft-overviewer

0.0 0.0 0.0 11.73 MB

Render high-resolution maps of a Minecraft world with a Leaflet powered interface

Home Page: https://overviewer.org/

License: GNU General Public License v3.0

JavaScript 3.65% Python 72.62% C 21.96% CSS 1.67% HTML 0.10%

minecraft-overviewer's Introduction

Minecraft Overviewer Build Status

By Andrew Brown and contributors (see CONTRIBUTORS.rst).

Documentation:

http://docs.overviewer.org

Github code repository:

https://github.com/overviewer/Minecraft-Overviewer

Travis-CI:

https://travis-ci.org/overviewer/Minecraft-Overviewer

Blog:

https://overviewer.org/blog/

PLEASE NOTE: Overviewer is currently unmaintained. PRs will not be merged and issues will not be addressed. The website and repository will remain online and accessible.

The Minecraft Overviewer is a command-line tool for rendering high-resolution maps of Minecraft worlds. It generates a set of static html and image files and uses Leaflet to display a nice interactive map.

The Overviewer has been in active development for several years and has many features, including day and night lighting, cave rendering, mineral overlays, and many plugins for even more features! It is written mostly in Python with critical sections in C as an extension module.

Getting Started

All documentation has been consolidated at our documentation site. For information on downloading, compiling, installing, and running The Overviewer, visit the docs site.

http://docs.overviewer.org

A few helpful tips are below, but everyone is going to want to visit the documentation site for the most up-to-date and complete set of instructions!

Alternatively, the docs are also in the docs/ directory of the source download. Look in there if you can't access the docs site.

Examples

See examples of The Overviewer in action!

https://github.com/overviewer/Minecraft-Overviewer/wiki/Map-examples

Disclaimers

Before you dive into using this, just be aware that, for large maps, there is a lot of data to parse through and process. If your world is very large, expect the initial render to take at least an hour, possibly more. (Since Minecraft maps are practically infinite, the maximum time this could take is also infinite!)

If you press ctrl-C, it will stop. The next run will pick up where it left off.

Once your initial render is done, subsequent renderings will be MUCH faster due to all the caching that happens behind the scenes. Just use the same output directory and it will only update the tiles it needs to.

There are probably some other minor glitches along the way, hopefully they will be fixed soon. See the Bugs section below.

Viewing the Results

Within the output directory you will find two things: an index.html file, and a directory hierarchy full of images. To view your world, simply open index.html in a web browser.

You can throw these files up to a web server to let others view your map.

Bedrock and other formats

Minecraft Overviewer only supports the world format from the Java edition of Minecraft. Minecraft Bedrock (the Windows 10 version) is not supported by Overviewer, but users have reported success using Amulet to convert Bedrock worlds to the Java format, and then used Overviewer to render the converted worlds.

Bugs

For a current list of issues, visit https://github.com/overviewer/Minecraft-Overviewer/issues

Feel free to comment on issues, report new issues, and vote on issues that are important to you.

minecraft-overviewer's People

Contributors

agrif avatar aheadley avatar alexjurkiewicz avatar astraluma avatar auron956 avatar brownan avatar buscher avatar contre avatar counterpillow avatar eanmclaughlin avatar eminence avatar fabiann avatar gmcnew avatar greatmastermario avatar gshort avatar incredibleholg avatar interfect avatar ion1 avatar joe-mojo avatar jonnyjd avatar lother avatar masterofjokers avatar pibm avatar pironic avatar redsparr0w avatar rmccue avatar rmrector avatar steadbytes avatar tswsl1989 avatar wunkolo avatar

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.