Skip to content

Commit d21e5cd

Browse files
committed
update readme
1 parent cd01756 commit d21e5cd

File tree

2 files changed

+20
-21
lines changed

2 files changed

+20
-21
lines changed

README.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Minecraft Clone with Three.js
22

3-
A voxel-based Minecraft clone built using Three.js and TypeScript.
3+
A voxel-based Minecraft clone built using Three.js and TypeScript. View demo [here](https://x.com/0xSamHogan/status/1895954338876703115).
44

5-
![Minecraft Clone Screenshot](screenshot.png)
5+
![Minecraft Clone Screenshot](/public/images/demo.png)
66

77
## Features
88

@@ -18,15 +18,15 @@ A voxel-based Minecraft clone built using Three.js and TypeScript.
1818

1919
## Prerequisites
2020

21-
- Node.js (v14 or higher)
22-
- Bun or npm
21+
- [Bun](https://bun.sh/) (recommended)
22+
- Modern web browser with WebGL support
2323

2424
## Installation
2525

2626
1. Clone the repository:
2727
```bash
28-
git clone <repository-url>
29-
cd minecraft-clone
28+
git clone https://github.com/context-labs/minecraft-ai
29+
cd minecraft-ai
3030
```
3131

3232
2. Install dependencies:
@@ -38,12 +38,11 @@ npm install
3838

3939
## Running the Game
4040

41-
1. Start the development server:
41+
1. Build and start the server:
4242
```bash
4343
bun start
44-
# or
45-
npm start
4644
```
45+
This command will build the project and start the server.
4746

4847
2. Open your browser and navigate to `http://localhost:3000`
4948

@@ -53,16 +52,19 @@ For development with hot reloading:
5352

5453
```bash
5554
bun dev
56-
# or
57-
npm run dev
55+
```
56+
This will start the development server with automatic reloading when files change.
57+
58+
To build the project without starting the server:
59+
60+
```bash
61+
bun build
5862
```
5963

6064
To generate the texture atlas:
6165

6266
```bash
6367
bun generate-textures
64-
# or
65-
npm run generate-textures
6668
```
6769

6870
## Project Structure
@@ -74,8 +76,6 @@ minecraft-clone/
7476
│ └── textures/ # Game textures
7577
│ └── atlas.png # Texture atlas
7678
├── src/
77-
│ ├── core/ # Core game engine
78-
│ │ └── Engine.ts # Main game engine
7979
│ ├── player/ # Player-related code
8080
│ │ └── Player.ts # Player controller
8181
│ ├── ui/ # User interface
@@ -110,7 +110,6 @@ minecraft-clone/
110110

111111
The game is built using the following components:
112112

113-
- **Engine**: Main game engine that manages the scene, camera, and game loop
114113
- **World**: Manages chunks and terrain generation
115114
- **Chunk**: Represents a 16x16x16 section of blocks
116115
- **Block**: Defines different block types and their properties
@@ -120,11 +119,11 @@ The game is built using the following components:
120119

121120
## Technical Notes
122121

123-
- The project uses Three.js as a dependency installed via npm
124-
- Custom PointerLockControls implementation for better compatibility
125-
- Fallback texture generation if atlas.png is not available
126-
- Debug logging added to help diagnose rendering issues
127-
- Enhanced lighting with ambient and directional lights
122+
- The project uses Three.js for 3D rendering
123+
- Custom PointerLockControls implementation for camera control
124+
- Optimized chunk rendering with geometry instancing
125+
- Collision detection for player movement
126+
- Raycasting for block selection and interaction
128127

129128
## Performance Considerations
130129

public/images/demo.png

3.65 MB
Loading

0 commit comments

Comments
 (0)