installation.md

Installation of the Summoner SDK

Because the Summoner SDK is composed of multiple repositories, we do not currently support installation via package registries like PyPI. Instead, we use Bash-based installation scripts to manage setup and composition.

This script-based approach is consistent across key components of the platform, including:

• summoner-desktop: the Electron-based desktop app
• summoner-core: the core logic of the SDK
• extension-agentclass: agent extensions and features (see the Agent Extensions reference, especially the Aurora module reference)

Each of these repositories contains its own setup.sh, install.sh or build script, and these scripts chain together during installation. For example, installing the SDK via summoner-desktop will trigger the summoner-sdk script, which in turn calls the setup scripts from summoner-core and any modules specified in build.txt.

For Windows users, we provide a setup guide adapted to the Windows environment here.

A Template-Based SDK

The summoner-sdk repository is a GitHub template repository, meaning users should not modify it directly. Instead, use GitHub's "Use this template" feature to generate a new repository that includes only the installation logic.

You then customize your new SDK by editing the build.txt file to specify which modules to include. This modular architecture allows for many valid SDK compositions based on different combinations of features surrounding the SDK core.

Note

The default build.txt in the template includes:

• extension-agentclass (extends the SDK runtime)
• extension-utilities (provides agent tools, visualization, protocol helpers, and related utilities)

A best practice is to only publish new code or features specific to your SDK, and keep the actual installation logic clean and declarative through build.txt. For example, summoner-agents is built from this template and contains only agent code — the SDK is installed via build_sdk.sh based on its own build.txt.

Required Languages and Setup Scripts

Summoner's SDK uses a layered script system to orchestrate installation and composition. These scripts handle environment setup, dependency resolution, and module integration. They rely on both Python and Rust, which are foundational to the platform.

The key scripts involved are:

• build_sdk.sh – top-level installer for assembling the SDK (from summoner-sdk)
• setup.sh – initializes the SDK core (from summoner-core)
• reinstall_python_sdk.sh – installs Python dependencies (from summoner-core)
• reinstall_rust_server.sh – builds and installs the Rust server (from summoner-core)

These scripts assume that both Python 3.9+ and the Rust toolchain are already installed and available in your environment.

If you are not yet set up, the following section will guide you through installing both languages. This is a one-time setup required before building or running the SDK.

1. Install Python

Check your current Python version:

python3 --version

If Python is not installed, install it using your system's package manager:

On macOS:

brew install python

On Ubuntu/Debian:

sudo apt update
sudo apt install python3 python3-venv python3-pip

2. Install Rust

Install Rust using rustup:

On macOS (via Homebrew):

brew install rustup
rustup-init

On macOS/Linux (via curl):

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Restart your terminal and verify:

rustc --version     # Should print the Rust compiler version
cargo --version     # Should print the Cargo package manager version

Build the SDK with a Custom build.txt

Once Python and Rust are installed, you can define your SDK composition and install it.

Step 1: Create Your SDK Repository

1. Go to the summoner-sdk template repository
2. Click "Use this template"
3. Choose "Create a new repository", name your project, and confirm

Clone your new repository:

git clone https://github.com/<your_account>/<your_repo>.git
cd <your_repo>

Step 2: Define the SDK in build.txt

Edit the build.txt file to include the modules you want. For example, to include the aurora module from extension-agentclass:

https://github.com/Summoner-Network/extension-agentclass.git:
aurora

Tip

aurora is an optional module. You can include it from the start or add it later and rerun setup. For the extension overview, see Agent Extensions. For the Aurora API itself, see aurora and the SummonerAgent reference.

You can modify this file at any time to add or remove modules.

Step 3: Run the Installer

🔁 The demo below is a looping animation. If you want to view it from the beginning, right-click → Open Image in New Tab or refresh the page.

Once build.txt is configured, run the script:

source build_sdk.sh setup

This will:

• Create a Python venv/
• Install all required Python and Rust dependencies
• Pull in the requested features defined in build.txt
• Link them together into a functional SDK workspace

If you prefer to execute the script instead of sourcing it:

bash build_sdk.sh setup
source venv/bin/activate

You are now ready to begin development using your custom Summoner SDK.

« Previous: Prerequisites    |    Next: Quickstart »