Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/codecat/op-style-manager
Openplanet plugin to easily install and create custom Openplanet overlay styles.
https://github.com/codecat/op-style-manager
Last synced: 6 days ago
JSON representation
Openplanet plugin to easily install and create custom Openplanet overlay styles.
- Host: GitHub
- URL: https://github.com/codecat/op-style-manager
- Owner: codecat
- Created: 2022-09-10T13:11:36.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-08-03T16:49:08.000Z (5 months ago)
- Last Synced: 2024-08-04T16:45:45.384Z (5 months ago)
- Language: AngelScript
- Size: 31.3 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Overlay Style Manager
This Openplanet plugin lets you easily install and create custom styles for the Openplanet overlay.
## Submitting styles to the index
To submit your own style to the index, either create an issue on Github or share your style on the
Discord. Note that your style must adhere to a specific format in order to be installable.
Your style must be in a Github repository. (I might add support for other services later.) You must
have an `info.json` file in the root of your repository. Here's an example:
```json
{
"description": "Example style for the Openplanet overlay.",
"screenshot": "Screenshot.jpg",
"style": "Example.toml"
}
```
The `screenshot` and `style` keys are relative paths within your repository. In the example above,
this means you need a `Screenshot.jpg` and `Example.toml` in the root of your repository.
You can have multiple screenshots as well by using the `screenshots` key as an array:
```json
"screenshots": [ "...", "..." ]
```
If you have a collection of multiple styles, you can also use the `styles` array to put more than
one style:
```json
{
"styles": [
{
"name": "Example in red",
"description": "This is my style in red.",
"style": "ExampleRed.toml"
},
{
"name": "Example in blue",
"description": "This is my style in blue.",
"style": "ExampleBlue.toml"
}
]
}
```
You may also have sub-styles:
```json
{
"styles": [
{
"name": "Colorful",
"styles": [
{
"description": "Example in red",
"name": "Red",
"style": "ExampleRed.toml"
},
{
"description": "Example in blue",
"name": "Blue",
"style": "ExampleBlue.toml"
}
]
},
{
"name": "Black and white",
"styles": [
{
"description": "Example in white",
"name": "White",
"style": "ExampleWhite.toml"
},
{
"description": "Example in black",
"name": "Black",
"style": "ExampleBlack.toml"
}
]
}
]
}
```