Merge pull request #469 from aaronfranke/voxel

Add a Voxel demo project

Author: aaronfranke

3d/voxel/README.md

@@ -0,0 +1,58 @@
+# Voxel Game
+
+This demo is a minimal first-person voxel game,
+inspired by others such as Minecraft.
+
+Language: GDScript
+
+Renderer: GLES 2
+
+## How does it work?
+
+Each chunk is a
+[`StaticBody`](https://docs.godotengine.org/en/latest/classes/class_staticbody.html)
+with each block having its own
+[`CollisionShape`](https://docs.godotengine.org/en/latest/classes/class_collisionshape.html)
+for collisions. The meshes are created using
+[`SurfaceTool`](https://docs.godotengine.org/en/latest/classes/class_surfacetool.html)
+which allows specifying vertices, triangles, and UV coordinates
+for constructing a mesh.
+
+The chunks and chunk data are stored in
+[`Dictionary`](https://docs.godotengine.org/en/latest/classes/class_dictionary.html)
+objects. New chunks have their meshes drawn in separate
+[`Thread`](https://docs.godotengine.org/en/latest/classes/class_thread.html)s,
+but generating the collisions is done in the main thread, since Godot does
+not support changing physics objects in a separate thread. There
+are two terrain types, random blocks and flat grass. A more
+complex terrain generator is out-of-scope for this demo project.
+
+The player can place and break blocks using the
+[`RayCast`](https://docs.godotengine.org/en/latest/classes/class_raycast.html)
+node attached to the camera. It uses the collision information to
+figure out the block position and change the block data. You can
+switch the active block using the brackets or with the middle mouse button.
+
+There is a settings menu for render distance and toggling the fog.
+Settings are stored inside of an
+[AutoLoad singleton](https://docs.godotengine.org/en/latest/getting_started/step_by_step/singletons_autoload.html)
+called "Settings". This class will automatically save
+settings, and load them when the game opens, by using the
+[`File`](https://docs.godotengine.org/en/latest/classes/class_file.html) class.
+
+Sticking to GDScript and the built-in Godot tools, as this demo does, is
+quite limiting. If you are making your own voxel game, you should probably
+use Zylann's voxel module instead: https://github.com/Zylann/godot_voxel
+
+## Screenshots
+
+![Screenshot](screenshots/blocks.png)
+
+![Screenshot](screenshots/title.png)
+
+## Licenses
+
+Textures are from [Minetest](https://www.minetest.net/). Copyright © 2010-2018 Minetest contributors, CC BY-SA 3.0 Unported (Attribution-ShareAlike)
+http://creativecommons.org/licenses/by-sa/3.0/
+
+Font is "TinyUnicode" by DuffsDevice. Copyright © DuffsDevice, CC-BY (Attribution) http://www.pentacom.jp/pentacom/bitfontmaker2/gallery/?id=468

3d/voxel/default_bus_layout.tres

@@ -0,0 +1,8 @@
+[gd_resource type="AudioBusLayout" load_steps=2 format=2]
+
+[sub_resource type="AudioEffectPitchShift" id=1]
+resource_name = "PitchShift"
+
+[resource]
+bus/0/effect/0/effect = SubResource( 1 )
+bus/0/effect/0/enabled = true

3d/voxel/default_env.tres

@@ -0,0 +1,18 @@
+[gd_resource type="Environment" load_steps=2 format=2]
+
+[sub_resource type="ProceduralSky" id=1]
+sun_longitude = 100.0
+sun_angle_min = 2.0
+sun_angle_max = 20.0
+
+[resource]
+background_mode = 2
+background_sky = SubResource( 1 )
+fog_enabled = true
+fog_color = Color( 0.501961, 0.6, 0.701961, 1 )
+fog_depth_begin = 32.0
+fog_depth_end = 64.0
+fog_transmit_enabled = true
+dof_blur_far_enabled = true
+dof_blur_far_transition = 32.0
+dof_blur_far_amount = 0.05

3d/voxel/icon.png

@@ -0,0 +1,34 @@
+[remap]
+
+importer="texture"
+type="StreamTexture"
+path="res://.import/icon.png-487276ed1e3a0c39cad0279d744ee560.stex"
+metadata={
+"vram_texture": false
+}
+
+[deps]
+
+source_file="res://icon.png"
+dest_files=[ "res://.import/icon.png-487276ed1e3a0c39cad0279d744ee560.stex" ]
+
+[params]
+
+compress/mode=0
+compress/lossy_quality=0.7
+compress/hdr_mode=0
+compress/bptc_ldr=0
+compress/normal_map=0
+flags/repeat=0
+flags/filter=true
+flags/mipmaps=false
+flags/anisotropic=false
+flags/srgb=2
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/HDR_as_SRGB=false
+process/invert_color=false
+stream=false
+size_limit=0
+detect_3d=true
+svg/scale=1.0

3d/voxel/icon.png.import

@@ -0,0 +1,34 @@
+[remap]
+
+importer="texture"
+type="StreamTexture"
+path="res://.import/button.png-e6ddd405c0968c9fb68dca7b600a69a3.stex"
+metadata={
+"vram_texture": false
+}
+
+[deps]
+
+source_file="res://menu/button.png"
+dest_files=[ "res://.import/button.png-e6ddd405c0968c9fb68dca7b600a69a3.stex" ]
+
+[params]
+
+compress/mode=0
+compress/lossy_quality=0.7
+compress/hdr_mode=0
+compress/bptc_ldr=0
+compress/normal_map=0
+flags/repeat=0
+flags/filter=true
+flags/mipmaps=false
+flags/anisotropic=false
+flags/srgb=2
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/HDR_as_SRGB=false
+process/invert_color=false
+stream=false
+size_limit=0
+detect_3d=true
+svg/scale=1.0

3d/voxel/menu/button.png

@@ -0,0 +1,45 @@
+extends Label
+# Displays some useful debug information in a Label.
+
+onready var player = $"../Player"
+onready var voxel_world = $"../VoxelWorld"
+
+
+func _process(_delta):
+	if Input.is_action_just_pressed("debug"):
+		visible = !visible
+	
+	text = "Position: " + _vector_to_string_appropriate_digits(player.transform.origin)
+	text += "\nEffective render distance: " + str(voxel_world.effective_render_distance)
+	text += "\nLooking: " + _cardinal_string_from_radians(player.transform.basis.get_euler().y)
+	text += "\nFPS: " + str(Engine.get_frames_per_second())
+
+
+# Avoids the problem of showing more digits than needed or available.
+func _vector_to_string_appropriate_digits(vector):
+	var factors = [1000, 1000, 1000]
+	for i in range(3):
+		if abs(vector[i]) > 4096:
+			factors[i] = factors[i] / 10
+			if abs(vector[i]) > 65536:
+				factors[i] = factors[i] / 10
+				if abs(vector[i]) > 524288:
+					factors[i] = factors[i] / 10
+	
+	return "(" + \
+			str(round(vector.x * factors[0]) / factors[0]) + ", " + \
+			str(round(vector.y * factors[1]) / factors[1]) + ", " + \
+			str(round(vector.z * factors[2]) / factors[2]) + ")"
+
+
+# Expects a rotation where 0 is North, on the range -PI to PI.
+func _cardinal_string_from_radians(angle):
+	if angle > TAU * 3 / 8:
+		return "South"
+	if angle < -TAU * 3 / 8:
+		return "South"
+	if angle > TAU * 1 / 8:
+		return "West"
+	if angle < -TAU * 1 / 8:
+		return "East"
+	return "North"

3d/voxel/menu/button.png.import

@@ -0,0 +1,38 @@
+extends Control
+
+onready var tree = get_tree()
+
+onready var crosshair = $Crosshair
+onready var pause = $Pause
+onready var options = $Options
+onready var voxel_world = $"../VoxelWorld"
+
+
+func _process(_delta):
+	if Input.is_action_just_pressed("pause"):
+		pause.visible = crosshair.visible
+		crosshair.visible = !crosshair.visible
+		options.visible = false
+		Input.set_mouse_mode(Input.MOUSE_MODE_CAPTURED if crosshair.visible else Input.MOUSE_MODE_VISIBLE)
+
+
+func _on_Resume_pressed():
+	Input.set_mouse_mode(Input.MOUSE_MODE_CAPTURED)
+	crosshair.visible = true
+	pause.visible = false
+
+
+func _on_Options_pressed():
+	options.prev_menu = pause
+	options.visible = true
+	pause.visible = false
+
+
+func _on_MainMenu_pressed():
+	voxel_world.clean_up()
+	tree.change_scene("res://menu/main/main_menu.tscn")
+
+
+func _on_Exit_pressed():
+	voxel_world.clean_up()
+	tree.quit()

3d/voxel/menu/debug.gd

@@ -0,0 +1,133 @@
+[gd_scene load_steps=6 format=2]
+
+[ext_resource path="res://player/crosshair.svg" type="Texture" id=1]
+[ext_resource path="res://menu/theme/theme.tres" type="Theme" id=2]
+[ext_resource path="res://menu/options/options.tscn" type="PackedScene" id=3]
+[ext_resource path="res://menu/ingame/pause_menu.gd" type="Script" id=4]
+[ext_resource path="res://menu/button.png" type="Texture" id=5]
+
+[node name="PauseMenu" type="Control"]
+anchor_right = 1.0
+anchor_bottom = 1.0
+theme = ExtResource( 2 )
+script = ExtResource( 4 )
+__meta__ = {
+"_edit_use_anchors_": false
+}
+
+[node name="Crosshair" type="CenterContainer" parent="."]
+anchor_right = 1.0
+anchor_bottom = 1.0
+__meta__ = {
+"_edit_use_anchors_": false
+}
+
+[node name="TextureRect" type="TextureRect" parent="Crosshair"]
+margin_left = 784.0
+margin_top = 434.0
+margin_right = 816.0
+margin_bottom = 466.0
+texture = ExtResource( 1 )
+
+[node name="Pause" type="VBoxContainer" parent="."]
+visible = false
+anchor_right = 1.0
+anchor_bottom = 1.0
+__meta__ = {
+"_edit_use_anchors_": false
+}
+
+[node name="ButtonHolder" type="HBoxContainer" parent="Pause"]
+margin_right = 1600.0
+margin_bottom = 900.0
+size_flags_vertical = 3
+alignment = 1
+
+[node name="MainButtons" type="VBoxContainer" parent="Pause/ButtonHolder"]
+margin_left = 608.0
+margin_right = 992.0
+margin_bottom = 900.0
+custom_constants/separation = 20
+alignment = 1
+
+[node name="Resume" type="TextureButton" parent="Pause/ButtonHolder/MainButtons"]
+margin_top = 292.0
+margin_right = 384.0
+margin_bottom = 356.0
+rect_min_size = Vector2( 384, 64 )
+texture_normal = ExtResource( 5 )
+
+[node name="Label" type="Label" parent="Pause/ButtonHolder/MainButtons/Resume"]
+anchor_right = 1.0
+anchor_bottom = 1.0
+margin_top = -1.0
+margin_bottom = -18.0
+text = "Resume Game"
+align = 1
+valign = 1
+__meta__ = {
+"_edit_use_anchors_": false
+}
+
+[node name="Options" type="TextureButton" parent="Pause/ButtonHolder/MainButtons"]
+margin_top = 376.0
+margin_right = 384.0
+margin_bottom = 440.0
+rect_min_size = Vector2( 384, 64 )
+texture_normal = ExtResource( 5 )
+
+[node name="Label" type="Label" parent="Pause/ButtonHolder/MainButtons/Options"]
+anchor_right = 1.0
+anchor_bottom = 1.0
+margin_top = -1.0
+margin_bottom = -18.0
+text = "Options"
+align = 1
+valign = 1
+__meta__ = {
+"_edit_use_anchors_": false
+}
+
+[node name="MainMenu" type="TextureButton" parent="Pause/ButtonHolder/MainButtons"]
+margin_top = 460.0
+margin_right = 384.0
+margin_bottom = 524.0
+rect_min_size = Vector2( 384, 64 )
+texture_normal = ExtResource( 5 )
+
+[node name="Label" type="Label" parent="Pause/ButtonHolder/MainButtons/MainMenu"]
+anchor_right = 1.0
+anchor_bottom = 1.0
+margin_top = -1.0
+margin_bottom = -18.0
+text = "Main Menu"
+align = 1
+valign = 1
+__meta__ = {
+"_edit_use_anchors_": false
+}
+
+[node name="Exit" type="TextureButton" parent="Pause/ButtonHolder/MainButtons"]
+margin_top = 544.0
+margin_right = 384.0
+margin_bottom = 608.0
+rect_min_size = Vector2( 384, 64 )
+texture_normal = ExtResource( 5 )
+
+[node name="Label" type="Label" parent="Pause/ButtonHolder/MainButtons/Exit"]
+anchor_right = 1.0
+anchor_bottom = 1.0
+margin_top = -1.0
+margin_bottom = -18.0
+text = "Exit Game"
+align = 1
+valign = 1
+__meta__ = {
+"_edit_use_anchors_": false
+}
+
+[node name="Options" parent="." instance=ExtResource( 3 )]
+[connection signal="pressed" from="Pause/ButtonHolder/MainButtons/Resume" to="." method="_on_Resume_pressed"]
+[connection signal="pressed" from="Pause/ButtonHolder/MainButtons/Options" to="." method="_on_Options_pressed"]
+[connection signal="pressed" from="Pause/ButtonHolder/MainButtons/MainMenu" to="." method="_on_MainMenu_pressed"]
+[connection signal="pressed" from="Pause/ButtonHolder/MainButtons/Exit" to="." method="_on_Exit_pressed"]