Skip to content

Enhance your CS2D Lua scripting with stubs, documentation, and function definitions for better code completion and understanding, streamlining your development process.

License

Notifications You must be signed in to change notification settings

Mami-Tomoe/cs2d-lua

Repository files navigation

CS2D-Lua README

Enhance your CS2D Lua scripting experience with this extension, designed to provide comprehensive stubs, in-depth documentation, and precise function definitions to enhance code completion and understanding. Whether you're a seasoned developer or just starting, this extension streamlines your workflow by offering clear insights into the functions and capabilities of CS2D Lua scripting. With intelligent integration, it supports better code organisation and faster debugging.


Features

  • Provides function definitions for CS2D Lua functions.
  • Includes comprehensive documentation for CS2D Lua functions.
  • Utilises Sumneko.lua to provide helpful instructions on using CS2D Lua functions, including:
    • Required parameters.
    • Optional parameters.
    • Return values.
  • Expands on related CS2D Lua functions to the one currently being used (if applicable).

Requirements

  • Requires the Sumneko.lua extension for optimal functionality.

Credits

This project was made possible thanks to the contributions of the following individuals (listed in no particular order):

  • Mami Tomoe (#99153) - Author of the project.
  • Margineanu65 (#187522) - Co-author of the project.
  • DC (#1) - For creating the initial sample of documentation.
  • Gaios (#18271) - Donated a sample of their personal stubs project.
  • TrialAndError (#129440) - Donated a sample of their personal stubs project.
  • ChatGPT (https://chatgpt.com/) - Assisted with repetitive tasks.

Additionally, the extension's icon was sourced from: Lua icons created by IconMarketPK - Flaticon.


Notes

This extension aims to make Lua scripting in CS2D more accessible and efficient for both beginners and advanced developers. Feedback and contributions are always welcome to improve its features and usability.

Happy scripting!

About

Enhance your CS2D Lua scripting with stubs, documentation, and function definitions for better code completion and understanding, streamlining your development process.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published