ZeepSDK

A community-built Software Development Kit that simplifies plugin development for Zeepkist. ZeepSDK provides a comprehensive set of high-level APIs that abstract away complex game internals, allowing developers to focus on creating innovative features and enhancements.

ZeepSDK is built on BepInEx, a Unity modding framework, and uses Harmony for runtime patching. By exposing well-designed APIs, ZeepSDK acts as a translation layer between mods and Zeepkist, making it easier to maintain compatibility and fix issues without requiring updates to individual mods.

ZeepSDK provides APIs for a wide range of functionality:

• Chat API - Send messages to chat and interact with the chat system
• Chat Commands API - Create local and remote chat commands with built-in help system
• Messaging API - Display messages to users using the game's messenger system (info, success, warning, error)
• Storage API - Persistent data storage for your mods
• Settings API - Manage mod settings windows and configuration
• UI API - Create custom user interfaces, toolbars, and GUI elements
• Controls API - Override and manage input handling (keyboard and mouse)

• Racing API - Hook into racing events (finish line, crashes, camera changes, etc.)
• Level API - Interact with levels, including CSV level parsing and current level information
• Multiplayer API - Interact with multiplayer lobbies, playlists, and player events
• Leaderboard API - Create custom leaderboard pages that integrate seamlessly
• Playlist API - Manage and edit playlists saved to disk

• Level Editor API - Extend the level editor with custom blocks, folders, input blocking, and events
• Photo Mode API - Integrate with the game's photo mode system

• Scripting API - Advanced Lua scripting capabilities (ZUA) for complex mods
• Communication API - Enable inter-mod communication through senders and receivers
• Workshop API - Subscribe to and unsubscribe from Steam Workshop items
• Cosmetics API - Access and manage player cosmetics (soapboxes, hats, etc.)
• Crashlytics API - Error reporting and crash tracking (optional, user consent required)

Comprehensive API documentation is available at:
https://donderjoekel.github.io/ZeepSDK/api/index.html

Pre-release documentation and packages are published separately from stable releases:

• Beta docs: https://donderjoekel.github.io/ZeepSDK/beta/
• Beta NuGet package:

dotnet add package ZeepSDK --version 2.4.0-beta.1

Beta packages are prerelease versions on NuGet and are not installed by default. Beta builds are not uploaded to mod.io. See RELEASE.md for the maintainer release process.

ZeepSDK includes several built-in chat commands:

Local Commands:

• /help - Shows available local commands with descriptions
• /clear - Clears the chat

Remote Commands:

• !help - Shows available remote commands with descriptions (host only)

Remote commands can be used by other players in the same lobby, but only if you are currently the host. This is useful for features like vote skipping or lobby management.

• Zeepkist game installed
• BepInEx installed and configured for Zeepkist
• .NET Framework 4.7.2 or compatible

Before installing ZeepSDK, you need to have BepInEx installed. The easiest way to install BepInEx for Zeepkist is using one of these community tools:

• Windows: Modkist Revamped - A modloader for Zeepkist using mod.io with a user-friendly interface
• Linux: zeeper - A command-line tool for managing Zeepkist mods and installing BepInEx

Alternatively, you can manually install BepInEx by following the official BepInEx documentation.

You can install ZeepSDK using the same tools mentioned above for installing BepInEx:

• Windows: Use Modkist Revamped to install ZeepSDK through its mod browser
• Linux: Use zeeper to install ZeepSDK via command line

Alternatively, you can install ZeepSDK manually:

1. Download the latest ZeepSDK release
2. Place the ZeepSDK.dll file in your BepInEx/plugins directory
3. Launch Zeepkist - ZeepSDK will load automatically

1. Create a new BepInEx plugin project
2. Install the ZeepSDK NuGet package in your project (recommended) instead of directly referencing ZeepSDK.dll
3. Use the ZeepSDK APIs in your plugin code

Example:

using BepInEx;
using ZeepSDK.Chat;

[BepInPlugin("com.yourname.yourmod", "Your Mod", "1.0.0")]
public class YourMod : BaseUnityPlugin
{
    private void Awake()
    {
        ChatApi.SendMessage("Hello from my mod!");
    }
}

Contributions are welcome! ZeepSDK is a community project that benefits from the contributions of developers like you.

Please read the Contributing Guide for guidelines on:

• Feature development
• Bug fixes
• Code style
• Pull request process

• Features should benefit multiple mods, not just one
• Use Api classes for outward-facing functionality
• Return interfaces instead of concrete implementations
• Include comprehensive XML documentation
• Test thoroughly and handle exceptions appropriately
• Follow semantic versioning for version bumps

See LICENSE file for details.

ZeepSDK uses Bugsnag for error reporting and crash tracking to help improve stability and fix bugs. Users can opt-out of crashlytics in the configuration.