This repository contains the official documentation for ScheduleLua, a Lua scripting API for Schedule 1 that allows you to create mods and enhance your gameplay experience.
Visit the live documentation at https://ifbars.github.io/ScheduleLua-Docs/
ScheduleLua is currently in beta development. The API is subject to change and some features may not be fully implemented yet. This documentation is being built alongside the mod.
- Guide: Installation instructions, getting started guides, and best practices
- API Reference: Detailed documentation of all available APIs and functions
- Examples: Sample scripts demonstrating various features and use cases
To run this documentation site locally, download the zip, then:
cd path/to/your-docs-folder
# Install dependencies
npm install
# Start local development server
npm run docs:devContributions to improve the documentation are welcome! Please follow these steps:
-
Fork the repository: Click the "Fork" button at the top right of this repository.
-
Clone your fork:
git clone https://github.com/YOUR-USERNAME/ScheduleLua-Docs.git cd ScheduleLua-Docs -
Set up the project:
npm install
-
Create a new branch:
git checkout -b your-feature-branch
-
Make your changes: Update or add documentation files as needed.
-
Preview your changes locally:
npm run docs:dev
The site will be available at http://localhost:5173/ScheduleLua-Docs/
-
Commit and push your changes:
git add . git commit -m "Description of changes" git push origin your-feature-branch
-
Create a Pull Request: Go to your fork on GitHub and click "New Pull Request". Make sure to set the base branch to
dev. -
Wait for review: Your PR will be reviewed and merged if it meets the project's guidelines.
Please ensure your contributions:
- Follow the existing documentation style
- Are clear and concise
- Include examples where appropriate
- Have been tested locally before submission
This documentation is released under the GPL-3.0 License.