The CORE Framework, simplifying game and app development since 2023
Find a file
JeremyStarTM e3a8339a0d Did some changes
Modified the title, moved the documentation link to the top and modified the "How to install" and "How to update" sections.
2023-03-18 18:11:57 +01:00
.gitignore Initial commit 2023-03-18 16:34:12 +01:00
autoload.gd Added autoloader and welcome() function 2023-03-18 18:02:07 +01:00
background.tscn Initial commit 2023-03-18 16:34:12 +01:00
config.gd Initial commit 2023-03-18 16:34:12 +01:00
core.gd Added autoloader and welcome() function 2023-03-18 18:02:07 +01:00
coreloader.gd Added autoloader and welcome() function 2023-03-18 18:02:07 +01:00
corelog.gd Initial commit 2023-03-18 16:34:12 +01:00
hack.ttf Initial commit 2023-03-18 16:34:12 +01:00
LICENSE Initial commit 2023-03-18 16:34:12 +01:00
logger.gd Initial commit 2023-03-18 16:34:12 +01:00
preprocessor.gd Initial commit 2023-03-18 16:34:12 +01:00
README.md Did some changes 2023-03-18 18:11:57 +01:00
smgr.gd Added debug overlay support 2023-03-18 18:02:17 +01:00
wmgr.gd Initial commit 2023-03-18 16:34:12 +01:00

StarOpenSource CORE (aka. SOSCORE aka. CORE)

CORE is a framework that simplifies development for games and applications made in Godot 4.

Documentaton

You can access the documentation by clicking this text.

For whom is it useful?

CORE is only useful for new projects. Started projects could break because CORE has certain requirements that must be met.

Requirements

  • No autoload singletons are allowed before CORE has initialized
  • Startup scene must be res://CORE/background.tscn
  • Scene management must be done with smgr (the CORE scene manager)
  • Logging should be handled using the CORE logger

How to install

  • Clone CORE into your project root using git clone https://git.staropensource.de/StarOpenSource/core.git CORE
  • Remove any autoload singletons
  • Add three scripts to your autoload:
    Name Path
    coreloader res://CORE/coreloader.gd
    Logger res://CORE/logger.gd
    Preprocessor res://CORE/preprocessor.gd
  • Select res://CORE/background.tscn as your startup scene
  • Follow the post-installation guide

How to update

  • Close your project
  • Pull new changes using git pull
  • Reopen your project