Skip to content
Vaziayu edited this page Aug 31, 2024 · 3 revisions

WORK IN PROGRESS MAY OR MAY NOT BE ACCURATE

VAC Lua Function Library

Overview

Welcome to the VAC Function Library Wiki for SomethingNeedDoing! VAC is a comprehensive Lua function library designed to make SND script development faster, easier, and more efficient. Below you'll find all the information you need to get started, including installation instructions, usage examples, and detailed documentation for each function in the library.

Features

  • Versatile: Functions cover a broad spectrum of common tasks.
  • Optimised: Lightweight and efficient performance.
  • User-Friendly: Easy integration into your SND scripts.
  • Well-Documented: Each function comes with detailed documentation and examples.
  • Compatible: Designed to work with your SND scripts straight away.

Installation

To install the VAC library, follow these steps:

Steps

  1. Clone the Repository in a location convenient for you:
    git clone https://github.com/Vaziayu/SNDScripts.git
  2. Navigate to the Directory:
    cd SNDScripts

Prerequisites

  • Lua language knowledge
  • SomethingNeedDoing plugin installed

Configuration

abc

Getting Started

Here's a quick guide to get you started with VAC:

abc

For more detailed information on available functions, please see our VAC Function List.

Contributing

We welcome contributions to the VAC library! If you find a bug or have a feature request, feel free to open an issue or submit a pull request. For major changes, we encourage you to open an issue first to discuss your proposed ideas.

If you are ready to contribute, please follow these guidelines:

  1. Fork the repository.
  2. Create a new branch for your feature or bug fix (git checkout -b feature/your-feature).
  3. Write clean, well-documented code.
  4. Commit your changes with a meaningful message (git commit -m "Add feature X").
  5. Push your changes to the branch (git push origin feature/your-feature).
  6. Submit a pull request with a clear and concise description of your changes.

Please read our Contributing Guidelines for more detailed information.

Additional Resources

For a complete list of functions and their usage, please refer to our VAC Function List.