-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
9 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -9,7 +9,7 @@ | |
|
||
## About | ||
|
||
Nature2D is a 2D physics library designed for and on Roblox! Ever wanted to create 2D games but step back because Roblox doesn't have a built-in 2D physics engine? Use Nature2D to create versatile and smooth simulations and mechanics for your 2D games with minimum effort! Nature2D primarily uses methods of [Verlet Integration](https://en.wikipedia.org/wiki/Verlet_integration) and [Convex Hull collisions](https://en.wikipedia.org/wiki/Hyperplane_separation_theorem). | ||
Nature2D is a 2D physics library designed for and on Roblox. Ever wanted to create 2D games but step back because Roblox doesn't have a built-in 2D physics engine? Use Nature2D to create versatile and smooth simulations and mechanics for your 2D games with minimum effort. Nature2D primarily uses methods of [Verlet Integration](https://en.wikipedia.org/wiki/Verlet_integration) and [Convex Hull collisions](https://en.wikipedia.org/wiki/Hyperplane_separation_theorem). | ||
|
||
RigidBodies and constraints can potentially be made with almost all UI elements, from Frames to TextBoxes. Create almost anything you can imagine. From bouncy boxes to destructible structures, even character movement in no time. Here's a wrecking ball connected to an invisible constraint knocking a few boxes off of the blue platform. | ||
|
||
|
@@ -23,34 +23,33 @@ Created something cool with Nature2D? Open an [issue](https://github.com/jaipack | |
|
||
## Getting Started | ||
|
||
**Using the CLI** - You can clone the repository on your local device and start experimenting! | ||
**Using the CLI** - You can clone the repository on your local device and start experimenting. | ||
```bash | ||
$ git clone https://github.com/jaipack17/Nature2D.git | ||
``` | ||
**Roblox Model** - Nature2D is available on the Roblox asset store for free. You can get the model through the following link.<br/> | ||
|
||
https://www.roblox.com/library/7625799164/Nature2D | ||
|
||
**Using wally** - Use [wally](https://github.com/UpliftGames/wally), a package manager for roblox to install Nature2D in your external code editor! This requires wally to be installed on your device. Then, add Nature2D to the dependencies listed in your `wally.toml` file!<br/> | ||
**Using wally** - Use [wally](https://github.com/UpliftGames/wally), a package manager for roblox to install Nature2D in your external code editor. This requires wally to be installed on your device. Then, add Nature2D to the dependencies listed in your `wally.toml` file.<br/> | ||
```toml | ||
[dependencies] | ||
Nature2D = "jaipack17/[email protected]" | ||
``` | ||
After that, Run `wally install` in the CLI! Nature2D should be installed in your root directory. If you encounter any errors or problems installing Nature2D using wally, [open an issue!](https://github.com/jaipack17/Nature2D/issues) | ||
After that, Run `wally install` in the cli. Nature2D should be installed in your root directory. If you encounter any errors or problems installing Nature2D using wally, [open an issue!](https://github.com/jaipack17/Nature2D/issues) | ||
|
||
Require the library and start coding! | ||
Require the library and start coding. | ||
|
||
```lua | ||
local ReplicatedStorage = game:GetService("ReplicatedStorage") | ||
local Nature2D = require(ReplicatedStorage.Nature2D) | ||
|
||
local engine = Nature2D.init(screenGuiInstance) | ||
--[[ | ||
Code here, check out the API and examples under docs/api and docs/examples! | ||
]]-- | ||
|
||
-- code | ||
``` | ||
To get familiar with the library, you can go through the documentation. Documentation is available at https://jaipack17.github.io/Nature2D/! | ||
To get familiar with the library, you can go through the documentation. Documentation is available at https://jaipack17.github.io/Nature2D/. | ||
|
||
## Contribution | ||
|
||
If you encounter bugs or would like to support this project by improving the code, adding new features or fixing bugs - Feel free to open issues and pull requests! Also read the [contribution guide](https://github.com/jaipack17/Nature2D/blob/master/CONTRIBUTING.md)! | ||
If you encounter bugs or would like to support this project by improving the code, adding new features or fixing bugs - Feel free to open issues and pull requests. Also read the [contribution guide](https://github.com/jaipack17/Nature2D/blob/master/CONTRIBUTING.md). |