Create a script to set up new GDExtension development environment

This commit is contained in:
Serhii Snitsaruk 2024-01-11 15:08:11 +01:00
parent 52f218e6b9
commit 3af6995fd0
3 changed files with 148 additions and 3 deletions

3
.gitignore vendored
View File

@ -1,3 +1,6 @@
# LimboAI-specific
demo/addons/
# Godot auto generated files
*.gen.*
.import/

105
gdextension/setup_gdextension.sh Executable file
View File

@ -0,0 +1,105 @@
#!/bin/bash
## This script creates project structure needed for LimboAI development using GDExtension.
## Works only on Unix-likes. You can still use the directory layout below, if you are on Windows.
##
## Instructions:
## 1) Create the project root directory, name doesn't matter.
## 2) Inside the project root directory, clone the limboai repository:
## git clone https://github.com/limbonaut/limboai
## 3) From the project root directory, run:
## bash ./limboai/gdextension/setup_gdextension.sh
##
## Directory layout:
## project/ -- call this script from here, directory name doesn't matter.
## project/limboai/ -- LimboAI repository should be here after you clone it.
## project/godot-cpp/ -- will be created by this script.
## project/demo/ -- symbolic link that will be created by this script.
## project/SConstruct -- symbolic link that will be created by this script.
##
## Dependencies: bash, git, python3.
# Script Settings
GODOT_CPP_VERSION=4.2
PYTHON=python
# Colors
HIGHLIGHT_COLOR='\033[1;36m' # Light Cyan
NC='\033[0m' # No Color
ERROR_COLOR="\033[0;31m" # Red
msg () { echo -e "$@"; }
highlight() { echo -e "${HIGHLIGHT_COLOR}$@${NC}"; }
error () { echo -e "${ERROR_COLOR}$@${NC}" >&2; }
if [ ! -d "${PWD}/limboai/" ]; then
error Aborting: \"limboai\" subdirectory is not found.
msg Tip: Run this script from the project root directory with limboai repository cloned into \"limboai\" subdirectory.
msg Command: bash ./limboai/gdextension/setup_gdextension.sh
exit 1
fi
# Interrupt execution and exit on Ctrl-C
trap exit SIGINT
set -e
highlight Setup started.
if [ ! -d "${PWD}/godot-cpp/" ]; then
highlight -- Cloning godot-cpp...
git clone -b ${GODOT_CPP_VERSION} https://github.com/godotengine/godot-cpp
highlight -- Finished cloning godot-cpp.
else
highlight -- Skipping \"godot-cpp\". Directory already exists!
fi
if [ ! -f "${PWD}/SConstruct" ]; then
ln -s limboai/gdextension/SConstruct SConstruct
highlight -- Linked SConstruct.
else
highlight -- Skipping \"SConstruct\". File already exists!
fi
if [ ! -e "${PWD}/demo" ]; then
ln -s limboai/demo demo
highlight -- Linked demo project.
else
highlight -- Skipping \"demo\". File already exists!
fi
# if [ -d "${PWD}/demo/" ]; then
# highlight -- Demo project exists. Archiving...
# backup_version=1
# backup_dir="${PWD}/demo.old${backup_version}"
# while [ -d "${backup_dir}" ]; do
# ((backup_version++))
# backup_dir="${PWD}/demo.old${backup_version}"
# done
# mv demo/ ${backup_dir}
# highlight -- Demo project archived as \"$(basename ${backup_dir})\".
# fi
# if [ ! -d "${PWD}/demo/" ]; then
# cp -r limboai/demo demo
# highlight -- Copied demo project.
# else
# error Error: \"demo\" directory exists!
# exit 2
# fi
if [ ! -e "${PWD}/demo/addons/limboai/bin/limboai.gdextension" ]; then
mkdir -p demo/addons/limboai/bin/
# cp limboai/gdextension/limboai.gdextension demo/addons/limboai/bin/limboai.gdextension
pushd demo/addons/limboai/bin/ > /dev/null
ln -s ../../../../gdextension/limboai.gdextension limboai.gdextension
popd > /dev/null
highlight -- Linked limboai.gdextension.
else
highlight -- Skipping limboai.gdextension. File already exists!
fi
${PYTHON} limboai/gdextension/update_icons.py --silent
highlight -- Icon declarations updated.
highlight Setup complete.

View File

@ -1,13 +1,50 @@
#!/usr/bin/python
"""
Usage: update_icons.py [--silent]
Update icon declarations in limboai.gdextension file.
Options:
-s, --silent Don't print anything.
-h, --help Print this message.
Dependencies: python3.
Use of this source code is governed by an MIT-style
license that can be found in the LICENSE file or at
https://opensource.org/licenses/MIT.
"""
import os
import glob
import sys
import getopt
def usage():
print(__doc__.strip())
def get_script_dir():
return os.path.dirname(os.path.realpath(__file__))
def main():
silent = False
try:
opts, args = getopt.getopt(sys.argv[1:],
"s", ["silent"])
except getopt.GetoptError as e:
print('%s: %s!\n' % (os.path.basename(__file__), e.msg,))
usage()
sys.exit(2)
for opt, arg in opts:
if opt in ('-h', '--help'):
usage()
sys.exit(0)
elif opt in ('-s','--silent'):
silent = True
config_dir = get_script_dir()
config_path = os.path.join(config_dir, "limboai.gdextension")
content = ""
@ -30,9 +67,9 @@ def main():
f.write(content)
f.close()
if not silent:
print(content)
print("--------------------------------------------------------------------------------------")
print("Done!")
print("======= Icon declarations updated =======")
if __name__ == "__main__":