From d8710f98e83ea76b4730016b22f063310e968472 Mon Sep 17 00:00:00 2001 From: GP Garcia Date: Thu, 22 Aug 2024 21:45:35 -0500 Subject: [PATCH] Updated Skillet stuff --- docs/assets/stylesheets/extra.css | 2 +- docs/changelog/skillet_editor.md | 9 ++++++++- docs/projects/components.md | 2 ++ docs/projects/skillet/editor.md | 32 +++++++++++++++++++++++++++++- docs/projects/skillet/inventory.md | 24 +++++++++++++--------- docs/projects/skillet/licenses.md | 25 +++++++++++++++++++++-- 6 files changed, 80 insertions(+), 14 deletions(-) diff --git a/docs/assets/stylesheets/extra.css b/docs/assets/stylesheets/extra.css index 05a70076..5a452120 100644 --- a/docs/assets/stylesheets/extra.css +++ b/docs/assets/stylesheets/extra.css @@ -85,7 +85,7 @@ h3 { } .critic { background-color: #35688E !important; - margin: 3em 0 2em !important; + margin: 0em 0 2em !important; } .md-typeset .critic.block h2 { font-weight: bold; diff --git a/docs/changelog/skillet_editor.md b/docs/changelog/skillet_editor.md index 7c7e02b0..a70f4fe6 100644 --- a/docs/changelog/skillet_editor.md +++ b/docs/changelog/skillet_editor.md @@ -4,4 +4,11 @@ A history of all changes to [the ***editor*** branch of the Skillet repository.] --- -Nothing yet... \ No newline at end of file +## Version 1.0.1 + +- Changed: export settings for various platforms +- Fixed: issues with web links not opening + +## Version 1.0.0 + +- Added: the whole editor \ No newline at end of file diff --git a/docs/projects/components.md b/docs/projects/components.md index e6dbcbe1..76666c92 100644 --- a/docs/projects/components.md +++ b/docs/projects/components.md @@ -3,7 +3,9 @@ title: GodotSteam Components description: A collection of in-editor tools and custom nodes to make working with Steamworks a little easier. Each can be used on their own or mixed with the others but all of them depend on GodotSteam to function. --- +{== # GodotSteam Components +==} A collection of editor tools and custom nodes to make the process of setting up Steamworks integration faster. [The project will be open-source and can be found on Github.](https://github.com/GodotSteam/GodotSteam-Components){ target="\_blank" } diff --git a/docs/projects/skillet/editor.md b/docs/projects/skillet/editor.md index ca69ef1e..8c4e1c04 100644 --- a/docs/projects/skillet/editor.md +++ b/docs/projects/skillet/editor.md @@ -1 +1,31 @@ -Coming Soon \ No newline at end of file +# Skillet Workshop Editor +This editor lets you upload and edit Steam Workshop items, like cosmetics and skins, for [our open-source game Skillet.](https://store.steampowered.com/app/3013040/Skillet/){ target="\_blank" } + +Just like the game, the editor is open-source which means you can submit new patches and features if you want. You can also reskin or alter the code then ship an editor along with your game or put the functionality in your game. + +Skillet Workshop Editor is available on Steam with the full game. It can also be manually installed by running `steam://install/3143450` + +Tutorials on how the editor works are coming soon! + +{== +## Making Workshop Items +==} + +[You can find templates for new skins here.](https://github.com/GodotSteam/Skillet/tree/assets/templates){ target="\_blank" } Follow the layout to match your skins to what the game expects: + +- For bodies, each state has two frame that it animates between for the "wiggly" effect. +- Faces only have one frame, with the exception of Dash. +- Cosmetics are like bodies in that they have different states and two frames each. + +Items can be officially added to the game but we aren't ready for that just yet! + +{== +## Current Build +==} + +[You can see the full history of changes here.](../../changelog/skillet_editor.md){ target="\_blank" } + +**Version 1.0.1** + +- Changed: export settings for various platforms +- Fixed: issues with web links not opening \ No newline at end of file diff --git a/docs/projects/skillet/inventory.md b/docs/projects/skillet/inventory.md index 0a0976f0..b619d5ed 100644 --- a/docs/projects/skillet/inventory.md +++ b/docs/projects/skillet/inventory.md @@ -1,11 +1,17 @@ +--- +title: Skillet Steam Inventory +description: These are the list of Steam Inventory items in Skillet along with their image and VDF links. +--- {== -## :simple-steam: Steam Inventory +# :simple-steam: Steam Inventory ==} These are the list of Steam Inventory items in Skillet along with their image and VDF links. -### Bundle Items +--- + +## Bundle Items These are bundles of items usually from **Container Items**; item generators. @@ -22,7 +28,7 @@ These are bundles of items usually from **Container Items**; item generators. --- -### Cosmetics +## Cosmetics These can be colored by any **Coloring Items** and can only be equipped. @@ -39,7 +45,7 @@ These can be colored by any **Coloring Items** and can only be equipped. --- -### Utility Items +## Utility Items These have either active or passive uses and can combine with **Refill Items** or, in some cases, other in-game items. @@ -56,7 +62,7 @@ These have either active or passive uses and can combine with **Refill Items** o --- -### Coloring Items +## Coloring Items These can be combined with any **Cosmetics**, unless otherwise noted. @@ -79,7 +85,7 @@ These can be combined with any **Cosmetics**, unless otherwise noted. --- -### Refill Items +## Refill Items These are used to refill **Utility Items**. @@ -95,7 +101,7 @@ These are used to refill **Utility Items**. --- -### Containers +## Containers These are like chests where they contain a random item or assortment of items. @@ -112,7 +118,7 @@ These are like chests where they contain a random item or assortment of items. --- -### Skins +## Skins The base skin for the player character. Do not require coloring items to change the colors. - Can trade: true @@ -137,7 +143,7 @@ The base skin for the player character. Do not require coloring items to change --- -### Faces +## Faces These faces for the player character. diff --git a/docs/projects/skillet/licenses.md b/docs/projects/skillet/licenses.md index 52ec2346..eaaf81d5 100644 --- a/docs/projects/skillet/licenses.md +++ b/docs/projects/skillet/licenses.md @@ -1,23 +1,44 @@ +--- +title: Skillet Licenses +description: Skillet's code, assets, and other inner-workings are all on separate licenses. Yeah. +--- + {== -## :material-license: The Different Licenses +# :material-license: The Different Licenses ==} +Skillet's code, assets, and other inner-workings are all on separate licenses. Yeah. + +--- + ### Game Code The code from Skillet is [licensed under MIT license](https://en.wikipedia.org/wiki/MIT_License){ target="\_blank" }. You may use any code from the repo for your projects as is or modified; in free or commercial games. +--- + +### Editor Code + +The code from Skillet Workshop Editor is also [licensed under MIT license](https://en.wikipedia.org/wiki/MIT_License){ target="\_blank" }. + +--- + ### In-Game Art Assets The art assets in Skillet are housed in a private repo and are not available publicly or allowed to be used in any other projects. Skillet's public repo will contain placeholder versions that are [licensed under Creative Commons BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/){ target="\_blank" }. +--- + ### Game Font Assets Both fonts used in Skillet were purchased and licensed from [Creative Fabrica](https://www.creativefabrica.com){ target="\_blank" } but are not included in the public repo due to licensing restriction. +--- + ### Steam Art Assets The art assets contained in the [Art branch on the Skillet Github repository](https://github.com/GodotSteam/Skillet/tree/assets){ target="\_blank" } are under mixed licenses. -The bulk of them are licensed under [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/?ref=chooser-v1): +The bulk of them are licensed under [CC BY-NC-SA 4.0](https://creativecommons.org/licenses/by-nc-sa/4.0/): - Achievement icons - Executable icons