Skip to main content

Setup/Build Guide

Setup Guides

Setup ssh

  1. Run ssh-keygen and
    2. use
  2. enter this location when asked ~/.ssh/github.com
  3. add this in ~/.ssh/config (if file doesn't exist create one)
Host github.com
  HostName github.com
  PreferredAuthentications publickey
  IdentityFile ~/.ssh/github.com
  1. run cat ~/.ssh/github.com.pub and copy the public key
  2. go to github ssh settings here
  3. press new SSH key and paste your public key here

Godot project setup

  1. Install godot
# Windows
choco install godot --version=4.3.0

# CachyOS
sudo paru -S godot
  1. Install lfs
# Arch
sudo paru -S git-lfs
  1. Clone repo
git clone git@github.com:DefineX-Studios/typestroid-mobile.git
  1. Import godot project in code\presentation\ts-godot

Setting up VS Code

  1. Editor > Editor Settings > Text Editor > External
  2. Enable Use External Editor
  3. Paste in path of code.cmd (default: C:/Program Files/Microsoft VS Code/bin/code.cmd)
  4. Paste in {project} --goto {file}:{line}:{col} in flags
  5. Open any script from FileSystem that should open vscode
  6. Install godot-tools extention
  7. if you haven't installed godot through package managers, add godot executable in vscode settings godotTools.editorPath.godot4

Android build guide (Optional)

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