-
-
Notifications
You must be signed in to change notification settings - Fork 6
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
205 changed files
with
19,746 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
module.exports = { | ||
presets: [require.resolve('@docusaurus/core/lib/babel/preset')], | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
--- | ||
sidebar_position: 5 | ||
toc_max_heading_level: 4 | ||
--- | ||
|
||
# Complying with licenses | ||
|
||
## What are licenses? | ||
|
||
Orchestrator is created and distributed under the <ExternalLink href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</ExternalLink> license. | ||
The project does not have a sole owner, as every contributor that submits code to the project does so under the same license and keeps ownership of their contributions. | ||
|
||
The license is the legal requirement for you (or your company) to use and distribute the software (and derivative works, including games made with it). | ||
Your game or project can have a difference license, but it still needs to comply with the original one. | ||
|
||
:::warning | ||
In your project's credits screen, remember to also list third-party notices for assets you're using, such as textures, models, sounds, music, and fonts. | ||
|
||
Free assets in particular often come with licenses that require attribution. | ||
Double-check their licenses before using those in public projects. | ||
::: | ||
|
||
### Requirements | ||
|
||
For derived works that include Orchestrator, but do not modify or change its source, should include the following: | ||
|
||
```text | ||
This game uses Orchestrator, which is available under the following license: | ||
Copyright (c) 2023-present Vahera Studios, LLC and it's contributors. | ||
Licensed under the Apache License, Version 2.0 (the "License"); | ||
you may not use this file except in compliance with the License. | ||
You may obtain a copy of the License at | ||
http://www.apache.org/licenses/LICENSE-2.0 | ||
Unless required by applicable law or agreed to in writing, software | ||
distributed under the License is distributed on an "AS IS" BASIS, | ||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
See the License for the specific language governing permissions and | ||
limitations under the License. | ||
``` | ||
|
||
:::warning | ||
For works that included a modified build of Orchestrator, be sure to comply with the full Apache License, Version 2.0 requirements regarding tracking changes, and that all source files of the original work retain the `Copyright (c) 2023-present Vahera Studios, LLC and its contributors` copyright and the Apache License, Version 2.0 text in each source file. | ||
::: | ||
|
||
:::info | ||
Your game does not need to be under the same license as Orchestrator. | ||
You are free to release your Godot projects under any license and to create commercial games with this plug-in. | ||
::: | ||
|
||
### Inclusion | ||
|
||
The license does not specify specifically how it must be included in your game, so there are a number of options that you can freely use depending on how you distribute or wish to share license information with your users. | ||
These are the most common approaches and you only need to implement one, not all. | ||
|
||
#### Credits screen | ||
|
||
Include the above license text somewhere in the credits screen. | ||
It can be at the bottom after showing the rest of the credits. | ||
Most studios use this approach with open source licenses. | ||
|
||
#### Licenses screen | ||
|
||
Some games have a special menu (often in the settings) to display licenses. | ||
This menu is typically accessed with a button called `Third-party Licenses` or `Open Source Licenses`. | ||
|
||
#### Accompanying file | ||
|
||
If the game is distributed on desktop platforms, a file that contains the license text can be added to the software that is installed on the user's PC. | ||
|
||
#### Printed manual | ||
|
||
If the game includes printed manuals, license text can be included there. | ||
|
||
### Third-party licenses | ||
|
||
#### Godot GDExtension (godot-cpp) | ||
```text | ||
Copyright (c) 2017-present Godot Engine contributors. | ||
Permission is hereby granted, free of charge, to any person obtaining a copy of this software | ||
and associated documentation files (the "Software"), to deal in the Software without restriction, | ||
including without limitation the rights to use, copy, modify, merge, publish, distribute, | ||
sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
The above copyright notice and this permission notice shall be included in all copies or | ||
substantial portions of the Software. | ||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING | ||
BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND | ||
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, | ||
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
sidebar_position: 7 | ||
--- | ||
|
||
# Credits | ||
|
||
| Image Names | Attribution | License | | ||
|:--------------------------------------------------|:------------------------------------------------------|:------------------------------------------------------------------------------------------------------------------| | ||
| scripting_first_script_rotating_godot.gif | Juan Linietsky, Ariel Manzur and the Godot community. | <ExternalLink href="https://github.com/godotengine/godot-docs/blob/master/LICENSE.txt">LICENSE.txt</ExternalLink> | | ||
| scripting_first_script_add_sprite_node.gif | Juan Linietsky, Ariel Manzur and the Godot community. | <ExternalLink href="https://github.com/godotengine/godot-docs/blob/master/LICENSE.txt">LICENSE.txt</ExternalLink> | | ||
| scripting_first_script_add_sprite_node.gif | Juan Linietsky, Ariel Manzur and the Godot community. | <ExternalLink href="https://github.com/godotengine/godot-docs/blob/master/LICENSE.txt">LICENSE.txt</ExternalLink> | | ||
| scripting_first_script_scene_tree.gif | Juan Linietsky, Ariel Manzur and the Godot community. | <ExternalLink href="https://github.com/godotengine/godot-docs/blob/master/LICENSE.txt">LICENSE.txt</ExternalLink> | | ||
| scripting_first_script_setting_texture.gif | Juan Linietsky, Ariel Manzur and the Godot community. | <ExternalLink href="https://github.com/godotengine/godot-docs/blob/master/LICENSE.txt">LICENSE.txt</ExternalLink> | | ||
| scripting_first_script_centering_sprite.gif | Juan Linietsky, Ariel Manzur and the Godot community. | <ExternalLink href="https://github.com/godotengine/godot-docs/blob/master/LICENSE.txt">LICENSE.txt</ExternalLink> | | ||
| scripting_first_script_print_hello_world.gif | Juan Linietsky, Ariel Manzur and the Godot community. | <ExternalLink href="https://github.com/godotengine/godot-docs/blob/master/LICENSE.txt">LICENSE.txt</ExternalLink> | | ||
| scripting_first_script_godot_turning_in_place.gif | Juan Linietsky, Ariel Manzur and the Godot community. | <ExternalLink href="https://github.com/godotengine/godot-docs/blob/master/LICENSE.txt">LICENSE.txt</ExternalLink> | | ||
| scripting_first_script_rotating_godot.gif | Juan Linietsky, Ariel Manzur and the Godot community. | <ExternalLink href="https://github.com/godotengine/godot-docs/blob/master/LICENSE.txt">LICENSE.txt</ExternalLink> | | ||
| scripting_first_script_moving_with_input.gif | Juan Linietsky, Ariel Manzur and the Godot community. | <ExternalLink href="https://github.com/godotengine/godot-docs/blob/master/LICENSE.txt">LICENSE.txt</ExternalLink> | | ||
| key_concepts_main_menu.gif | Juan Linietsky, Ariel Manzur and the Godot community. | <ExternalLink href="https://github.com/godotengine/godot-docs/blob/master/LICENSE.txt">LICENSE.txt</ExternalLink> | | ||
| key_concepts_character_nodes.gif | Juan Linietsky, Ariel Manzur and the Godot community. | <ExternalLink href="https://github.com/godotengine/godot-docs/blob/master/LICENSE.txt">LICENSE.txt</ExternalLink> | | ||
| key_concepts_signals.gif | Juan Linietsky, Ariel Manzur and the Godot community. | <ExternalLink href="https://github.com/godotengine/godot-docs/blob/master/LICENSE.txt">LICENSE.txt</ExternalLink> | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
--- | ||
sidebar_position: 6 | ||
--- | ||
|
||
# Documentation changelog | ||
|
||
The documentation is continually being improved. | ||
New releases include new pages, fixes, and updates to existing pages, and many updates to the **Script Node Reference**. | ||
Below is a list of new pages added since version 2.0. | ||
|
||
:::info | ||
This document only contains new pages so not all changes are reflected. | ||
::: | ||
|
||
### New pages since version 2.0 | ||
|
||
None. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
--- | ||
sidebar_position: 4 | ||
--- | ||
|
||
# Frequently asked questions | ||
|
||
## General | ||
|
||
* **What license is Orchestrator code under?**<br/> | ||
Orchestrator is licensed under the <ExternalLink href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</ExternalLink>. | ||
|
||
* **What license is Orchestrator logo and marketing images under?**<br/> | ||
The Orchestrator logo and marketing images, including this website, are Copyright © 2023 Vahera Studios. All Rights Reserved. | ||
|
||
* **Do you offer support for this plugin?**<br/> | ||
Yes, we are committed to providing support for our plugin, simply leave your questions on our discord. | ||
|
||
* **Where can I find the source code for Orchestrator?**<br/> | ||
You can find the source code on our <ExternalLink href="https://github.com/Vahera/godot-orchestrator">GitHub repository</ExternalLink>. | ||
|
||
* **I have a suggestion or idea, how do I provide this to you?**<br/> | ||
Feel free to leave it in our discord in the `#suggestions` channel, or our <ExternalLink href="https://github.com/Vahera/godot-orchestrator">GitHub repository</ExternalLink>. | ||
|
||
* **Are you affiliated with Godot or the Godot Engine?**<br/> | ||
No, Vahera Studios is not affiliated with Godot or the Godot Engine. | ||
|
||
* **Does Orchestrator support Godot 4.2 and above?**<br/> | ||
Yes, Orchestrator supports Godot 4.2 and above. It does not work with any version of Godot prior to 4.2. | ||
|
||
## Troubleshooting | ||
|
||
* **Error: "Required virtual method ScriptExtension::_get_language must be overridden before calling."**<br/> | ||
This is an unfortunate bug in the Godot engine, and it's normal for GDExtension plug-ins. | ||
This will have no impact on the plug-in's stability, so it's safe to ignore. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
sidebar_position: 1 | ||
title: About | ||
slug: / | ||
--- | ||
|
||
# Godot Orchestrator Docs | ||
|
||
:::info | ||
Orchestrator's documentation is available in various languages and versions. | ||
Expand the language or version selector in the top navigation panel to see the possible values. | ||
::: | ||
|
||
Welcome to the official documentation of <ExternalLink href="https://orchestrator.vahera.com">Orchestrator</ExternalLink>, the ultimate Visual Scripting solution specific designed for Godot platform 4.2 and later. | ||
If you are new to this documentation, we recommend that you read the [introduction page](./introduction.md) to get an overview of what this documentation has to offer. | ||
|
||
The table of contents in the sidebar should let you easily access the documentation for your topic of interest. | ||
|
||
## Get involved | ||
|
||
Orchestrator is an open source project developed by Vahera Studios, LLC in collaboration with a community of volunteers. | ||
The documentation team can always use feedback and help to improve tutorials, class reference guides, and more. | ||
If you don't understand something, or cannot find what you are looking for in the docs, help us make the documentation better by letting us know! | ||
|
||
Submit an issue or pull request on the <ExternalLink href="https://github.com/Vahera/godot-orchestrator-docs">GitHub repository</ExternalLink> or help translate the documentation into other languages. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,63 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Introduction | ||
|
||
Welcome to the official documentation of **Orchestrator**, the ultimate Visual-Scripting plug-in for Godot. | ||
Orchestrator is a powerful, yet user-friendly plug-in that you can use to develop any type of game. | ||
|
||
This page gives a broad overview of the plug-in and this documentation, so you know where to start if you are a beginner or where to look should you need more specific information on a feature. | ||
|
||
## Before you start | ||
|
||
The [Tutorials and resources](../community/tutorials-and-resources) page has a list of video tutorials contributed by various authors, including the authors of the plug-in. | ||
If you prefer video to text, consider checking them out. | ||
Otherwise, [Getting Started](../getting-started/introduction) is a great starting point. | ||
|
||
In case you have trouble with one of the tutorials or your project, you can always find help through the Vahera Studios Discord community, our Forums, or the Godot Discord. | ||
|
||
## About Orchestrator | ||
|
||
Every game emerges from a single idea, and the creation of a game involves many moving parts. | ||
Godot Orchestrator's goal is to provide a series of easy to use, highly customizable features to create game logic, interactions, and supporting logic using visual scripting rather than traditional text-based code. | ||
|
||
Orchestrator is completely free and open source under the <ExternalLink href="https://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</ExternalLink>. | ||
The game you create is yours, down to the last line of code. | ||
This plug-in's development is fully independent and entirely community-driven, giving the community the ability to shape the plug-in's future for their needs and expectations. | ||
|
||
## Organization of the documentation | ||
|
||
This documentation is organized into several sections: | ||
|
||
* **About** contains this introduction, as well as information about the plug-in, its history, licensing, authors, and more. | ||
It also contains the [Frequently asked questions](../about/faq) | ||
|
||
* **Getting Started** contains all necessary information on using the plug-in to make games. | ||
It starts with a **Step by Step** tutorial which should be the entry point for all new users. | ||
**This is the best place to start if you're new**! | ||
|
||
* The **Manual** can be read or referenced as needed, in any order. | ||
It contains feature-specific tutorials and documentation. | ||
|
||
* **Contributing** provides information related to contributing back to Orchestrator, whether to the plug-in's code, documentation, examples, or other aspects. | ||
It describes how to report bugs, how contributor workflows are organized, and more. | ||
It also has sections intended for advanced users and contributors, with information on compiling the plug-in. | ||
|
||
* **Community** is dedicated to the life of the Orchestrator plug-in's community. | ||
It refers to various community outlets and discords, and contains a list of recommended tutorials and materials beyond this documentation. | ||
|
||
In addition to this documentation, you may also want to take a look at the various <ExternalLink href="https://github.com/Vahera/godot-orchestrator-examples">Orchestrator example projects</ExternalLink>. | ||
|
||
## About this documentation | ||
|
||
The Orchestrator community continuously writes, corrects, edits, and improves this documentation. | ||
We are always looking for more help. | ||
You can also contribute by opening GitHub issues or translating the documentation into your own language. | ||
If you are interested in helping, see [Ways to contribute](../contributing/ways-to-contribute) and [Writing documentation](../contributing/writing-documentation), or get in touch with the team on <ExternalLink href="https://discord.gg/J3UWtzWSkT">Discord</ExternalLink>. | ||
|
||
All documentation content is licensed under the permissive Creative Commons Attribution 3.0 (<ExternalLink href="https://creativecommons.org/licenses/by/3.0/">CC BY 3.0</ExternalLink>) license, with attribution to *"Vahera Studios, LLC and the community"* unless otherwise noted. | ||
|
||
***Have fun reading and making games with Orchestrator!*** | ||
|
||
|
Oops, something went wrong.