Crate rlgym_sim_rs
source ·Expand description
This crate allows the ability to use Rust’s safety and performance to run an RLGym-like instance of RocketSim.
It should closely follow what the RLGym docs describe to correctly configure the gym however there are some key differences.
The first difference is that rlgym-sim-rs allows one observation builder per agent.
This means that if you have setup a 3v3 match or switch to a 3v3 match at any point, there must be 6 observation builders provided.
You can either do this via the make() function initially or you can use the .update_config() of Gym.
The second difference is that terminal conditions are evaluated from one function instead of allowing for multiple to be used. You can use CombinedTerminalConditions in order to use multiple terminal conditions at once.
Example of usage
See make() as a place to start.
The file lib.rs in examples also has an example scenario for Python bindings with PyO3 if necessary.
Also, see basic_example.rs in examples.
The tests are generally also a good place to look at.
Status of development
- The crate should currently be considered as not stable although (as far as is known) all basic features are available for use from RLGym.
- Breaking changes may occur though there will be an attempt to keep them as low as possible.
- More documentation should be written soon and more data from RocketSim will likely be available for use in the gym.
Re-exports
pub use gym::Gym;pub use make::MakeConfig;pub use make::RenderConfig;pub use make::make;pub use action_parsers::action_parser::ActionParser;pub use action_parsers::discrete_act::DiscreteAction;pub use action_parsers::continous_act::ContinuousAction;pub use state_setters::default_state::DefaultState;pub use state_setters::state_setter::StateSetter;pub use state_setters::random_state::RandomState;pub use state_setters::weighted_state_setter::WeightedSampleSetter;pub use obs_builders::advanced_obs::AdvancedObs;pub use obs_builders::obs_builder::ObsBuilder;pub use conditionals::common_conditions::GoalScoredCondition;pub use conditionals::common_conditions::TimeoutCondition;pub use conditionals::common_conditions::NoTouchTimeoutCondition;pub use conditionals::extra_conditions::NoTouchKickoffTimeoutCondition;pub use conditionals::extra_conditions::CombinedTerminalConditions;pub use conditionals::terminal_condition::TerminalCondition;pub use math::clip;pub use math::cosine_similarity;pub use math::get_dist;pub use math::vec_div_variable;pub use math::element_mult_vec;pub use math::element_div_vec;pub use math::element_add_vec;pub use math::element_sub_vec;pub use math::norm_func;pub use math::scalar_projection;pub use math::vector_projection;pub use math::rand_uvec3;pub use math::rand_vec3;pub use math::trace;pub use math::unitvec;pub use math::squared_vecmag;pub use reward_functions::combined_reward::CombinedReward;pub use reward_functions::reward_fn::RewardFn;pub use reward_functions::common_rewards::ball_goal_rewards;pub use reward_functions::common_rewards::player_ball_rewards;pub use reward_functions::common_rewards::misc_rewards;pub use reward_functions::common_rewards::conditional_rewards;pub use state_generator::combined_gen::CombinedStateGenerator;pub use state_generator::common_state_mods;pub use state_generator::state_modifier::StateModifier;pub use state_setters::wrappers::car_wrapper::IntoArray;