sfml.js Documentation

These guides cover the SFML 3.1.0 binding in the current repository. Start with "Quick start" if you are new to sfml.js; use TypeDoc to look up specific method signatures.

Getting started

Guide	What it covers
Quick start	Install dependencies, choose an import style and open your first window
Core concepts	Copying values and resources, loading completion and when draws take effect
API guide	Capabilities of the five modules
Examples	Run complete demonstrations from the repository

Module guides

Module	Contents
System	Vectors, angles, time, input streams, Unicode and error handling
Window	Window lifecycle, events, real-time input, OpenGL and Vulkan
Graphics	Images, textures, sprites, shapes, text, views and drawing
Audio	Playback, streaming data, effects, recording and codecs
Network	Packet, TCP/UDP, DNS, TLS, HTTP, FTP and SFTP

Contributing

The development guide explains building, testing, source organization and the existing documentation publishing workflow.

Method signatures and exports are defined by src/index.ts and its source comments, published through TypeDoc. Use the SFML 3.1.0 C++ reference for upstream concepts; use the sfml.js guides and TypeDoc for JavaScript adaptations, including Node.js asynchronous behavior, memory and networking.