OpenMiner/README.md

OpenMiner

• Project goal
• Wiki
• Keys
• How to compile
• Discussion
• Project status
• Screenshots
• Previous attempts
• Credits

Project goal

The long-term goal of this project is to provide a viable alternative to Minecraft modding.

Wiki

• Getting started
• Lua API Overview

Keys

• Movement: WASD
• Inventory: E
• Creative window: H
• Chat: T
• Jump: Space
• Sprint: Ctrl
• Jetpack: X
• Exit: Escape
• Debug: F3
• Fullscreen: F11

How to compile

Using Linux

• Dependencies:
  • A compiler with C++14 support
  • CMake
  • GameKit (requires SDL2 + tinyxml2, will switch to SFML starting from 2.6)
  • SFML (only used for network)
  • Lua
  • Linux users: Check your distribution repositories for packages.
• Run cmake .
• Run make -j8
• Run the server with ./server/openminer_server
• Run the client with ./client/openminer

Using Windows

• Wiki: Compiling on Windows using CMake and MinGW-w64
• Wiki: Compiling on Windows using CMake and Visual Studio 2017

Discussion

• Discord: join server
• IRC: irc.freenode.net #openminer

Project status

This list is non exhaustive.

Implemented features

• Menus (title screen, server selection, pause menu, settings menu)
• Basic worldgen (biomes, lakes, trees, flowers, pseudo-caves)
• Infinite world in X/Y/Z axis (#25)
• Lighting system with smooth lighting
• Networking (#20)
• Chat system with support for commands (#57)
• Lua API
  • Block/item/recipe definition
  • Custom GUI creation
• Special blocks (workbench, furnace)
• Block metadata
• Player model display (currently without rotation nor animation)
• Dimensions (like the Nether or the Ender in Minecraft) (#80)

Missing features

• Texture pack system (#34)
• World loading/saving (#26)
• Fluid propagation (#62)
• Day/night cycle with sun/moon display (#73)
• Real worldgen (seed-based, cave tunnels) (#79)
• Clouds (#52)
• Particle system
• Entities (block drops, mobs, etc...)

Screenshots

Credits

• xMrVizzy (Faithful 32x texture pack, will completely replace Vanilla textures)