Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sorax5 committed Aug 30, 2024
1 parent 0414333 commit 6ae763d
Showing 1 changed file with 41 additions and 0 deletions.
41 changes: 41 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,44 @@
</p>

# Physics Engine in a Minecraft Plugin
## Showcase
[![Showcase](https://img.youtube.com/vi/NDn6jCuOFAc/0.jpg)](https://www.youtube.com/watch?v=NDn6jCuOFAc&lc=UgxVySVQGbuG6Za8deV4AaABAg)

## Commands

physics.create.box
```/physics create box <block> <mass> <xScale> <yScale> <zScale>``` - Create a box with the specified parameters.

physics.create.sphere
```/physics create sphere <block> <mass> <radius>``` - Create a sphere with the specified parameters.

physics.clear
```/physics clear``` - Clear all physics objects.

physics.freeze
```/physics freeze``` - Freeze all physics objects.

physics.timespan
```/physics timespan <timespan>``` - Set the timespan for the physics engine default 1/20.

physics.substeps
```/physics substeps <substeps>``` - Set the substeps for the physics engine default 30.

physics.chunk
```/physics chunk <chunk>``` - Convert a chunk to a physics object.

help
```/physics help``` - Show the help message.

## Download
You can download the plugin from the dev builds [here](https://github.com/Sorax5/SoraxPhysic/actions).
You will need worldedit to use the plugin.

## Developer Note
This plugin is still in development and is not recommended for production servers. The plugin is still in the early stages of development and may contain bugs. If you find any bugs, please report them in the issues tab.

In case you use it, have fun with the plugin and if you have any questions, feel free to contact me on discord soraxdubbing.

## License
this plugin is licensed under the GPL-3.0 license. You can find more information in the LICENSE file.

0 comments on commit 6ae763d

Please sign in to comment.