jaroslaw/bevy_scriptum
1
0
Fork 0
Code Issues Pull requests 2 Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Jaroslaw Konik 2023-06-21 16:53:01 +02:00
parent fc4a525182
commit dbdb8f20b3
2 changed files with 2 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
README.md
View file

@ -3,6 +3,7 @@
⚠️ **Pre-release, alpha version**: API is bound to change, bugs are to be expected. ⚠️ **Pre-release, alpha version**: API is bound to change, bugs are to be expected.
bevy_scriptum is a a plugin for [Bevy](https://bevyengine.org/) that allows you to write some of your game logic in a scripting language. bevy_scriptum is a a plugin for [Bevy](https://bevyengine.org/) that allows you to write some of your game logic in a scripting language.
Currently, only [Rhai](https://rhai.rs/) is supported, but more languages may be added in the future.
It's main advantages include: It's main advantages include:
- low-boilerplate - low-boilerplate
@ -73,8 +74,6 @@ which you can then call in your script like this:
fun_with_string_param("Hello world!"); fun_with_string_param("Hello world!");
``` ```
Currently, only [Rhai](https://rhai.rs/) is supported, but more languages may be added in the future.
### Usage ### Usage
Add the following to your `Cargo.toml`: Add the following to your `Cargo.toml`:

3
src/lib.rs
View file

@ -1,6 +1,7 @@
//! ⚠️ **Pre-release, alpha version**: API is bound to change, bugs are to be expected. //! ⚠️ **Pre-release, alpha version**: API is bound to change, bugs are to be expected.
//! //!
//! bevy_scriptum is a a plugin for [Bevy](https://bevyengine.org/) that allows you to write some of your game logic in a scripting language. //! bevy_scriptum is a a plugin for [Bevy](https://bevyengine.org/) that allows you to write some of your game logic in a scripting language.
//! Currently, only [Rhai](https://rhai.rs/) is supported, but more languages may be added in the future.
//! //!
//! It's main advantages include: //! It's main advantages include:
//! - low-boilerplate //! - low-boilerplate
@ -71,8 +72,6 @@
//! fun_with_string_param("Hello world!"); //! fun_with_string_param("Hello world!");
//! ``` //! ```
//! //!
//! Currently, only [Rhai](https://rhai.rs/) is supported, but more languages may be added in the future.
//!
//! ## Usage //! ## Usage
//! //!
//! Add the following to your `Cargo.toml`: //! Add the following to your `Cargo.toml`: