Skip to content

alex-smtv/rust-bindings-for-vjoy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rust Bindings for vJoy

Rust bindings for vJoy using its C API. It also works like a wrapper by extending the original usabilities.

This project is still on the works.

Who is this for?

This is meant to be used by Rust developers. It is not meant to be used by end-users ("customers") who have vJoy installed, unless they feel adventurous to code with Rust.

Usage

Please refer to the documentation to understand how to use the project. Read below to access the documentation.

Documentation

The project's documentation can be found at https://alex-smtv.github.io/rust-bindings-for-vjoy/vjoy_wrapper/index.html.

Additionally you can generate the documentation yourself with the command line cargo doc --no-deps --open.

Releases information

Be mindful of semver which the project makes use of. Releases will have numbers as MAJOR.MINOR.PATCH starting from 1.0.0. Before release 1.0.0, the convention will be 0.X.Y where X means new functionalities is available and Y means things changed (e.g. fixes) but nothing new is available to use. As a final note, releases before 1.0.0 are considered unstable and backwards compatibility between releases is not guaranteed.

Tests

Before tweaking and/or running tests, be mindful of complementary notes.

Also a special development setup is required with vJoy in order to perform tests correctly. Basically, some vJoy devices are reserved for testing purpose. The test_env module (found at ./src/lib.rs) will provide you further information of the needed setup.

License

The project is released under the MIT license.