# Mycraft

**Repository Path**: albertyg/Mycraft

## Basic Information

- **Project Name**: Mycraft
- **Description**: A minecraft clone project based on modern OpenGL completed in ZJU computer graphics course.
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2020-06-19
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Mycraft

![mycraft](md_pic/mycraft.png)

Mycraft is our Computer Graphics curriculum design based on modern OpengGL. 

It's a clone of Minecraft mainly written in C++ and we have implemented both Mac version and iOS version for it.

Refer to [Mobilecraft](https://github.com/Clapeysron/MobileCraft) for more information about the iOS version.


![1](md_pic/1.jpg)

## Features

### Render

-   Original block textures from Minecraft
-   Simple realtime shadow mapping
-   Corner shadow to simulate SSAO effect
-   Brightness-diffusion of point light such as Torch & Glowstone
-   Time pass effect with Sunrise / Sunset / Moon & Starry sky
-   Breaking aniamtion & highlight of the block selected
-   Transparent / translucent block such as water & glass
-   Simple on-ground and below-water gravity engine 
-   Jitter perspective to simulate running effect
-   Underwater visual effects
-   Fog that hides far away chunks

### Data

-   Terrain & cloud generation with perlin noise
-   Random generation of Flora
-   Hidden surface removal & invisible subchunk removal
-   frustum culling
-   Enclosed space detection
-   Corner shadow & brightness calculation
-   Adjustable game settings in `src/game_settings.h`
-   Map storage not done yet :(

## Build

### Install glfw & glew & assimp

Install glfw & glew & assimp with [Homebrew](http://brew.sh/).

	brew install glfw
	brew install glew
	brew install assimp
Then add lib in Click **Project Icon in Left Navigator** - **Build Phases** - **Link Binary With Libraries** - Add `libGLFW.X.X.dylib` & `libGLEW.X.X.X.dylib` & `libassimp.X.X.X.dylib` then remove the not-found(red) lib in left navigator.

### Install glad

Install [glad](https://github.com/Dav1dde/glad) from [online-pack](http://glad.dav1d.de/) following the tutorial from [learnopengl - Creating a window](https://learnopengl.com/#!Getting-started/Creating-a-window).

Choose OpenGL 3.3 and **Core Profile** then generate.

Then move header folder glad / KHR to `/usr/local/include`

### Set XCode working directory

Set your working directory in **XCode** - **Product** - **Scheme** - **Edit Scheme** - **Run** - **Working Directory** to `{Where Your Place}/Mycraft/Mycraft`

### Close shadow mapping if without independent graphics

For Macbook without discrete graphics, the game may lose its fluency greatly with the shadow on. You can comment out line 13 in `/src/Render.cpp` to ban it.

    //#define SHADOW_MAPPING

### Run

Just click run to get the game started

## Game Control

-   Press WASD to move and press Space to jump
-   Long press the left mouth button to break the selected block 
-   Click the right mouth button to place a block
-   Use space to fly and F to fall in god mode
-   ← & → to switch blocks for placing
-   ↑ & ↓ to switch options now choose (default is fov(1) )
-   1-5 to switch options. 
    -   1 fov  (↑- ↓+)
    -   2 cursor escape (↑disabled ↓escaped)
    -   3 game mode (↑god mode ↓normal mode)
    -   4 perspective (↑first person ↓third person)
    -   5 zoom in thid-person perspective (↑zoom in ↓zoom out)
-   Change all game settings in `src/game_settings.h`

## Architecture Design

![mycraft_design](md_pic/mycraft_design.png)

## Reference

Tribute to best [Minecraft](https://minecraft.net).

Modern OpenGL example code from [learnopengl](https://learnopengl.com) and  [learnopengl-cn](https://learnopengl-cn.github.io) (Perfect chinese version :)

Skybox texture & Steve model sources from [Craft](https://github.com/fogleman/Craft).

## Screenshots

### Steve & Alex object

![2](md_pic/2.jpg)

### Original Textures

![3](md_pic/3.jpg)

### Sunset

![4](md_pic/4.jpg)

### Point Light

![6](md_pic/6.jpg)

### In-water Point Light

![7](md_pic/7.jpg)

### Realtime Shadow Mapping

![8](md_pic/8.jpg)

### Underwater Visual Effects

![9](md_pic/9.jpg)

### Fog

![10](md_pic/10.jpg)

### Moon

![11](md_pic/11.jpg)

### Breaking Animation

![12](md_pic/12.jpg)

### Ugly House by Author

![13](md_pic/13.jpg)

### iOS MobileCraft Screenshot

![14](md_pic/14.png)