37 lines
1.9 KiB
Markdown
37 lines
1.9 KiB
Markdown
# StarOpenSource CORE (aka. SOSCORE aka. CORE) [](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.](https://git.staropensource.de/StarOpenSource/core/wiki)
|
|
|
|
# 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](https://git.staropensource.de/StarOpenSource/core/wiki/Using-CORE)
|
|
|
|
# How to update
|
|
- Close your project
|
|
- Pull new changes using `git pull`
|
|
- [Check for commits that break things](https://git.staropensource.de/StarOpenSource/core/wiki/Updating-CORE)
|
|
- Reopen your project
|