OpenMiner/README.md

OpenMiner

• Wiki
• Project goal
• Screenshots
• Keys
• How to compile
• Discussion
• Project status
• Previous versions
• Credits

Wiki

• Lua API Overview

Project goal

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

Screenshots

Keys

• Movement: WASD
• Inventory: E
• Jump: Space
• Sprint: Ctrl
• Jetpack: X
• Exit: Escape

How to compile

• 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 . && make -j8
• Run the server with ./server/openminer_server
• Run the client with ./client/openminer

Discussion

• Discord: join server
• IRC: irc.freenode.net #openminer

Project status

This list is non exhaustive.

Terrain generation

• Basic terrain gen
• Trees
• Flowers
• Tall grass
• Biomes
• Mountains
• Cave tunnels

Lighting

• Basic lighting system
• Cheap ambient occlusion
• Smooth lighting
• Sunlight downward propagation (possible but laggy)
• Ability to block light (possible but causes weird AO effects)

Network

• World
• Custom GUI
• Inventories
• Players

Lua API

• Register blocks/craft/items in the game
• Create custom GUI and show them to player when rightclicking a block

World

• Block ticking (Furnace)
• Mining speed/capability
• World loading/saving
• Block metadata (currently using a u16 instead of the real thing)
• Fluid propagation

Menus

• Pause menu
• Settings menu
• Title screen
• Server selection menu

Previous versions

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

Credits

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