Go to file
Quentin Bazin 8231b352f2 Style and small C++ mistakes fixed. 2020-03-07 13:52:47 +01:00
client [BlockCursor] Replaced blending by old blending. 2020-03-06 00:45:39 +01:00
cmake [CMakeLists.txt] Now allows compiling on Windows. 2020-01-22 14:18:31 +09:00
common Style and small C++ mistakes fixed. 2020-03-07 13:52:47 +01:00
doc [doc] Added. 2019-01-04 20:26:06 +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/default Style and small C++ mistakes fixed. 2020-03-07 13:52:47 +01:00
resources [BlockCursor] Replaced blending by old blending. 2020-03-06 00:45:39 +01:00
server Style and small C++ mistakes fixed. 2020-03-07 13:52:47 +01:00
.codedocs [doc] Added. 2019-01-04 20:26:06 +01:00
.gitignore [Config] New function 'loadConfigFromFile' automatically loads 'config.lua' if present. 2020-02-15 23:06:01 +09: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 [CONTRIBUTING.md] Updated. 2020-03-05 22:17:05 +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 [Notes] Example for biome definition added. 2020-02-26 03:16:32 +09:00
README.md [README.md] "Getting started" wiki page added. 2020-03-05 15:22:22 +01:00
TODO [TODO] Updated. 2020-03-05 21:31:16 +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 [README.md] Screenshots updated. 2020-01-22 09:35:42 +09:00
screenshot4.png [screenshots] Updated. 2020-02-18 15:05:53 +09:00

README.md

OpenMiner

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

Missing features

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

Screenshots

Previous attempts

  • Here is the commit matching the end of the first attempt made in 2013.
  • And here is the commit matching the end of the second attempt made in 2014.

You can find an history of the project here.

Credits

  • MadPixel (Minecrafter font) [CC BY-ND]
  • xMrVizzy (Faithful 32x texture pack, will completely replace Vanilla textures)