1
1
# minecraft-rust
2
2
3
- A Minecraft game clone written in Rust, using the Bevy game engine.
3
+ Minecraft game clone written in Rust, using the Bevy game engine.
4
+
5
+ <details open >
6
+ <summary >game preview :</summary >
7
+ <img src =" https://github.com/eztaah/minecraft-rust/blob/main/docs/gameplay.gif " alt =" Aperçu du projet " width =" 500 " >
8
+ </details >
9
+
10
+ <br >
11
+
12
+ ## Table of contents
13
+
14
+ - [ Controls] ( #controls )
15
+
16
+ - [ Building from source] ( #building-from-source )
17
+
18
+ - [ Contributing] ( #contributing )
4
19
5
20
<br >
6
21
7
22
## Controls
8
23
9
- In world :
10
-
11
- | Action | Bind |
12
- | ----------------| ----|
13
- | Move Forward | W / Arrow Up |
14
- | Move Backward | S / Arrow Down |
15
- | Move Left | A / Arrow Left |
16
- | Move Right | D / Arrow Right |
17
- | Jump | Space |
18
- | Inventory | E |
19
- | Toggle Fly Mode | F |
20
- | Fly Up | Space (only in Fly Mode) |
21
- | Fly Down | Left Shift (only in Fly Mode) |
22
- | Toggle FPS Display | F3 |
23
- | Toggle View Mode | F5 (First-Person / Third-Person) |
24
- | Toggle Chunk Debug | F4 |
25
- | Toggle Block Debug | F6 |
26
- | Decrease Render Distance | O |
27
- | Increase Render Distance | P |
28
- | Exit Game | Escape |
29
-
30
- In inventory :
31
-
32
- | Action | Bind |
33
- | --- | --- |
34
- | Pick up stack | Left click |
35
- | Pick up half of stack | Right click (with empty mouse) |
36
- | Deposit 1 item | Right click (holding items, over valid stack) |
37
- | Deposit MAX items | Left click (holding items, over valid stack) |
38
- | Exchange stacks | Left click (holding items, over different stack / already full valid stack) |
39
-
40
- > [ !NOTE]
41
- > In this context, "valid stack" means a stack in inventory, either empty or holding the same items as the mouse
24
+ #### Movement
25
+ | Action | Key |
26
+ | --------------------| -------------------|
27
+ | Jump | ` Space ` |
28
+ | Strafe Left | ` A ` / ` Arrow Left ` |
29
+ | Strafe Right | ` D ` / ` Arrow Right ` |
30
+ | Walk Backward | ` S ` / ` Arrow Down ` |
31
+ | Walk Forward | ` W ` / ` Arrow Up ` |
32
+ | Toggle Fly Mode | ` F ` |
33
+ | Fly Up | ` Space ` |
34
+ | Fly Down | ` Left Shift ` |
35
+
36
+ #### Gameplay
37
+ | Action | Key |
38
+ | --------------------| -------------------|
39
+ | Destroy Block | ` Left Mouse Button ` |
40
+ | Place Block | ` Right Mouse Button ` |
41
+
42
+ #### Inventory
43
+ | Action | Key/Mouse |
44
+ | -------------------------------| -----------------------------------|
45
+ | Open/Close Inventory | ` E ` |
46
+ | Pick up stack | ` Left Click ` |
47
+ | Pick up half of stack | ` Right Click ` (with empty mouse) |
48
+ | Deposit 1 item | ` Right Click ` (over valid stack) |
49
+ | Deposit MAX items | ` Left Click ` (over valid stack) |
50
+ | Exchange stacks | ` Left Click ` (over a different stack or full valid stack) |
51
+
52
+ > * A "valid stack" refers to a stack in the inventory that is either empty or contains the same items as the mouse cursor.*
53
+
54
+ #### Miscellaneous
55
+ | Action | Key |
56
+ | -------------------------------| -------------------|
57
+ | Toggle FPS Display | ` F3 ` |
58
+ | Toggle Perspective | ` F5 ` |
59
+ | Toggle Chunk Debug | ` F4 ` |
60
+ | Toggle Block Debug | ` F6 ` |
61
+ | Decrease Render Distance | ` O ` |
62
+ | Increase Render Distance | ` P ` |
63
+ | Exit Game | ` Escape ` |
42
64
43
65
<br >
44
66
45
- ## Getting Started
67
+ ## Building from source
46
68
47
69
### Prerequisites
48
70
49
71
To run this project, you need to have the following installed:
50
72
51
- - ** Rust** (Stable toolchain)
73
+ - ** Rust** (Stable toolchain) (This can be installed in several ways depending on your setup, the most standard way is to use rustup.rs.)
74
+ - ** Make**
52
75
53
- This can be installed in several ways depending on your setup, the most standard way is to use rustup.rs.
54
76
55
77
### Running the Project
56
78
@@ -60,7 +82,7 @@ Note: the first compilation will be slow depending on your hardware, next compil
60
82
61
83
``` sh
62
84
# Clone the repository
63
- git clone https://github.com/your-repo /minecraft-rust.git
85
+ git clone https://github.com/c2i-junia /minecraft-rust
64
86
65
87
# Navigate to the project directory
66
88
cd minecraft-rust
0 commit comments