Skip to content

nathansamuell/CircuitCider

 
 

Repository files navigation

Stars Contributors Forks Issues


Logo

CircuitCider

A physics based robot dueler.
Report Bug · Request Feature

About The Project

CircuitCider

An open-source robot dueler focused on fast paced combat with (mostly)realistic physics.

Key Features

  • UDRF File Compatibility: Seamlessly import robots using any UDRF file, ensuring flexibility in exploring various robotic models.

Upcoming Features

  • Combat New features from traditional fighting games like dodging, melee and ranged combat, all with with physics forces and colliders!

  • Arena editor and Robot editor A new editor for saving/loading robots + saving/loading arenas for them to fight in

  • Robot AI path-planning + other AI features for robots to fight the player and eachother.

CircuitCider is an evolving project, and your contributions and feedback are crucial in shaping its future. Join the community, participate in development, and anticipate the exciting additions that will enhance the simulation and customization experience with CircuitCider.

(back to top)

Built With Bevy RUST_VERSION

(back to top)

Getting Started

Prerequisites

  • rust
  rustup update

Installation

  1. Create a new directory to contain the three required repositories, then move into that directory.
  mkdir <folder_name>
  cd <folder_name>
  1. Clone the repository
  git clone https://github.com/rydb/CircuitCider.git

Build and Run

  1. Navigate to your CircuitCider directory
  cd CircuitCider
  1. Compile and run CurcuitCider
  cargo run
  or
  //Run example

(back to top)

Roadmap

  • A robotics combat system
    • Melee Weapons
    • Ranged Weapons
    • Health System
  • AI agents
    • AI Pathfinding
  • Robot Editor
    • Prefab parts to build with
  • Improved UI

See the open issues for a full list of proposed features (and known issues).

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Distributed under the MIT License. See LICENSE.txt for more information.

(back to top)

Acknowledgments

(back to top)

About

A physics based robot dueler.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Rust 99.5%
  • Other 0.5%