# Intro

## What is PythonToSW

PythonToSW is a Python package that allows you to code up addons for Stormworks: Build and Rescue in Python rather than using Lua. It uses HTTP under the hood to communicate with an in-game addon to carry out function calls.

Unfortunately, since HTTP is used, any PythonToSW addon will be 2x slower than a normal addon due to the request rate limit (one request every two ticks, or 32 requests/s).

## Installation

To install or update PythonToSW, simply run:

```batch
pip install PythonToSW --upgrade
```

## Learn More

{% hint style="warning" %}
Knowledge on Stormworks addons is recommended before proceeding. Consider reading the in-game addon documentation as this documentation assumes you know a decent amount about Stormworks addons.
{% endhint %}

Refer to [Examples](/examples.md) to find examples.

Refer to [Guides](/guides/your-first-addon.md) to learn PythonToSW one step at a time.

Refer to [Behind The Scenes](/behind-the-scenes.md) to learn what happens in the code for PythonToSW without actually reading the code.

## Links

[PythonToSW GitHub Repo](https://github.com/Cuh4/PythonToSW/tree/main)

[Report Bugs/Offer Suggestions](https://github.com/Cuh4/PythonToSW/issues)

[PyPi](https://pypi.org/project/PythonToSW/)


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://pythontosw.cuhhub.com/intro.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.