2018-12-19 15:00:01 -08:00
# OpenMiner
2015-07-17 08:08:53 -07:00
2019-04-13 06:45:44 -07:00
[![Build Status ](https://travis-ci.com/Unarelith/OpenMiner.svg?branch=master )](https://travis-ci.com/Unarelith/OpenMiner)
2019-01-04 11:26:06 -08:00
[![Documentation ](https://codedocs.xyz/Quent42340/OpenMiner.svg )](https://codedocs.xyz/Quent42340/OpenMiner/)
[![License ](https://img.shields.io/badge/license-LGPLv2.1%2B-blue.svg )](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html)
2019-01-08 13:10:59 -08:00
[![Discord ](https://img.shields.io/discord/527527086756200458.svg?style=popout )](https://discord.gg/eN8k8wt)
2019-02-03 04:55:34 -08:00
[![Donate ](https://img.shields.io/badge/donate-paypal-brightgreen.svg )](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick& hosted_button_id=66DH462V7TA6N& source=url)
2015-07-17 08:08:53 -07:00
2019-02-03 04:55:34 -08:00
- [Project goal ](#project-goal )
- [Keys ](#keys )
2020-01-22 21:33:37 -08:00
- [Wiki ](#wiki )
2019-02-03 04:55:34 -08:00
- [How to compile ](#how-to-compile )
- [Discussion ](#discussion )
- [Project status ](#project-status )
2020-01-31 00:47:35 -08:00
- [Screenshots ](#screenshots )
2019-12-30 04:08:25 -08:00
- [Previous attempts ](#previous-attempts )
2019-02-03 04:55:34 -08:00
- [Credits ](#credits )
## Project goal
The long-term goal of this project is to provide a viable alternative to Minecraft modding.
2015-07-17 08:08:53 -07:00
## Keys
2018-06-12 14:28:06 -07:00
- Movement: < kbd > W</ kbd >< kbd > A</ kbd >< kbd > S</ kbd >< kbd > D</ kbd >
2018-06-20 15:55:38 -07:00
- Inventory: < kbd > E</ kbd >
2018-06-24 13:32:20 -07:00
- Jump: < kbd > Space</ kbd >
2019-01-20 06:08:27 -08:00
- Sprint: < kbd > Ctrl</ kbd >
2018-06-24 13:32:20 -07:00
- Jetpack: < kbd > X</ kbd >
2015-07-17 08:08:53 -07:00
- Exit: < kbd > Escape</ kbd >
2020-01-21 16:35:42 -08:00
- Debug: < kbd > F3</ kbd >
2015-07-17 08:08:53 -07:00
2020-01-22 21:33:37 -08:00
## Wiki
- [Lua API Overview ](https://github.com/Unarelith/OpenMiner/wiki/Lua-API-Overview )
2015-07-17 08:08:53 -07:00
## How to compile
2020-01-22 21:15:02 -08:00
### Using Linux
2015-07-17 08:08:53 -07:00
- Dependencies:
2019-02-26 06:44:32 -08:00
- A compiler with C++14 support
2015-07-17 08:08:53 -07:00
- [CMake ](http://www.cmake.org/download/ )
2019-04-13 06:45:44 -07:00
- [GameKit ](http://github.com/Unarelith/GameKit ) (requires `SDL2` + `tinyxml2` , will switch to `SFML` starting from 2.6)
2019-01-09 09:47:28 -08:00
- [SFML ](https://www.sfml-dev.org/ ) (only used for network)
2019-01-05 08:15:03 -08:00
- [Lua ](http://www.lua.org )
2018-06-12 14:28:06 -07:00
- _Linux users: Check your distribution repositories for packages._
2020-02-14 01:36:45 -08:00
- Run `cmake .`
- Run `make -j8`
2019-01-20 05:33:13 -08:00
- Run the server with `./server/openminer_server`
- Run the client with `./client/openminer`
2015-07-17 08:08:53 -07:00
2020-01-22 21:15:02 -08:00
### Using Windows
- [Wiki: Compiling on Windows using CMake and MinGW-w64 ](https://github.com/Unarelith/OpenMiner/wiki/Compiling-on-Windows-with-MinGW-w64 )
- [Wiki: Compiling on Windows using CMake and Visual Studio 2017 ](https://github.com/Unarelith/OpenMiner/wiki/Compiling-on-Windows-with-Visual-Studio-2017 )
2018-12-26 08:57:46 -08:00
## Discussion
- Discord: [join server ](https://discord.gg/eN8k8wt )
2020-02-17 01:46:34 -08:00
- IRC: irc.freenode.net `#openminer`
2020-01-22 21:33:37 -08:00
2019-02-02 03:52:10 -08:00
## Project status
This list is non exhaustive.
2020-01-31 00:47:35 -08:00
### Implemented features
- Menus (title screen, server selection, pause menu, settings menu)
- Basic worldgen (lakes, trees, flowers, pseudo-caves)
2020-02-18 01:37:51 -08:00
- Infinite world in X/Y/Z axis (#25)
2020-01-31 00:47:35 -08:00
- Lighting system with smooth lighting
2020-02-18 01:37:51 -08:00
- Networking (#20)
2020-01-31 00:47:35 -08:00
- Lua API
- Block/item/recipe definition
- Custom GUI creation
- Special blocks (workbench, furnace)
2020-02-08 00:45:20 -08:00
- Block metadata
2020-01-31 00:47:35 -08:00
### Missing features
2020-02-18 01:37:51 -08:00
- Texture pack system (#34)
- World loading/saving (#26)
2020-01-31 00:47:35 -08:00
- Particle system
- Fluid propagation
- Player model display (currently displaying an ugly box)
- Day/night cycle with sun/moon display
- Real worldgen (seed-based, biomes, cave tunnels)
- Entities (block drops, mobs, etc...)
2020-02-18 01:37:51 -08:00
- Clouds (#52)
2019-02-02 03:52:10 -08:00
2020-01-31 00:47:35 -08:00
## Screenshots
2019-02-02 03:52:10 -08:00
2020-01-31 00:47:35 -08:00
![](screenshot1.png?raw=true)
![](screenshot2.png?raw=true)
![](screenshot3.png?raw=true)
![](screenshot4.png?raw=true)
2019-02-02 03:52:10 -08:00
2019-12-30 02:00:59 -08:00
## Previous attempts
2018-06-12 14:28:06 -07:00
2019-12-30 02:00:59 -08:00
- Here is the [commit ](https://github.com/Unarelith/OpenMiner/tree/8eba845421efff6ce941f8550ff79e6364970fd5 ) matching the end of the first attempt made in 2013.
- And here is the [commit ](https://github.com/Unarelith/OpenMiner/tree/58c23a7e66404dab94e51998a179dc370c89ea06 ) matching the end of the second attempt made in 2014.
2018-06-12 14:28:06 -07:00
2020-01-31 00:47:35 -08:00
You can find an history of the project [here ](https://github.com/Unarelith/OpenMiner/wiki/History-of-OpenMiner ).
2019-01-08 15:01:31 -08:00
## Credits
- MadPixel (Minecrafter font) [CC BY-ND]
2019-01-20 10:09:37 -08:00
- xMrVizzy ([Faithful 32x](https://www.curseforge.com/minecraft/texture-packs/faithful-32x) texture pack, will completely replace Vanilla textures)
2019-01-08 15:01:31 -08:00