Skip to content

Commit

Permalink
Readme + Font change
Browse files Browse the repository at this point in the history
- Segoe UI replaced by Selawik
- Readme near complete
  • Loading branch information
etherealxx committed Apr 16, 2024
1 parent bcc40be commit 0f67b2d
Show file tree
Hide file tree
Showing 8 changed files with 62 additions and 13 deletions.
49 changes: 49 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,52 @@
---

![limboscene9](https://github.com/etherealxx/limbo-godot/assets/64251396/2c1dee2c-2fd5-4519-8c22-ed08960f55d5)

---

#### For Godot User
- Clone this repo locally
- Open the project with `Godot 4.2.1`, and then open main scene (`"res://scenes/main.tscn"`)
- Follow the instruction provided there

#### Tips for player
- When running the game, when all the 8 key is shown, before it starts shuffling, you could double right click at any of the key, the game will close and then being replaced with a setting menu.
- You can adjust several toggles on the setting menu, some of the useful one are:
- `transparent_background`, when turned off, the keys' window will no longer be transparent. Improves performance on lower end devices
- `music_volume`, adjust the volume. Default is 20. Decreasing it will decrease the volume by 1 dB each.
- `no_ending_screen`, when turned on, the bluescreen sequence won't happen, instead after clicking on the key, it'll just say if the key you choose is correct or wrong. For quick play.
- The rest are useful for debugging, and information about each variable can be read on the main root node's [script](https://github.com/etherealxx/limbo-godot/blob/master/scripts/main.gd).
- Pressing `Esc` during the bluescreen ending will make you instantly quit the game, instead of needing to wait for 7 seconds

#### Tips for developer
- Before exporting, make sure every exported variable of `main.tscn` is set to default, by checking the Inspector tab and pressing every reset button on the `main.gd` section. Unless you want to set the changed value as the default for the exported executable.
- Using the custom built export template could save the executable size by roughly 45%. Check it on the Release page.
- I exported the executable with encryption, the preset is already on the export template, just turn it on. But make sure if you also want to do it, make the export template by yourself. More info [here](https://docs.godotengine.org/en/stable/contributing/development/compiling/compiling_with_script_encryption_key.html).
- The save file is located in `%appdata%\limbo-godot\limbosave.cfg`, while the log file is on `%appdata%\limbo-godot\logs\limbo.log`.
- `toggleaddons.gd` is an editorscript, located in `res://scripts/editorscript`. It can be run by opening it on the script editor then pressing File > Run (or `Ctrl+Shift+X`). Running it will turn off every addons i currently use. I use it to exclude addons before exporting the project and pushing it into Github. You need to reload the project immediately after running the script. It was designed to be a toggle of some sort, so if the addon was deactivated before, the next time you run the script, it'll be activated again, and vice versa.

#### Known Bugs

- The game won't work on device with vertical (portrait) primary monitor.
- There's a weird bug in certain Windows 10 device, where the black part of the ending sequence is fully transparent, and the bluescreen is half transparent.
- You can run the executable again to launch another game while the game is still running.
- The game will look a bit weird on device with monitor resolution/display height smaller than +-900px
- The song will desync when running the game on low-end device

---

### Credits
- [Isolation](https://www.youtube.com/watch?v=O07SX0BliAQ) by Nighthawk22 (Song used for LIMBO)
- Level complete/death sfx, spike and background sprite ripped from Geometry Dash by RobTop
- [Windows 11 icon pack](http://www.rw-designer.com/icon-set/windowsicons-zip) by rw-designer for the This PC icon
- Mindcap & more for the original LIMBO level in Geometry Dash
- [Selawik](https://github.com/microsoft/Selawik) and Segoe Boot Semilight by Microsoft
- Zylann for the original [change color shader](https://forum.godotengine.org/t/changing-a-specific-color-in-a-sprite-using-shaders-in-godot-3/29610/4) on Godot forum
- Godot Engine by Juan Linietsky, Ariel Manzur & Contributors <br/>(License: https://godotengine.org/license/)

### Special Thanks
- Thanks to the maker of addons that I use during the development of this game, which are [script-ide](https://github.com/Maran23/script-ide) and [discord-rpc-godot](https://github.com/vaporvee/discord-rpc-godot). Both are amazing
- quasar098's [limbos32](https://github.com/quasar098/limbos32) as my main inspiration of this project, and this repos was the fork of that. Though it changed so much that the only thing left is only the `key.png`
- MarkHermy3100's [LimboKeys](https://github.com/MarkHermy3100/LimboKeys) as i use his [key shuffler](https://github.com/MarkHermy3100/LimboKeys/blob/main/assets/scripts/Shuffler.ts) pattern. It's near accurate, and it's vertical (4 rows 2 columns just like the original LIMBO)
- enderprism for his sprite rip from [godot-dash-v2](https://github.com/enderprism/godot-dash-v2)
- The entire [Godot Official Discord Server](https://discord.com/invite/zH7NUgz), especially those who always helps me when i asks questions😊
2 changes: 1 addition & 1 deletion export_presets.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ runnable=true
dedicated_server=false
custom_features=""
export_filter="exclude"
export_files=PackedStringArray("res://addons/discord-sdk-gd/bin/discord-rpc-gd.gdextension", "res://addons/discord-sdk-gd/nodes/assets/Checked.svg", "res://addons/discord-sdk-gd/nodes/assets/circle.svg", "res://addons/discord-sdk-gd/nodes/assets/Unchecked.svg", "res://addons/discord-sdk-gd/nodes/debug.gd", "res://addons/discord-sdk-gd/nodes/Debug.tscn", "res://addons/discord-sdk-gd/nodes/discord_autoload.gd", "res://addons/discord-sdk-gd/Debug.svg", "res://addons/discord-sdk-gd/example.gd", "res://addons/discord-sdk-gd/logo.png", "res://addons/discord-sdk-gd/Logo_V2_No_Bg.png", "res://addons/discord-sdk-gd/plugin.gd", "res://addons/discord-sdk-gd/restart_window.tscn", "res://addons/script-ide/icon/class.svg", "res://addons/script-ide/icon/constant.svg", "res://addons/script-ide/icon/export.svg", "res://addons/script-ide/icon/func.svg", "res://addons/script-ide/icon/func_get.svg", "res://addons/script-ide/icon/func_set.svg", "res://addons/script-ide/icon/keyword.svg", "res://addons/script-ide/icon/property.svg", "res://addons/script-ide/icon/signal.svg", "res://addons/script-ide/plugin.gd", "res://addons/script-ide/Popup.gd", "res://scripts/autoloads/discordrpc.gd", "res://shaders/test/Blur.gdshader", "res://shaders/test/blurtest.gdshader", "res://shaders/test/change2color_backup.gdshader", "res://shaders/test/change2color_greenexample.gdshader", "res://shaders/test/gaussianblur.gdshader", "res://shaders/test/simpleblur.gdshader", "res://test/bsod_by ether.png", "res://test/maintest2.gd", "res://test/maintest3.gd", "res://test/maintest3.tscn", "res://test/node2.gd", "res://test/node2.tscn", "res://test/node.tscn", "res://test/orbitingwindow.gd", "res://test/Sprite2D2.gd", "res://test/Sprite2D.gd", "res://test/testbackground.tscn", "res://test/test_2.tscn", "res://scripts/editorscript/toggleaddons.gd", "res://exports/unused/main_unused.gd", "res://exports/unused/toggleaddons_old.gd")
export_files=PackedStringArray("res://addons/discord-sdk-gd/bin/discord-rpc-gd.gdextension", "res://addons/discord-sdk-gd/nodes/assets/Checked.svg", "res://addons/discord-sdk-gd/nodes/assets/circle.svg", "res://addons/discord-sdk-gd/nodes/assets/Unchecked.svg", "res://addons/discord-sdk-gd/nodes/debug.gd", "res://addons/discord-sdk-gd/nodes/Debug.tscn", "res://addons/discord-sdk-gd/nodes/discord_autoload.gd", "res://addons/discord-sdk-gd/Debug.svg", "res://addons/discord-sdk-gd/example.gd", "res://addons/discord-sdk-gd/logo.png", "res://addons/discord-sdk-gd/Logo_V2_No_Bg.png", "res://addons/discord-sdk-gd/plugin.gd", "res://addons/discord-sdk-gd/restart_window.tscn", "res://addons/script-ide/icon/class.svg", "res://addons/script-ide/icon/constant.svg", "res://addons/script-ide/icon/export.svg", "res://addons/script-ide/icon/func.svg", "res://addons/script-ide/icon/func_get.svg", "res://addons/script-ide/icon/func_set.svg", "res://addons/script-ide/icon/keyword.svg", "res://addons/script-ide/icon/property.svg", "res://addons/script-ide/icon/signal.svg", "res://addons/script-ide/plugin.gd", "res://addons/script-ide/Popup.gd", "res://scripts/autoloads/discordrpc.gd", "res://shaders/test/Blur.gdshader", "res://shaders/test/blurtest.gdshader", "res://shaders/test/change2color_backup.gdshader", "res://shaders/test/change2color_greenexample.gdshader", "res://shaders/test/gaussianblur.gdshader", "res://shaders/test/simpleblur.gdshader", "res://test/bsod_by ether.png", "res://test/maintest2.gd", "res://test/maintest3.gd", "res://test/maintest3.tscn", "res://test/node2.gd", "res://test/node2.tscn", "res://test/node.tscn", "res://test/orbitingwindow.gd", "res://test/Sprite2D2.gd", "res://test/Sprite2D.gd", "res://test/testbackground.tscn", "res://test/test_2.tscn", "res://scripts/editorscript/toggleaddons.gd")
include_filter=""
exclude_filter="*.dll, *.exe, *.zip, *.rar, *.7z, *.pck"
export_path="exports/limbo_keygen.exe"
Expand Down
Binary file removed fonts/segoeui.ttf
Binary file not shown.
Binary file added fonts/selawk.ttf
Binary file not shown.
8 changes: 4 additions & 4 deletions fonts/segoeui.ttf.import → fonts/selawk.ttf.import
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

importer="font_data_dynamic"
type="FontFile"
uid="uid://8gxideu8ajla"
path="res://.godot/imported/segoeui.ttf-11db14e8ac52e5401073185c432b13b0.fontdata"
uid="uid://cav7vtx0re00h"
path="res://.godot/imported/selawk.ttf-1746c907762226dd3f459b3053908ba3.fontdata"

[deps]

source_file="res://fonts/segoeui.ttf"
dest_files=["res://.godot/imported/segoeui.ttf-11db14e8ac52e5401073185c432b13b0.fontdata"]
source_file="res://fonts/selawk.ttf"
dest_files=["res://.godot/imported/selawk.ttf-1746c907762226dd3f459b3053908ba3.fontdata"]

[params]

Expand Down
2 changes: 1 addition & 1 deletion project.godot
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ config_version=5

config/name="Keygen"
config/description="focus"
config/version="1.1.0"
config/version="1.1.1"
run/main_scene="res://scenes/main.tscn"
config/use_custom_user_dir=true
config/custom_user_dir_name="limbo-godot"
Expand Down
2 changes: 1 addition & 1 deletion scenes/float_setting.tscn
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[gd_scene load_steps=3 format=3 uid="uid://0sm7268q8a3o"]

[ext_resource type="FontFile" uid="uid://8gxideu8ajla" path="res://fonts/segoeui.ttf" id="1_jcf5r"]
[ext_resource type="FontFile" uid="uid://cav7vtx0re00h" path="res://fonts/selawk.ttf" id="1_jcf5r"]

[sub_resource type="LabelSettings" id="LabelSettings_msxbt"]
font = ExtResource("1_jcf5r")
Expand Down
12 changes: 6 additions & 6 deletions scenes/limbobackground.tscn
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
[ext_resource type="Script" path="res://scripts/limbobackground.gd" id="1_bwegk"]
[ext_resource type="Texture2D" uid="uid://g5finm4rrbaw" path="res://assets/textures/gd_default_background.png" id="1_muvcx"]
[ext_resource type="Texture2D" uid="uid://ce1ratapoehtd" path="res://assets/textures/this_pc_icon_blur.png" id="3_yhpv4"]
[ext_resource type="FontFile" uid="uid://8gxideu8ajla" path="res://fonts/segoeui.ttf" id="4_1q0xr"]
[ext_resource type="FontFile" uid="uid://cav7vtx0re00h" path="res://fonts/selawk.ttf" id="4_1g308"]
[ext_resource type="Texture2D" uid="uid://sb3pwplia0ky" path="res://assets/textures/spike.svg" id="5_jrnkh"]

[sub_resource type="Gradient" id="Gradient_nl0v1"]
Expand All @@ -15,8 +15,8 @@ gradient = SubResource("Gradient_nl0v1")
width = 4096
height = 2048

[sub_resource type="LabelSettings" id="LabelSettings_5yq4b"]
font = ExtResource("4_1q0xr")
[sub_resource type="LabelSettings" id="LabelSettings_pim0r"]
font = ExtResource("4_1g308")
font_size = 20
outline_size = 4
outline_color = Color(0, 0, 0, 1)
Expand Down Expand Up @@ -89,11 +89,11 @@ expand_mode = 1
layout_direction = 1
layout_mode = 0
offset_left = 18.0
offset_top = 95.0
offset_top = 97.0
offset_right = 98.0
offset_bottom = 129.0
offset_bottom = 131.0
text = "This PC"
label_settings = SubResource("LabelSettings_5yq4b")
label_settings = SubResource("LabelSettings_pim0r")
horizontal_alignment = 1

[node name="PCBody" type="CharacterBody2D" parent="SixteenbyNine/ThisPcIconCont"]
Expand Down

0 comments on commit 0f67b2d

Please sign in to comment.