OpenMiner (Fork)
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 9c5f1b9374 [CelestialObject] Fixed rendering on Windows and Debian, maybe. (see #159) 3 weeks ago
docs [mods/default] 'Torch' added. 3 weeks ago
external [CelestialObject] Fixed rendering on Windows and Debian, maybe. (see #159) 3 weeks ago
misc [misc/deploy.sh] Now including pre-generated HTML docs. 3 weeks ago
mods Small fixes. 3 weeks ago
resources [ChunkBuilder] Don't apply AO on light sources. 3 weeks ago
source [CelestialObject] Fixed rendering on Windows and Debian, maybe. (see #159) 3 weeks ago
tests [tests] CxxTest-based unit tests added. 1 month ago
texturepacks/minecraft [mods/default] 'Torch' added. 3 weeks ago
.codedocs [.codedocs] Small fix. 2 months ago
.gitignore [GameState] Now possible to take a screenshot by pressing F2 in-game. 1 month ago
.gitmodules Fixed Windows build. 4 weeks ago
.travis.yml Fixed Windows build. 4 weeks ago
.zappr.yaml [.zappr.yaml] Added. 1 month ago
CMakeLists.txt Fixed Windows build. 4 weeks ago
CONTRIBUTING.md [docs] 'item', 'recipe', 'sky', 'tree', 'biome', 'dimension' documentation added. 5 months ago
CONTRIBUTORS.md Style and small C++ mistakes fixed. 5 months ago
LICENSE Small fixes. 1 year ago
Notes [TODO] Removed. [Notes] Updated. 5 months ago
README.md [ChunkBuilder] Don't apply AO on light sources. 3 weeks ago
mkdocs.yml [docs/network-protocol.md] Added. 1 month ago
requirements.txt [docs/network-protocol.md] Added. 1 month ago
screenshot1.png [screenshot1] Updated. 5 months ago
screenshot2.png [screenshots] Updated. 1 year ago
screenshot3.png [screenshot3] Updated. 5 months ago
screenshot4.png [screenshots] Updated. 5 months ago
screenshot5.png [TerrainGenerator] Portals added. 5 months ago
screenshot6.png [docs] Small fixes. [screenshots] screenshot6 (nether) added. 5 months ago

README.md

OpenMiner

Build Status Documentation Status 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

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 complete.

See also the roadmap for 1.0.0 here.

Implemented features

  • Menus (title screen, world selection, settings, etc...)
  • Basic worldgen (biomes, lakes, trees, flowers, pseudo-caves)
  • Pseudo-infinite world in X/Y/Z axis (2^32 * 2^32 * 2^32 blocks) (#25)
  • Smooth lighting + ambient occlusion
  • Client/server architecture (#20)
  • Chat with support for commands (for example /tp) (#57)
  • Lua modding API
    • Block/item/recipe/biome/tree/sky/dimension/entity definition
    • Custom GUI creation
  • Blocks can have an inventory and update every server tick (workbench, furnace)
  • Block metadata
  • Player model display (without animation)
  • Dimensions (like the Nether or the Ender in Minecraft) (#80)
  • World loading/saving (see #26)
  • Texture pack system (partially implemented, see #34)
  • Entities (#90)
  • Day/night cycle with sun/moon/stars (#154)

Missing features

  • Fluid propagation (#62)
  • Seed-based worldgen (#116)
  • Cave tunnels (#118)
  • Clouds (#156)
  • Particle system (#155)

Screenshots

Credits

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