venus/README.md

30 lines
1.1 KiB
Markdown
Raw Normal View History

# Venus
StarOpenSource's custom [CORE](https://git.staropensource.de/StarOpenSource/CORE) modules.
2024-05-15 21:08:58 +02:00
## Setting up
```bash
mkdir -p addons
git clone https://git.staropensource.de/StarOpenSource/venus.git addons/venus
2024-05-15 21:08:58 +02:00
```
## References
### `src/manager.gd`
#### *void* <u>register_modules</u>()
Registers all of Venus' modules.
2024-05-15 21:08:58 +02:00
#### *void* <u>unregister_modules</u>()
Unregisters all of Venus' modules.
2024-05-15 21:08:58 +02:00
### `src/modules/splashes.gd`
#### *CoreBaseModule* <u>add_splash</u>(*String* <u>category</u>, *String* <u>splash</u>)
Adds a splash to the specified category.
2024-05-15 21:32:50 +02:00
#### *CoreBaseModule* <u>add_splashes</u>(*String* <u>category</u>, *Array* <u>splashes</u>)
2024-05-15 21:08:58 +02:00
Adds an array of splashes to the specified category.
#### *CoreBaseModule* <u>copy_splashes</u>(*String* <u>source_category</u>, *String* <u>target_category</u>)
Copies all splashes from the source category to the target category.
2024-05-15 21:25:26 +02:00
#### *Array* <u>get_categories</u>()
2024-05-15 21:17:05 +02:00
Returns a list of all categories.
#### *CoreBaseModule* <u>delete_category</u>(*String* <u>category</u>)
Removes the specified category.
2024-05-15 21:08:58 +02:00
#### *String* <u>get_random_splash</u>(*String* <u>category</u>)
Returns a random splash.