https://github.com/subject-team/elementum
Powerful library manager for Godot
https://github.com/subject-team/elementum
godot godot-engine godot-plugin godot4 godotengine library library-management library-management-system plugin
Last synced: 8 months ago
JSON representation
Powerful library manager for Godot
- Host: GitHub
- URL: https://github.com/subject-team/elementum
- Owner: Subject-Team
- License: mit
- Created: 2024-09-03T07:50:17.000Z (almost 2 years ago)
- Default Branch: Main
- Last Pushed: 2025-01-28T08:21:09.000Z (over 1 year ago)
- Last Synced: 2025-01-28T09:24:54.866Z (over 1 year ago)
- Topics: godot, godot-engine, godot-plugin, godot4, godotengine, library, library-management, library-management-system, plugin
- Language: GDScript
- Homepage: https://subject-team.github.io/Elementum/
- Size: 64.5 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> [!IMPORTANT]
> This repository has been archived and its comprehensive version is available in [this repository](https://github.com/mkh-user/Elementum).
# Elementum
Powerful library manager for Godot
## How To Use?
### Step1: Install & Optimize Elementum Plugin
1. **Get Plugin**: Download and install elementum plugin from [releases](https://github.com/Subject-Team/Elementum/releases).
2. **Import Plugin**: Open your project, go to `AssetLib`, click on `Import...` and import `Elementum-Plugin.zip` file.
3. **Activate Plugin**: Go to `Project > Project Settings > Plugins` and set `Elementum` status to `enable`.
4. **Remove Plugin Zip**: Now you can remove `Elementum.zip`.
### Step2: Install Libraries
1. **Download Libraries**: See [this page](https://github.com/Subject-Team/Elementum/wiki/Libraries) for browse Elementum libraries, you can click on libraries to see repository. in library ripository you can download library from releases.
2. **Import Libraries**: Open your project, go to `AssetLib`, click on `Import...` and import library `.zip` file.
3. **Reload Project**: Use `Project>Reload Current Project`.
### Finish
Now you can use libraries, for guides you should see library repository.
## How Create Library?
1. **Create ripository**: Create a godot project and add project to github.
2. **Create Library**: Create script in `addons/Elementum/Libraries/` folder with this themplate (don't froget [GDScript Style Guide](https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_styleguide.html)!):
```
class_name %yourLibraryNameInPascalCase%_Elementum
func exampel(test_parameter):
print("It's only for test!")
...
```
4. **Write Docs**: See [here](https://docs.godotengine.org/en/stable/tutorials/scripting/gdscript/gdscript_documentation_comments.html) for documentation in Godot.
5. **Create A Release**: Create a `.zip` file from `addons` folder (You should have only that: `addons/Elemntum/Libraries/%LibraryName%.gd`) and upload it as release.
6. **Publish Library**: Add your repository to [Elementum libraries page](https://github.com/Subject-Team/Elementum/wiki/Libraries)