JeremyStarTM
83ea84b9ab
This commit added: - A website and documentation (two in one) containing a install guide and code references - Character counting script (count_characters.sh) - Godot development project support (making a temporary godot project) - Makefile
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.0 and 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?
|
|
In theory, yes. But if you don't want to refactor a large part of your codebase, don't install CORE.
|
|
|
|
## 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 or it's some incompatibility with CORE and project x, [create a issue](https://git.staropensource.de/StarOpenSource/core/issues/new).
|
|
|
|
## 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](/refrences/) 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)**
|