diff --git a/docs/07-roland-boot.md b/docs/07-roland-boot.md index 48f597e..c7733c7 100644 --- a/docs/07-roland-boot.md +++ b/docs/07-roland-boot.md @@ -22,9 +22,11 @@ There are two additional parameters that can be passed into the boot function: The Roland Boot Manager comes with a few loading screens by default: -- `RolandGraphicalLoader`: A graphical loader with the game's window icon, if the file is present. Otherwise, the Candella logo is displayed. -- `RolandGraphicalLogomarkLoader`: A graphical loader that displays the Candella logomark. -- `RolandTextLoader`: A text-based loader that displays the contents of the Candella log file. +| Preview | Loader name | Description | +| ------- | ----------- | ----------- | +| ![](/images/roland/graphic.png) | `RolandGraphicalLoader` | A graphical loader with the game's window icon, if the file is present. Otherwise, the Candella logo is displayed. | +| ![](/images/roland/graphic-logomark.png) | `RolandGraphicalLogomarkLoader` | A graphical loader that displays the Candella logomark, as well as a row of icons at the bottom for all of the core services installed. | +| ![](/images/roland/text.png) | `RolandTextLoader` | A text-based loader that displays the contents of the Candella log file. | ### Creating a custom loading screen diff --git a/docs/96-design-and-branding.md b/docs/96-design-and-branding.md new file mode 100644 index 0000000..f35ca6d --- /dev/null +++ b/docs/96-design-and-branding.md @@ -0,0 +1,32 @@ +# Design and branding + +Candella includes utilities and modules that help ensure the system's design language is followed, as well as provide branding images. + +## Design + +Candella, in large part, follows the Suru design guidelines and is commonly seen in the icons and font (Ubuntu). The `CADesign` module contains some utilities to help facilitate following the design language. + +### `get_app_mask_frame()` + +Returns a Frame object with a mask of the app's general shape. + +### `get_app_mask(icon, size)` + +Returns an AlphaMask displayable with the app's general shape masked on to the specified `icon` with a size of `size x size` pixels. + +## Branding + +The `Branding` directory inside of the `System/Library` directory contains logomarks and sprites that can be used throughout Candella. Please, do not use these images to represent your app or service. + +![Logomark](/images/branding/logomark.png) + + +*The logomark is best used on a dark background. + + + +| | | +| - | - | +| ![Logo sprite](/images/branding/sprite.png) | ![Alternate logo sprite](/images/branding/sprite_alt.png) | + +Note that, for fonts, the Ubuntu font is used. diff --git a/docs/97-deprecated.md b/docs/97-deprecated.md new file mode 100644 index 0000000..5e0e269 --- /dev/null +++ b/docs/97-deprecated.md @@ -0,0 +1,23 @@ +# Deprecations + +Candella includes a small module that facilitates deprecating functions. To mark a function as deprecated, import the function and decorate the function you want to deprecate: + +```py +from store.CADeprecated import deprecated + +@deprecated('21.02') +def deprecated_func(): + pass + +``` + +When the function is called, a warning message will appear in the console and the Candella log file indicating that the function was deprecated, as well as the reason for the deprecation, if one was specified. + +!!! important + The `deprecated` function has been tested on functions and class methods, but hasn't been tested or designed for variables, class fields, or classes themselves. Use with caution. + +## `deprecated` arguments + +- `version` (str): The version in which the function will be deprecated. +- `renamed` (str): (Optional) What the function has been renamed to, if the function was renamed. +- `reason` (str): (Optional) The reason why the function was deprecated. \ No newline at end of file diff --git a/docs/images/branding/logomark.png b/docs/images/branding/logomark.png new file mode 100644 index 0000000..21c9be5 Binary files /dev/null and b/docs/images/branding/logomark.png differ diff --git a/docs/images/branding/sprite.png b/docs/images/branding/sprite.png new file mode 100644 index 0000000..d652176 Binary files /dev/null and b/docs/images/branding/sprite.png differ diff --git a/docs/images/branding/sprite_alt.png b/docs/images/branding/sprite_alt.png new file mode 100644 index 0000000..082c0c3 Binary files /dev/null and b/docs/images/branding/sprite_alt.png differ diff --git a/docs/images/roland/graphic-logomark.png b/docs/images/roland/graphic-logomark.png new file mode 100644 index 0000000..c7b1559 Binary files /dev/null and b/docs/images/roland/graphic-logomark.png differ diff --git a/docs/images/roland/graphic.png b/docs/images/roland/graphic.png new file mode 100644 index 0000000..170999d Binary files /dev/null and b/docs/images/roland/graphic.png differ diff --git a/docs/images/roland/text.png b/docs/images/roland/text.png new file mode 100644 index 0000000..3d3f1b6 Binary files /dev/null and b/docs/images/roland/text.png differ diff --git a/game/System/CoreServices/Roland.aoscservice/Resources/Loaders/RolandText.rpy b/game/System/CoreServices/Roland.aoscservice/Resources/Loaders/RolandText.rpy index 8818281..7d56f57 100644 --- a/game/System/CoreServices/Roland.aoscservice/Resources/Loaders/RolandText.rpy +++ b/game/System/CoreServices/Roland.aoscservice/Resources/Loaders/RolandText.rpy @@ -41,7 +41,7 @@ style RolandText_frame is frame: padding (4, 4) style RolandText_text is text: - font get_font("Unicode") + font get_font("Unicode", variant="Fixed") line_spacing 0 antialias False size 16