CORE/README.md

34 lines
1.6 KiB
Markdown
Raw Normal View History

# StarOpenSource CORE (aka. SOSCORE aka. CORE)
2023-03-18 16:34:12 +01:00
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.](https://git.staropensource.de/StarOpenSource/core/wiki)
2023-03-18 16:34:12 +01:00
# For whom is it useful?
2023-03-18 18:43:40 +01:00
CORE is only useful for new projects. Already existing projects could break because CORE has certain requirements that must be met.
2023-03-18 16:34:12 +01:00
# Requirements
2023-03-19 13:15:14 +01:00
- Godot 4.0 (only stable releases)
- No autoload singletons are allowed before CORE has initialized
- Startup scene must be `res://CORE/coreinit.tscn`
2023-03-18 16:34:12 +01:00
- 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
2023-03-18 16:34:12 +01:00
- Add three scripts to your autoload:
2023-03-18 18:45:00 +01:00
| Name | Path |
| ------------ | ---------------------------- |
| Logger | `res://CORE/logger.gd` |
| Preprocessor | `res://CORE/preprocessor.gd` |
- Select `res://CORE/coreinit.tscn` as your startup scene
- [Follow the post-installation guide](https://git.staropensource.de/StarOpenSource/core/wiki/Using-CORE)
2023-03-18 16:34:12 +01:00
# How to update
- Close your project
2023-03-18 16:34:12 +01:00
- Pull new changes using `git pull`
- [Check for commits that break things](https://git.staropensource.de/StarOpenSource/core/wiki/Updating-CORE)
- Reopen your project