You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Quentin Bazin e104e6fc0d [CMake] Now handling target link dependencies. 2 days ago
config [config] Folder created for client/server config files. 2 weeks ago
docs [Dimension] 'gravity' field added to change gravity per-dimension. 2 days ago
external [CMake] Now handling target link dependencies. 2 days ago
misc Headers updated and CONTRIBUTORS file added. 3 months ago
mods [Dimension] 'gravity' field added to change gravity per-dimension. 2 days ago
resources [KeyboardHandler] Added. Keys are now saved to config/keys.lua on client exit. 1 week ago
source [CMake] Now handling target link dependencies. 2 days ago
texturepacks/minecraft Door block added. 1 month ago
.codedocs [.codedocs] Small fix. 2 days ago
.gitignore [KeyboardHandler] Added. Keys are now saved to config/keys.lua on client exit. 1 week ago
.gitmodules All dependencies are now included as submodules. Fixes #101. 2 days ago
.travis.yml [.travis.yml] Updated. 2 days ago
CMakeLists.txt [CMakeLists.txt] Improved 'sol2' integration. 2 days ago
CONTRIBUTING.md [docs] 'item', 'recipe', 'sky', 'tree', 'biome', 'dimension' documentation added. 2 months ago
CONTRIBUTORS.md Style and small C++ mistakes fixed. 2 months ago
LICENSE Small fixes. 1 year ago
Notes [TODO] Removed. [Notes] Updated. 2 months ago
README.md [README.md] Updated. 2 days ago
mkdocs.yml Documentation added for entity API. 4 days ago
requirements.txt [docs] MkDocs-based documentation for ReadTheDocs. 2 months ago
screenshot1.png [screenshot1] Updated. 3 months ago
screenshot2.png [screenshots] Updated. 1 year ago
screenshot3.png [screenshot3] Updated. 2 months ago
screenshot4.png [screenshots] Updated. 3 months ago
screenshot5.png [TerrainGenerator] Portals added. 2 months ago
screenshot6.png [docs] Small fixes. [screenshots] screenshot6 (nether) added. 2 months ago

README.md

OpenMiner

Build Status Documentation Status Documentation License Discord Donate

Project goal

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

Wiki

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 Windows

Using Linux

  • Dependencies:
    • A compiler with C++17 support (GCC >= 7.0 or clang >= 5.0)
    • git and CMake (>= 3.12.4)
    • 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 MacOS

  • Dependencies:
    • A compiler with C++17 support (GCC >= 7.0 or clang >= 5.0)
    • git and CMake (>= 3.12.4)
    • Optional: ninja (much faster builds)
    • Check Homebrew for packages.
  • 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, settings)
  • Basic worldgen (biomes, lakes, trees, flowers, pseudo-caves)
  • Infinite world in X/Y/Z axis (#25)
  • Smooth lighting
  • Networking (#20)
  • Chat system with support for commands (#57)
  • Lua API
    • Block/item/recipe/biome/tree/sky/dimension/entity 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 (#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)