Setup/Build Guide

Setup Guides

Setup ssh

1. Run ssh-keygen -f ~/.ssh/github.com
2. add text below in ~/.ssh/config (if file doesn't exist create one)

Host github.com
  HostName github.com
  PreferredAuthentications publickey
  IdentityFile ~/.ssh/github.com

3. run cat ~/.ssh/github.com.pub and copy the public key
4. go to github ssh settings here
5. press new SSH key, paste your public key, give any title and save

Godot project setup

1. Download and Install Godot 4.4.1

# Arch
sudo pacman -S godot

2. Install lfs

# Arch
sudo pacman -S git-lfs

3. Clone repo

git clone git@github.com:DefineX-Studios/typestroid-mobile.git

and after clone completes try opening one of the image in code/presentation/ts-godot/media/open_license/sprite/ if you can't, pls contact project lead

4. Open Godot and then import project in code\presentation\ts-godot

then press Import after selecting the folder and run the game once to see if it is working properly

Setting up VS Code

1. In Godot goto Editor > Editor Settings > Text Editor > External

2. Enable Use External Editor
3. In the Exec Path Setting, paste in the location of
   1. code.cmd (default: C:/Program Files/Microsoft VS Code/bin/code.cmd) for windows or
   2. /usr/bin/code for linux
4. In Exec Flags, paste in {project} --goto {file}:{line}:{col}
5. Open any script from FileSystem in godot that should open vscode
6. Install godot-tools extention
7. In VS Code settings, in User tab search for godotTools.editorPath.godot4, and paste in the location for godot executable

8. Try running the game from vs code by pressing F5 to check if everything is setup properly

Android build guide (Optional)

1. Install android studio

choco install androidstudio

2. Install Build Template from Project > Install Android Build Template
3. (for release) copy keystore to code\presentation\ts-godot
4. (for debug) create an android project so that debug keystore is created
5. in Project > Export > Android > Keystore add the appropriate information.
6. If you need release info, ask the lead dev