venus/README.md

29 lines
1.1 KiB
Markdown
Raw Normal View History

2024-05-15 21:08:58 +02:00
# StarOpenSource's CORE modules
## Setting up
```bash
mkdir -p addons
git clone https://git.staropensource.de/StarOpenSource/CORE-StarOpenSource-modules.git addons/sos_core_modules
```
## References
### `src/manager.gd`
#### *void* <u>register_modules</u>()
Registers all CORE modules.
#### *void* <u>unregister_modules</u>()
Unregisters all CORE modules.
### `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:13:13 +02:00
#### *CoreBaseModule* <u>add_splashes</u>(*String* <u>category</u>, *Array[String]* <u>splashes</u>)
2024-05-15 21:08:58 +02:00
Adds an array of splashes to the specified category.
2024-05-15 21:13:13 +02:00
#### *CoreBaseModule* <u>delete_category</u>(*String* <u>category</u>)
2024-05-15 21:08:58 +02:00
Removes the specified category.
2024-05-15 21:16:28 +02:00
#### *Array[String]* <u>get_categories()</u>()
Returns a list of all categories.
2024-05-15 21:08:58 +02:00
#### *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.
#### *String* <u>get_random_splash</u>(*String* <u>category</u>)
Returns a random splash.