The CORE Framework, simplifying game and app development since 2023
Find a file
2023-06-29 19:36:14 +02:00
.gitignore Renamed config.gd to config.gd.example 2023-03-19 14:35:34 +01:00
autoload.gd Added events and resmgr API + improved startup 2023-05-29 20:46:47 +02:00
background.tscn Removed uid from hack.tscn to avoid warnings 2023-03-19 14:33:14 +01:00
config.gd.example Add image to README and splash api 2023-06-29 17:22:13 +02:00
core.gd Add image to README and splash api 2023-06-29 17:22:13 +02:00
coreinit.gd Added missing core file header to coreinit.gd 2023-03-19 14:23:14 +01:00
coreinit.tscn Added coreinit and cut down one autoload singleton 2023-03-19 13:14:30 +01:00
coreloader.gd Add image to README and splash api 2023-06-29 17:22:13 +02:00
corelog.gd wmgr respects config & corelog window size now 2023-05-30 02:44:10 +02:00
events.gd Added events and resmgr API + improved startup 2023-05-29 20:46:47 +02: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 Added color support for logger 2023-06-29 19:36:14 +02:00
preprocessor.gd Initial commit 2023-03-18 16:34:12 +01:00
README.md Add image to README and splash api 2023-06-29 17:22:13 +02:00
resmgr.gd Added events and resmgr API + improved startup 2023-05-29 20:46:47 +02:00
smgr.gd Remove dumb scene_name variables 2023-05-30 02:42:05 +02:00
soscore.png Add image to README and splash api 2023-06-29 17:22:13 +02:00
splash.gd Add image to README and splash api 2023-06-29 17:22:13 +02:00
splash.tscn Add image to README and splash api 2023-06-29 17:22:13 +02:00
wmgr.gd Fix get_delta() causing issues 2023-06-26 20:27:22 +02:00

# StarOpenSource CORE (aka. SOSCORE aka. CORE) [![Please don't upload to GitHub](https://nogithub.codeberg.page/badge.svg)](https://nogithub.codeberg.page) SOSCORE/CORE is a framework that simplifies development for games and applications made in Godot 4.

Development status

CORE is not yet ready for production as it is in rapid development. Only use it in temporary/testing projects for now.

Documentaton

You can access the documentation by clicking this text.

For whom is it useful?

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

Requirements

  • Godot 4.0 (only stable releases)
  • No autoload singletons are allowed before CORE has initialized
  • Startup scene must be res://CORE/coreinit.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
    NOTE: Please execute git submodule init and then git submodule add https://git.staropensource.de/staropensource/core.git CORE instead if you are using a git repository for your app/game already.
  • Remove any autoload singletons
  • Add three scripts to your autoload:
    Name Path
    Logger res://CORE/logger.gd
    Preprocessor res://CORE/preprocessor.gd
  • Select res://CORE/coreinit.tscn as your startup scene
  • Duplicate config.gd.example and name it config.gd
  • Follow the post-installation guide

How to update