JeremyStarTM
99703cf03e
Reviewed-on: StarOpenSource/core#1 Rewrote CORE and improved the startup process and startup time significantly. The documentation has been beefed up too and is now much better. Existing projects may need major refactoring however. Co-authored-by: JeremyStarTM <jeremystartm@staropensource.de> Co-committed-by: JeremyStarTM <jeremystartm@staropensource.de>
27 lines
1.6 KiB
Markdown
27 lines
1.6 KiB
Markdown
---
|
|
hide:
|
|
- navigation
|
|
---
|
|
# Home
|
|
Welcome to the StarOpenSource documentation! Look below for more information about CORE and code references.
|
|
|
|
## What, why, wtf?
|
|
The **StarOpenSource CORE Framework** (also known as **CORE** or **SOSCORE**) is a framework that makes the development of games and applications written in **Godot 4.1** easier. CORE implements useful & common functions *(such as calculating the current FPS)* and provides a logging system that even supports formatting, a scene manager and so much more.
|
|
|
|
## Can I use CORE in my existing project?
|
|
Yes, unless you want to refactor your entire project. Remember: CORE is a framework, NOT a library and NOT a regular addon!
|
|
|
|
## Can I use CORE in my project freely?
|
|
[Click this text to learn more about licensing.](/licensing/)
|
|
|
|
## I have a problem with CORE!
|
|
First of all, read the [Troubleshooting guide](/troubleshooting/). If you can't find your error in there or CORE has a compatibility issue with some addon, look at [the issue tracker](https://git.staropensource.de/StarOpenSource/issues) for more information.
|
|
|
|
## How to install/update CORE?
|
|
If you want to install CORE, follow [this guide](/install/). If you want to update CORE to the latest version instead, follow [this guide](/update/) instead.
|
|
|
|
## Where are the code references?
|
|
Look at the [reference index](/references/) for a list of all available methods and variables.
|
|
|
|
## How can I contact you?
|
|
You can contact us by either writing a post in the fediverse and mentioning **[@soscore@net.staropensource.de](https://net.staropensource.de/@soscore)** or writing a email at **[support@staropensource.de](mailto:support@staropensource.de)**
|