128 lines
3.8 KiB
Markdown
128 lines
3.8 KiB
Markdown
# OpenMiner
|
|
|
|
[](https://travis-ci.com/Unarelith/OpenMiner)
|
|
[](https://codedocs.xyz/Quent42340/OpenMiner/)
|
|
[](https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html)
|
|
[](https://discord.gg/eN8k8wt)
|
|
[](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=66DH462V7TA6N&source=url)
|
|
|
|
- [Project goal](#project-goal)
|
|
- [Keys](#keys)
|
|
- [Wiki](#wiki)
|
|
- [How to compile](#how-to-compile)
|
|
- [Discussion](#discussion)
|
|
- [Screenshots](#screenshots)
|
|
- [Project status](#project-status)
|
|
- [Previous attempts](#previous-attempts)
|
|
- [Credits](#credits)
|
|
|
|
## Project goal
|
|
|
|
The long-term goal of this project is to provide a viable alternative to Minecraft modding.
|
|
|
|
## Keys
|
|
|
|
- Movement: <kbd>W</kbd><kbd>A</kbd><kbd>S</kbd><kbd>D</kbd>
|
|
- Inventory: <kbd>E</kbd>
|
|
- Jump: <kbd>Space</kbd>
|
|
- Sprint: <kbd>Ctrl</kbd>
|
|
- Jetpack: <kbd>X</kbd>
|
|
- Exit: <kbd>Escape</kbd>
|
|
- Debug: <kbd>F3</kbd>
|
|
|
|
## Wiki
|
|
|
|
- [Lua API Overview](https://github.com/Unarelith/OpenMiner/wiki/Lua-API-Overview)
|
|
|
|
## How to compile
|
|
|
|
### Using Linux
|
|
|
|
- Dependencies:
|
|
- A compiler with C++14 support
|
|
- [CMake](http://www.cmake.org/download/)
|
|
- [GameKit](http://github.com/Unarelith/GameKit) (requires `SDL2` + `tinyxml2`, will switch to `SFML` starting from 2.6)
|
|
- [SFML](https://www.sfml-dev.org/) (only used for network)
|
|
- [Lua](http://www.lua.org)
|
|
- _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`
|
|
|
|
### 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)
|
|
|
|
## Discussion
|
|
|
|
- Discord: [join server](https://discord.gg/eN8k8wt)
|
|
- IRC: irc.freenode.net `#openminer`
|
|
|
|
## Screenshots
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Project status
|
|
|
|
This list is non exhaustive.
|
|
|
|
### Terrain generation
|
|
|
|
- [x] Basic terrain gen
|
|
- [x] Trees
|
|
- [x] Flowers
|
|
- [ ] Tall grass
|
|
- [ ] Biomes
|
|
- [ ] Mountains
|
|
- [ ] Cave tunnels
|
|
|
|
### Lighting
|
|
|
|
- [x] Basic lighting system
|
|
- [x] Cheap ambient occlusion
|
|
- [x] Smooth lighting
|
|
- [x] Sunlight downward propagation ~(possible but laggy)~
|
|
- [x] Ability to block light ~(possible but causes weird AO effects)~
|
|
|
|
### Network
|
|
|
|
- [x] World
|
|
- [x] Custom GUI
|
|
- [x] Inventories
|
|
- [x] Players
|
|
|
|
### Lua API
|
|
|
|
- [x] Register blocks/craft/items in the game
|
|
- [x] Create custom GUI and show them to player when rightclicking a block
|
|
|
|
### World
|
|
|
|
- [x] Block ticking (Furnace)
|
|
- [x] Mining speed/capability
|
|
- [ ] World loading/saving
|
|
- [ ] Block metadata (currently using a `u16` instead of the real thing)
|
|
- [ ] Fluid propagation
|
|
|
|
### Menus
|
|
|
|
- [x] Pause menu
|
|
- [x] Settings menu
|
|
- [x] Title screen
|
|
- [x] Server selection menu
|
|
|
|
## Previous attempts
|
|
|
|
- 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.
|
|
|
|
## Credits
|
|
|
|
- MadPixel (Minecrafter font) [CC BY-ND]
|
|
- xMrVizzy ([Faithful 32x](https://www.curseforge.com/minecraft/texture-packs/faithful-32x) texture pack, will completely replace Vanilla textures)
|
|
|