diff --git a/README.md b/README.md index 1df2768a..f092afae 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,38 @@ -![A logo saying RocketSim](https://user-images.githubusercontent.com/36944229/219303954-7267bce1-b7c5-4f15-881c-b9545512e65b.png) +![RocketSim logo](https://media.discordapp.net/attachments/1433039739996344424/1495335804711735416/rocketsim.png?ex=69e5df7d&is=69e48dfd&hm=65a46e4438a241d07f97c257ad0e5ef41ae0019e9e13d5f12d5c5a09cf7dc9d6&=&format=webp&quality=lossless&width=1765&height=524) **A Rust library for simulating Rocket League games at maximum efficiency** -A port of . All the credit goes to Zealan for doing the hard work. +This is an optimized port of RocketSim to Rust, by ZealanL and VirxEC. ## What is this? -This repo is my attempt and simplifying and optimizing RocketSim. -It does not care for Bullet compatibility, and removes as many abstrations as possible. +This branch is an attempt and simplifying and optimizing RocketSim.
+It is based off of Virx's rebuild of Bullet in Rust.
-This project is currently a massive WIP, and highly experimental. -Lots of features found in RocketSim are currently missing. +> [!CAUTION] +> This project is currently a massive WIP, and highly experimental.
+> Many features found in RocketSim are currently missing. + +## How accurate is it? + +This version of RocketSim is **not** as accurate in its current state as the version on the *main* branch.
+To see a list of use cases that RocketSim is suitable for, see that branch. + +## What's done? + +Only the **Soccar** gamemode is close to completion, with no other gamemodes at the moment.
+There is a built-in visualizer implemented for viewing the simulation as it runs, unlike the C++ versions which require you to get a visualizer yourself. + +## OK, but how *fast* is it? + +Right now, it roughly mirrors the speed of the *main* branch, although this can change and fluctuate depending on car count and other parameters. + +## How do I use it? + +Right now, this version of RocketSim is **not** for typical usage. Things are changing all the time, and almost nothing is actually done.
+I recommend you just stick to Virx's Rust bindings (https://github.com/VirxEC/rocketsim-rs) for now if you really want to use Rust.

+ +> [!IMPORTANT] +> **This is a legal notice directed at Epic Games / Psyonix.**
+> RocketSim was written to replicate Rocket League's game logic, but does not actually contain any code from the game.
+> If there is an issue with this, let me (@zealanl) know on Discord and we can resolve it.