Skip to content

[Docs]: Add installation #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

[Docs]: Add installation #5

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31e94a2
Add installation doc
meatball133 May 7, 2023
9ecfdce
Format gdscript correctly
meatball133 Jun 13, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 46 additions & 9 deletions docs/INSTALLATION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,52 @@
# Installation

<!-- TODO: write document
GDScript is a domain specific language and can thereby requires the godot game engine to be installed.

This document should describe what the student needs to install
to allow working on the track on their local system using the CLI.
## General

You can include the installation instructions in this document, but
usually it is better to link to a resource with the official installation
instructions, to prevent the instructions from becoming outdated.
Working on the track will require the godot engine being setup to run from the terminal.

The contents of this document are displayed on the track's documentation
page at `https://exercism.org/docs/tracks/<track>/installation`.
You can install godot through [gitub][godot-github].
Pick the version marked with your operating system and the version marked as non mono.

See https://exercism.org/docs/building/tracks/docs for more information. -->
You can also install godot through [steam][godot-steam], but it is a bit harder to setup it to work as a cli tool, thereby it is not recommended while working on the track.

## Windows

### Github

First you have to download the bit version which your operating system has (likely 64bit) of the engine from [github][godot-github].
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I appreciate the detailed instructions here, but would it be possible to link the Godot website instead? Again, this is my first Exercism track, so I don't know what is the policy here ;) Do we prefer adding all the necessary information?

Copy link
Member Author

@meatball133 meatball133 Jun 12, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We can link to the website as a download location but removing the whole instruction I don't know.

Well as I see we have 2 options:

Either make each exercise into a godot project and be able to be opened and run within godot. Then would it be fine to link to godot and more or less say: Download and unzip and run.

Option 2 is that we make godot into a terminal tool, unfortunately for windows so is not that easy and Godot has no guide on how to do it. We could tell the user as you said earlier to use the docker container but I don't think that is the intended "exercism" way. And in that case you could more or less just work in the online editor.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But I can tell you as of now that this track is already having a bit of an edge case in how it works. In my ideal world so would godot have a system that when you download godot so does it automatically become an executable cli tool.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The engine installs are available on the official website so I think we can link there so students can get the Godot engine for their OS and then mention the OS specifics for setting up environment variables for *nix, Windows, and MacOS (no more than a sentence or two per OS). We can then break the Steam installation off as an alternative install option at the bottom.

Then you have open up the explorer and navigate to the folder where you downloaded the engine.
Right click on the zip file and press extract all.
Select a folder to extract the engine to and press extract.

### Setup godot to terminal

This tutorial will use powershell 7, other methods might work but are not covered here.

To be able to run godot from powershell you have to add the engine to the path variable.
To do this you have to open up the start menu and search for `edit environment variables for your account`.
Press enter and a window should open up.
Click on the `path` variable and press edit.
Press new and add the path to the folder where you extracted the engine (**not the executable**).

After you have added the path variable you have to add a godot alias to powershell.
Running: `echo $profile` should give you the path to the powershell profile.
Open up the file in a text editor and add the following line:
`New-Alias godot Godot_v<version>-stable_win64_console.exe`

Note: Every time you update the engine you have to redo these steps.

Writing `godot` in powershell should now open up the godot editor.

## Linux

First you have to download the bit version which your operating system has (likely 64bit) of the engine from [github][godot-github] and pick the non mono version.
To download write the following in the terminal: `sudo wget https://github.com/godotengine/godot/releases/download/<version>-stable/Godot_v<version>-stable_linux.x86_64.zip`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we specify that has to be at least 4 for this runner? We don't plan to support Godot 3, right?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah we could mention it, we just have to have a reminder to update that label every time we update the version.

Then you have to unzip, `unzip Godot_v<version>-stable_linux.x86_64.zip`.
Then you have to move the engine to the `/usr/local/bin` folder, `sudo mv Godot_v<version>-stable_linux.x86_64 /usr/local/bin/godot`.

To verify that the engine is installed correctly you can write `godot --version` in the terminal.

[godot-github]: https://github.com/godotengine/godot/releases
[godot-steam]: https://store.steampowered.com/app/404790/Godot_Engine/