diff --git a/README.md b/README.md new file mode 100644 index 0000000..be19247 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# TheGates browser + +Free and open-source 3D internet browser build with Godot Engine
+It connects game experiences together like world wide web and allows you to easily access them without installing + +[Documentation](https://thegates.readthedocs.io)
+[Other links](https://lnk.bio/thegates) + +## Build + +#### 1. Build godot fork (branch tg-4.2): + +Editor: +``` +scons -j $(nproc) dev_build=yes the_gates_sandbox=no compiledb=yes use_llvm=yes linker=lld disable_exceptions=no +``` + +Sandbox: +``` +scons -j $(nproc) dev_build=yes target=template_debug the_gates_sandbox=yes compiledb=yes use_llvm=yes linker=lld disable_exceptions=no +``` + +#### 2. Create sandbox environment (only linux) + +Run bash command `sandbox/kinda-safe-godot/create_sandbox_env.sh`
+It will create folder **sandbox** with **sandbox_env.zip** file
+Copy **sandbox** folder to godot/bin (alongside with compiled editor and sandbox executables) + +#### 3. Run project + +Start compiled godot editor and open project inside **app** folder + +## Screenshots + +

+

+

diff --git a/screenshots/1-home.png b/screenshots/1-home.png new file mode 100644 index 0000000..1684d39 Binary files /dev/null and b/screenshots/1-home.png differ diff --git a/screenshots/2-search.png b/screenshots/2-search.png new file mode 100644 index 0000000..abec50c Binary files /dev/null and b/screenshots/2-search.png differ diff --git a/screenshots/3-in-game-ui.png b/screenshots/3-in-game-ui.png new file mode 100644 index 0000000..f0127f1 Binary files /dev/null and b/screenshots/3-in-game-ui.png differ