Go to file
Quentin Bazin 292595e0fa [docs] 'item', 'recipe', 'sky', 'tree', 'biome', 'dimension' documentation added. 2020-03-12 13:36:54 +01:00
client Fixed crash related to singleplayer games. (see #75) 2020-03-12 00:06:45 +01:00
cmake [CMakeLists.txt] Now allows compiling on Windows. 2020-01-22 14:18:31 +09:00
common Fixed crash related to singleplayer games. (see #75) 2020-03-12 00:06:45 +01:00
docs [docs] 'item', 'recipe', 'sky', 'tree', 'biome', 'dimension' documentation added. 2020-03-12 13:36:54 +01:00
external Precision improvements (Part 4) 2020-02-24 12:00:02 +01:00
misc Headers updated and CONTRIBUTORS file added. 2020-02-25 01:48:38 +09:00
mods [Crosshair] Fixed size on smaller screens. 2020-03-11 15:26:21 +01:00
resources [LuaGUIState] Textures are now loaded from a path given by mods. 2020-03-10 13:15:23 +01:00
server Fixed crash related to singleplayer games. (see #75) 2020-03-12 00:06:45 +01:00
.codedocs [doc] Added. 2019-01-04 20:26:06 +01:00
.gitignore [ServerWorld] Now using chunk references instead of chunk pointers. 2020-03-10 17:30:22 +01:00
.travis.yml [.travis.yml] Added. 2019-01-20 15:07:45 +01:00
CMakeLists.txt The client is now capable of running a server in a dedicated thread. 2020-03-04 14:38:31 +01:00
CONTRIBUTING.md [docs] 'item', 'recipe', 'sky', 'tree', 'biome', 'dimension' documentation added. 2020-03-12 13:36:54 +01:00
CONTRIBUTORS.md Style and small C++ mistakes fixed. 2020-03-07 13:52:47 +01:00
LICENSE Small fixes. 2018-12-15 04:57:26 +01:00
Notes [TODO] Removed. [Notes] Updated. 2020-03-09 22:10:41 +01:00
README.md [docs] 'item', 'recipe', 'sky', 'tree', 'biome', 'dimension' documentation added. 2020-03-12 13:36:54 +01:00
mkdocs.yml [docs] 'item', 'recipe', 'sky', 'tree', 'biome', 'dimension' documentation added. 2020-03-12 13:36:54 +01:00
requirements.txt [docs] MkDocs-based documentation for ReadTheDocs. 2020-03-11 01:01:05 +01:00
screenshot1.png [screenshot1] Updated. 2020-02-23 15:38:43 +09:00
screenshot2.png [screenshots] Updated. 2019-01-31 20:00:45 +01:00
screenshot3.png [screenshot3] Updated. 2020-03-10 22:42:59 +01:00
screenshot4.png [screenshots] Updated. 2020-02-18 15:05:53 +09:00
screenshot5.png [TerrainGenerator] Portals added. 2020-03-09 21:10:03 +01:00

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

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)