# OpenPhys

[![Crates.io](https://img.shields.io/crates/v/openphys.svg)](https://crates.io/crates/openphys)
[![Documentation](https://docs.rs/openphys/badge.svg)](https://docs.rs/openphys)
[![License](https://img.shields.io/badge/license-AGPL--3.0-blue.svg)](https://github.com/CyntexMore/OpenPhys/blob/main/LICENSE)

**OpenPhys** is a simple physics engine library written in **Rust**.

- [GitHub](https://github.com/CyntexMore/OpenPhys) | [crates.io](https://crates.io/crates/openphys)

## Features

**OpenPhys** is early in development, a lot more features will be added in the future.

- Heat transfer simulation
- Calculate gravitational force
- Sandbox (\*pretty experimental)

## Installation

You can simply add **OpenPhys** to your project with `cargo add openphys`, or alternatively you can add it to your `Cargo.toml`:
```
[dependencies]
openphys = "0.1.3"
```

## Contributing

- [Contribution Guidelines](https://github.com/CyntexMore/OpenPhys/blob/main/docs/CONTRIBUTING.md)

## Documentation

Read the documentation on [doc.rs](https://docs.rs/openphys/latest/openphys) or alternatively generate it for yourself locally with `cargo doc`.

## License
- [AGPL-3.0 license](https://github.com/CyntexMore/OpenPhys/blob/main/LICENSE)