tirbofish/dropbear · commit
04539394b64995b8493e9304abadcf8feabef6c0
Update readme
updated readme to fix up any old stuff.
Signature present but could not be verified.
Unverified
@@ -1,19 +1,20 @@ -# dropbear +# dropbear -dropbear is a game engine used to create games. It's made in rust. It's name is a double entendre, with it being the nickname of koalas but also fits in nicely with the theme of rust utilising "drops". +dropbear is a game engine used to create games. It's made in rust. It's name is a double entendre, with it being the nickname of koalas but also fits in nicely with the theme of rust utilising memory management with "drops". If you might have not realised, all the crates/projects names are after Australian flora and fauna. ## Related projects -- [eucalyptus](https://github.com/4tkbytes/dropbear/tree/main/eucalyptus) is the visual editor used to create games visually, taking inspiration from Unity and other engines. -- [redback](https://github.com/4tkbytes/dropbear/tree/main/redback) is the runtime used to load .eupak files and run the games loaded on them. +- [eucalyptus](https://github.com/4tkbytes/dropbear/tree/main/eucalyptus) is the visual editor used to create games visually, taking inspiration from Unity, Roblox Studio and other engines. +- [redback](https://github.com/4tkbytes/redback-runtime) is the runtime used to load .eupak files and run the games loaded on them. ## Build To build, ensure build requirements, clone the repository, then build it. It will build in debug mode, and use a lot of packages, so if your CPU is not fast enough for building you should brew a cup of coffee during the build time. With Unix systems (macOS not tested), you will have to download a couple dependencies if building locally: + <!-- If you have a macOS system, please create a PR and add your own implementation. I know you need to use brew, but I don't know what dependencies to install. --> ```bash @@ -29,6 +30,11 @@ After downloading the requirements, you are free to build it using cargo. ```bash git clone git@github.com:4tkbytes/dropbear cd dropbear + +# ensure submodules are checked-out +git submodule init +git submodule update + # this will build all the projects in the workspace, including eucalyptus and redback. cargo build ``` @@ -39,7 +45,9 @@ If you do not want to build it locally, you are able to download the latest acti ## Usage -Depsite it looking like a dependency for `eucalyptus`, it can serve as a framework too. Looking through the `docs.rs` will you find related documentation onhow to use it and for rendering your own projects. +~~Depsite it looking like a dependency for `eucalyptus`, it can serve as a framework too. Looking through the `docs.rs` will you find related documentation onhow to use it and for rendering your own projects.~~ + +dropbear cannot be used as a framework (yet), but is best compatible with the eucalyptus editor when making games. For scripting, eucalyptus uses `rhai`, a new language that works with rust.
Large diffs are not rendered by default. Showing the first 50 of 65 lines. Show full diff