Home

Welcome to the Serpent.AI Wiki!

New user? Interested in developing your own game agent experiments? The following articles should give you all the knowledge required to be well on your way to mastering the Serpent.AI framework.

Translations

• 简体中文

Installation

• Linux Installation Guide
• Windows Installation Guide
• macOS Installation Guide

Updating

• Updating Serpent.AI

Quick Start

• The Serpent.AI Hello World

Core Concepts

• The Plugin System
• The serpent Executable
• The Game Class
• The Game Plugin
• The GameAgent Class
• The GameAgent Plugin
• The GameFrame Class
• The InputController Class
• The Streaming API and Analytics Client (planned)

Common Tasks

• Defining Screen Regions
• Capturing Frames and Regions
• Training a Context Classifier
• Identifying and Locating Sprites
• Isolating Sprites from their Backgrounds
• Using the Visual Debugger
• Using OCR (planned)

Extras

• Game Agent Development Starter Workflow
• Data Processing Flowchart

Sample Plugins

Game Plugins

• SerpentAI/SerpentBindingOfIsaacAfterbirthGamePlugin
• SerpentAI/SerpentYouMustBuildABoatGamePlugin
• SerpentAI/SerpentOpenRCT2GamePlugin (WIP)

Game Agent Plugins

• SerpentAI/SerpentBindingOfIsaacAfterbirthGameAgentPlugin
• SerpentAI/SerpentYouMustBuildABoatGameAgentPlugin
• SerpentAI/SerpentOpenRCT2GameAgentPlugin (WIP)

Community Showcase

• Community Plugin Showcase

Recommended 3rd-Party Tools

• Jupyter Notebook: Rapid Prototyping & Experimentation
• Spritex: Screen Region & Sprite Extraction

Useful Documentation

• NumPy
• Scikit-image