OpenMiner/README.md

OpenMiner

• Project goal
• Wiki
• Keys
• How to compile
  • Using Linux
  • Using Windows
  • Using MacOS
• Discussion
• Project status
• Screenshots
• Credits

Project goal

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

Wiki

• Getting started
  • Contributing
  • Coding style
• Lua API
  • Core API
  • Mod API
    • Block
    • Item
    • Recipe
    • Sky
    • Tree
    • Biome
    • Dimension
  • GUI API
    • Crafting widget
    • Image
    • Inventory data
    • Inventory widget
    • Progress bar
    • Scroll bar
  • C++ classes in Lua
• Network Protocol

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++17 support (GCC >= 7.0 or clang >= 5.0)
  • CMake (>= 3.12.4)
  • Lua
  • GameKit dependencies
  • Linux users: Check your distribution repositories for packages.
• Run cmake -B build . && cmake --build build -j8
• Or mkdir build && cd build && cmake .. && make -j8 && cd .. (for old CMake versions)
• Run the client with ./build/openminer
• If you want a multiplayer game, run the server with ./build/openminer_server

Using Windows

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

Using MacOS

• Dependencies (using Homebrew):
  • A compiler with C++17 support (GCC >= 7.0 or clang >= 5.0)
  • brew install cmake tinyxml2 glm
  • Optional: brew install ninja (much faster builds)
• Run cmake -B build . && cmake --build build; if you installed ninja above, add -GNinja before -B in the previous command.
• Run the client with ./build/openminer
• If you want a multiplayer game, run the server with ./build/openminer_server

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/biome/tree/sky/dimension 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)
• World loading/saving (using /save <name> and /load <name> commands, see #26)
• Texture pack system (partially implemented, see #34)
• Entities (block drops, mobs, etc...) (#90)

Missing features

• Fluid propagation (#62)
• Day/night cycle with sun/moon display (#73)
• Real worldgen (seed-based, cave tunnels) (#79)
• Clouds (#52)
• Particle system

Screenshots

Credits

• xMrVizzy (Faithful 32x texture pack, will completely replace Vanilla textures)
• ThePhD (sol2)
• skypjack (EnTT)