-
-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
refs #147: stubbed a bunch of pages and sections.
- Loading branch information
1 parent
2f7c8ff
commit 7cb4843
Showing
10 changed files
with
98 additions
and
1 deletion.
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
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,19 @@ | ||
Everything you need to start creating your adventure game with Popochiu, beside the addon, is a good idea, assets and the game script. | ||
|
||
When working on a new project, Popochiu will set the project up for you but other than that, it will provide you with a blank slate so that you don't need to clean the stage from unwanted stuff. | ||
|
||
If you are testing or learning the engine, or if you suffer from blank canvas syndrome, don't worry. We've got you covered! | ||
|
||
## Example game | ||
|
||
TODO | ||
|
||
* Explain a game repository is available (which version?) | ||
* Provide a link to the repository and brief instructions on how to use it | ||
|
||
## Example assets | ||
|
||
TODO | ||
|
||
* Explain a set of assets (same ones used in the Example game) is available | ||
* Provide a link to a zip file |
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,19 @@ | ||
## Join our community | ||
|
||
We do our best to keep this documentation relevant and up to date, but we know that there are nuances and needs that will go beyond what we can provide. | ||
|
||
That's where our community kicks in. | ||
TODO: insert link and explanation about the discord server. | ||
TODO: explain how to provide help in the community | ||
|
||
## GitHub | ||
|
||
If you found a bug or if you want to propose an improvement, GitHub is the place to head to. | ||
|
||
TODO: explain how we approach issues, the different type of issues, where to see the project roadmap. | ||
TODO: link the contribution guide. | ||
|
||
|
||
## Godot community and docs | ||
|
||
TODO: Mention that Godot is a reference to keep in sight |
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,15 @@ | ||
## Tutorials | ||
|
||
TODO | ||
|
||
## Video Tutorials | ||
|
||
The following video tutorials (English subs) are available for Popochiu 1: | ||
|
||
- [How to setup your project, create a room and a character](https://youtu.be/-N62S1DHbcs) | ||
- [What are the baselines, how to create gaps and how to use Hotspots](https://youtu.be/5RbqbG3_0ak) | ||
- [How to create Props with interaction and inventory items](https://youtu.be/_an0YF3Bd50) | ||
- [How to create dialog trees](https://youtu.be/Aql4wh2itF4) | ||
- [How to enable/disable dialog options and use inventory items on characters, Props and Hotspots](https://youtu.be/Ad_YBG-_wYE) | ||
- [How to setup a room bigger than the game window, and how to move between rooms](https://youtu.be/YFEZaSty3aw) | ||
- [How to add sound effects, music, voices, and graphic interface sounds](https://youtu.be/VF7V6BJmQVQ) |
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 @@ | ||
TODO: how to reach the editor settings and set them up |
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 @@ | ||
TODO: port the importer section here |
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,22 @@ | ||
## Editor Settings | ||
|
||
TODO | ||
|
||
## Popochiu dock | ||
|
||
The core of Popochiu editor functions, this panel allows to navigate the game objects without the need to access the scene tree. | ||
|
||
TODO complete, fix links | ||
|
||
* [Main tab]() - Used to work with the main Objects of the game: Rooms, Characters, Inventory items, Dialogs. | ||
* [Room tab]() - Used to work with the Objects of a Room when it is the active scene in the **2D** editor. It shows the Props, Hotspots, Walkable areas, and Regions of the room. | ||
* [Audio tab]() - Used to show the audio clips that can be played in the game. They are grouped in Music, Sound effects, Voices, and Graphic interface. | ||
* [Settings]() - Used to modify properties related to the game behavior. | ||
|
||
## Toolbar buttons | ||
|
||
TODO | ||
|
||
## Inspectors | ||
|
||
TODO |
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,13 @@ | ||
![Popochiu dock](./images/getting_started-popochiu_dock.png) | ||
|
||
The Popochiu dock consists of different tabs, used to group the objects that build the game. | ||
|
||
## Main tab | ||
|
||
## Room tab | ||
|
||
## Audio tab | ||
|
||
## GUI tab | ||
|
||
TODO: fill all the sections |
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,7 @@ | ||
TODO: all differet toolbar buttons by popochiu object | ||
|
||
## Character | ||
|
||
## Props | ||
|
||
## ... |
Empty file.