Skip to content
Mahan Khalili edited this page Aug 28, 2024 · 22 revisions

Welcome to the SLib Wiki

Overview

SLib is a Godot library designed to simplify and enhance your development experience. It provides a set of ready-to-use, standard codes that eliminate the need to write repetitive and lengthy scripts. SLib is lightweight, easy to install, and helps make your code more readable and maintainable.

Key Features

  • Lightweight: Requires minimal space in your application (less than 100KB).
  • Easy Installation: Simple setup process to get you started quickly.
  • Code Readability: Transforms complex and unreadable code into clear and understandable expressions.
  • Efficiency: Reduces the need for duplicate code and allows execution of multiple lines with a single command.
  • Standardization: Provides standard methods for common tasks, optimizing your app for any platform.

Getting Started

To start using SLIB, follow these steps:

Step1: Install SLib Main Script

  1. Get SLib Main Script: Download and copy SLib.gd in your project directory. Download from releases
  2. AutoLoad Setup: Go to Project Settings > Auto Load, and add res://SLib.gd with the name SLib in project autoload.

Step2: Install SLibConfig Plugin

  1. Get SLibConfig: Download SLibConfig.zip from releases.
  2. Import Plugin: Open your project, go to AssetLib, click on Import... and import SLibConfig.zip file.
  3. Activate Plugin: Go to Project > Project Settings > Plugins and set SLibConfig status to enable.

Step3: Activate Automation

See here for set up automation.

Step3: Finishing Installation

  1. Reload Project: To apply changes use Project > Reload Current Project.
  2. Check Plugin: Go to Project > Project Settings > General and search SLib/, if you have settings in SLib/ plugin installed.
  3. Check Script: Open a GDScript file and paste this code in the file and wait a few moments, if you do not receive an error, the installation is complete, and you can erase the code:
func _ready():
    SLib.MergeUnique([2],[3])
  1. Check Automation: Write Save "Test" in "res://Test.save" and press enter or right-arrow, if code changed to SLib.SaveFile("res://Test.save", "Test") automation setup is correct.

Finish

Congratulations, now you can use all the features of SLib!

Available Functions

To explore the capabilitiesو see Capabilities page in SLib wiki.

Documentation

For detailed documentation and examples, visit our GitHub repository.

Community and Support

Join our community to share your experiences, ask questions, and get support from other SLib users. Check out our GitHub repository for the latest updates and contributions.

Godot forum page

Tip

Wiki was updated to 1.1.0! 🚀

SLib!

Clone this wiki locally