Skip to content

Commit 249cee6

Browse files
committed
Updated last for the night xD
1 parent 9f3160f commit 249cee6

File tree

2 files changed

+15
-43
lines changed

2 files changed

+15
-43
lines changed

docs/build_guide.md

Lines changed: 14 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
How-To Building
22
-----
33

4-
The one true guide on how to build Zoxel
4+
The one true guide on how to build zoxel
55

66
[Back](../readme.md)
77

@@ -17,7 +17,19 @@ How-To Building
1717

1818
As a player of our voxel-based RPG, you will have the ability to build and mod to your heart's content. Our game features powerful building mechanics that allow you to create and destroy structures using voxels, giving you the freedom to design and shape your own environments. And with modding support, you can take your creativity even further by creating your own custom content and gameplay mechanics. Whether you want to build a towering fortress, a sprawling city, or something entirely different, the sky's the limit. So why not give building and modding a try and see what you can create? The possibilities are endless!
1919

20-
## The true way
20+
### Dependencies
21+
22+
I am using these libraries due to their light weight and power -unlimited power-
23+
24+
- [Flecs](https://github.com/SanderMertens/flecs) Fast and lightweight Entity Component System
25+
26+
- [SDL2](https://www.libsdl.org/index.php) Simple DirectMedia Layer (zlib)
27+
28+
- [OpenGL](https://www.khronos.org/opengles/) OpenGL 3.0 ES
29+
30+
In the future I may support Vulkan, for multi threading powers and performance gains.
31+
32+
## The True Way
2133

2234
A quick reference to make commands. Make sure to install flecs first before building zoxel.
2335

@@ -63,44 +75,4 @@ make run-web # run web
6375
```
6476
make install-android-sdk # installs android sdk, ndk for android builds
6577
make android # builds an android apk and pushes it to device (uses gradle)
66-
```
67-
68-
## Dependencies
69-
70-
I am using these libraries due to their light weight and power -unlimited power-
71-
72-
- [Flecs](https://github.com/SanderMertens/flecs) Fast and lightweight Entity Component System
73-
74-
- [SDL2](https://www.libsdl.org/index.php) Simple DirectMedia Layer (zlib)
75-
76-
- [OpenGL](https://www.khronos.org/opengles/) OpenGL 3.0 ES
77-
78-
I may switch to Glut in the future to reduce build size even more, instead of SDL.
79-
80-
I may also try out Vulkan, for multi threading powers and performance.
81-
82-
## Android [On Linux]
83-
84-
This is to compile zoxel as an apk
85-
86-
First install ndk in $HOME/android/ndk
87-
88-
Next install android-sdk in /usr/lib/android-sdk
89-
90-
Third, install SDL into $HOME/SDL/ under sub directories:
91-
SDL2, SDL2_image, SDL2_mixer
92-
93-
Go to the android bash scripts folder
94-
```
95-
cd ~/zoxel/bash/android
96-
```
97-
98-
Now run the installer which will copy all files needed, including zoxel source code and settings.
99-
```
100-
sh android_total_install.sh
101-
```
102-
103-
To run, connect an android device with the right privlages and run the bash below
104-
```
105-
sh gradle_install_debug.sh
10678
```

docs/roadmap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# zoxel roadmap
22

3-
A list of milestones and timeline
3+
the timeline of development consisting of milestones
44

55
[Back](../readme.md)
66

0 commit comments

Comments
 (0)