CORE/docs/index.md
2023-07-29 20:43:45 +02:00

1.6 KiB

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.

I have a problem with CORE!

First of all, read the Troubleshooting guide. If you can't find your error or it's some incompatibility with CORE and project x, create a issue.

How to install/update CORE?

If you want to install CORE, follow this guide. If you want to update CORE to the latest version instead, follow this guide instead.

Where are the code references?

Look at the reference index 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 or writing a email at support@staropensource.de