Optimized Docs (#7)
Authored-by: Dennis Ploeger <develop@dieploegers.de>
This commit is contained in:
60
README.md
60
README.md
@@ -1,10 +1,8 @@
|
||||
# Escoria Rewrite
|
||||
|
||||
Libre framework for the creation of point-and-click adventure games with
|
||||
the MIT-licensed multi-platform game engine [Godot Engine](https://godotengine.org).
|
||||
Libre framework for the creation of point-and-click adventure games with the MIT-licensed multi-platform game engine [Godot Engine](https://godotengine.org).
|
||||
|
||||
It is designed so that you can claim it for yourself and modify it to match
|
||||
the needs of your specific game and team.
|
||||
It is designed so that you can claim it for yourself and modify it to match the needs of your specific game and team.
|
||||
|
||||
This repository is big rewrite of the original [Escoria framework](https://github.com/godotengine/escoria/tree/master). Its purpose is to make Escoria work as a plugin for the Godot Engine editor, instead of being a collection of scripts and scenes. It is intended to be easier to use and easier to maintain.
|
||||
|
||||
@@ -14,8 +12,9 @@ If you're encountering issues or incompatibilities, please raise an issue on [Es
|
||||
|
||||
This framework was initially developed for the adventure game
|
||||
[The Interactive Adventures of Dog Mendonça and Pizzaboy®](http://store.steampowered.com/app/330420)
|
||||
and later streamlined for broader usages and open sourced as promised
|
||||
to the backers of the Dog Mendonça Kickstarter campaign.
|
||||
and later streamlined for broader usages and open sourced as promised to the backers of the Dog Mendonça Kickstarter campaign.
|
||||
|
||||
Because of maintainability issues and to make the framework easier for new developers and bring it closer to Godot's standards, the framework was completely rewritten and optimized.
|
||||
|
||||
## Authors
|
||||
|
||||
@@ -31,10 +30,11 @@ In alphabetical order:
|
||||
|
||||
## Documentation
|
||||
|
||||
* Getting started
|
||||
* [Getting started](docs/getting_started.md)
|
||||
* [Architecture](docs/architecture.md)
|
||||
* [Configuration](docs/configuration.md)
|
||||
* [ESC language documentation](api/esc.md)
|
||||
* [API reference](docs/api)
|
||||
|
||||
## Roadmap
|
||||
|
||||
@@ -72,12 +72,51 @@ This framework (scripts, scenes) is distributed under the [MIT license](LICENCE)
|
||||
|
||||
### Art credits
|
||||
|
||||
#### Logo
|
||||
|
||||
Escoria Logo created by Livio Fania (https://liviofania.com/)
|
||||
Licence: CC-BY
|
||||
|
||||
#### Characters
|
||||
|
||||
- Mark spritesheet by Marco Giorgini - marcogiorgini.com
|
||||
Licence : CC0 Licence
|
||||
https://opengameart.org/content/mark-2d-adventure-game-sprite
|
||||
with some additions (talk animations) by Julian Murgia
|
||||
- Worker spritesheet based on Mark spritesheet by Marco Giorgini - marcogiorgini.com
|
||||
Licence: CC0 Licence
|
||||
edited by Julian Murgia
|
||||
|
||||
#### Items
|
||||
|
||||
* Generic items by Kenney
|
||||
Licence: CC0 Licence
|
||||
https://www.kenney.nl/assets/generic-items
|
||||
|
||||
### Sound credits
|
||||
|
||||
* Concrete footstep
|
||||
Licence: CC0 Licence
|
||||
https://www.kenney.nl/
|
||||
* “Game Menu Looping” (Licence CC-BY 4.0)
|
||||
* “Mystical Ocean Puzzle Game” (Licence CC-BY 4.0)
|
||||
by Eric Matyas
|
||||
www.soundimage.org
|
||||
|
||||
### Font
|
||||
|
||||
These fonts are provided as an example. Please mind checking the licence before redistributing with your game.
|
||||
|
||||
- Caslon Antique
|
||||
https://www.1001fonts.com/caslon-antique-font.html#license
|
||||
Licence: Free for personal use - Free for commercial use
|
||||
This is the font used in LucasArt's game Curse of Monkey Island.
|
||||
|
||||
- Onesize
|
||||
https://www.whatfontis.com/Onesize.font
|
||||
Licence: Free for personal use
|
||||
This is the font used in LucasArt's games The Secret of Monkey Island and Monkey Island 2: Lechuck's Revenge.
|
||||
|
||||
## Development
|
||||
|
||||
Requirements:
|
||||
@@ -85,6 +124,7 @@ Requirements:
|
||||
* git
|
||||
* Current Godot version
|
||||
* Current master of [GDScript docs maker](https://github.com/GDQuest/gdscript-docs-maker)
|
||||
* Python (>=3) if you changed the ESC commands
|
||||
|
||||
During development, run the following to update the class list:
|
||||
|
||||
@@ -95,3 +135,9 @@ rm -rf export &>/dev/null
|
||||
cp export/* <path to escoria>/docs/api
|
||||
```
|
||||
|
||||
If you changed ESC commands, update the command reference by running
|
||||
|
||||
```
|
||||
python3 extractesc.py
|
||||
```
|
||||
|
||||
|
||||
Reference in New Issue
Block a user