[][src]Crate quicksilver

quicksilver

Build Status Crates.io Docs Status dependency status Gitter chat

A 2D game framework written in pure Rust

A quick example

Create a rust project and add this line to your Cargo.toml file under [dependencies]:

 quicksilver = "*"

Then replace src/main.rs with the following (the contents of quicksilver's examples/draw-geometry.rs):

// Draw some multi-colored geometry to the screen
extern crate quicksilver;

use quicksilver::{
    Result,
    geom::{Circle, Line, Rectangle, Transform, Triangle, Vector},
    graphics::{Background::Col, Color},
    lifecycle::{Settings, State, Window, run},
};

struct DrawGeometry;

impl State for DrawGeometry {
    fn new() -> Result<DrawGeometry> {
        Ok(DrawGeometry)
    }

    fn draw(&mut self, window: &mut Window) -> Result<()> {
        window.clear(Color::WHITE)?;
        window.draw(&Rectangle::new((100, 100), (32, 32)), Col(Color::BLUE));
        window.draw_ex(&Rectangle::new((400, 300), (32, 32)), Col(Color::BLUE), Transform::rotate(45), 10);
        window.draw(&Circle::new((400, 300), 100), Col(Color::GREEN));
        window.draw_ex(
            &Line::new((50, 80),(600, 450)).with_thickness(2.0),
            Col(Color::RED),
            Transform::IDENTITY,
            5
        );
        window.draw_ex(
            &Triangle::new((500, 50), (450, 100), (650, 150)),
            Col(Color::RED),
            Transform::rotate(45) * Transform::scale((0.5, 0.5)),
            0
        );
        Ok(())
    }
}

fn main() {
    run::<DrawGeometry>("Draw Geometry", Vector::new(800, 600), Settings::default());
}

Run this with cargo run or, if you have the wasm32 toolchain installed, you can build for the web (instructions below).

Building and Deploying a Quicksilver application

Make sure to put all your assets in a top-level folder of your crate called static/. All Quicksilver file loading-APIs will expect paths that originate in the static folder, so static/image.png should be referenced as image.png.

Linux dependencies

On Windows and Mac, all you'll need to build Quicksilver is the right version of rustc and cargo. A few of Quicksilver's dependencies require Linux packages to build, namely libudev, zlib, and alsa. To install these on Ubuntu or Debian, run the command sudo apt install libudev-dev zlib1g-dev alsa.

Deploying for desktop

If you're deploying for desktop platforms, build in release mode (cargo build --release) and copy the executable file produced (found at "target/release/") and any assets you used (image files etc) and create an archive (on Windows a zip file, on Unix a tar file). You should be able to distribute this archive with no problems; if there are problems, please open an issue.

Deploying for the web

If you're deploying for the web, first make sure you've installed the wasm toolchain and the cargo web tool. Build the wasm file and its js bindings (cargo +nightly web build --target wasm32-unknown-unknown). Copy the .wasm and .js files produced (found at "target/wasm32-unknown-unknown/release") and any assets you may have used. Create an HTML file and //! attach the script with a script tag.

If you want to test your application locally, use cargo +nightly web start --target wasm32-unknown-unknown and open your favorite browser to the port it provides.

Learning Quicksilver

A good way to get started with Quicksilver is to read and run the examples and go through the tutorial module on docs.rs. If you have any question, feel free to hop onto Gitter or open an issue.

Optional Features

Quicksilver by default tries to provide all features a 2D application may need, but not all applications need these features.

The optional features available are collision support (via ncollide2d), font support (via rusttype), gamepad support (via gilrs), saving (via serde_json), complex shape / svg rendering (via lyon), immediate-mode GUIs (via immi), and sounds (via rodio).

Each are enabled by default, but you can specify which features you actually want to use.

Re-exports

pub extern crate lyon;

Modules

combinators

Futures

geom

A 2D geometry module

graphics

A module to draw 2D graphics in a window It also includes image loading

input

A collection of polling input structures

lifecycle

The module that manages control flow of Quicksilver applications

saving

A module for saving / loading application data

sound

A sound API that allows playing clips at given volumes

tutorials

The quicksilver tutorials, generated through Rustdoc

Enums

Error

An error generated by some Quicksilver subsystem

Traits

Future

Trait for types which are a placeholder of a value that may become available at some later point in time.

Functions

load_file

Create a Future that loads a file into an owned Vec of bytes

Type Definitions

Result

A Result that returns either success or a Quicksilver Error