<br><br>
<div align="center">
<img src="assets/img/logo/readme/logo-white-cropped.png" alt="Antaeus Logo" width="15%" style="margin-bottom: -50px;">
</div>
<h1 align="center" style="margin-top: -50px;">Ἀνταῖος</h1>
Antaeus is a versatile, next-gen framework based on [Vexide](https://vexide.dev)
# Philosophy
Antaeus aims to be a bleeding-edge, batteries-included framework that can be
to code Vex v5 robots. It aims to integrate newer, features that are
specialized for such robots. Its modular approach allows algorithms to be
stacked on top of each other to create more advanced composite algorithms.
## Comparison with Evian
[Evian](https://github.com/vexide/evian) is a framework based on Vexide as well
that Antaeus was inspired by. It aims to be a extensible framework that
is easy to use as well. However, Antaeus aims to be a more advanced, modern
framework that can bring Vex to a new level. It includes heavily modified
algorithms suited specifically for Vex Robots. It is bleeding edge as well,
which means that the API will often change between versions. Hence, it is
important that you carefully pick which library you would like to use before
continuing.
## A Notice before using Antaeus
It is important that you understand concepts used in this library such as
Odometry and Pure Pursuit. This library aims to be simple to implement but
expects you to understand these concepts before using it and therefore learn
more in the process. Please do not just "plug in" this library and use it
without thinking much. If you have new ideas, you are really really encouraged
to contribute to this library and/or create your own library. More on
contribution can be found in [CONTRIBUTING.md](./CONTRIBUTING.md).
## Is Antaeus for you?
If you:
- would want a easy-to-use/plug & play library for your team, or
- are a new team and would like a beginner-friendly library, or
- don't know what is pure pursuit, odometry or a Kalman filter, or
- have only a week left for the competition and need to code fast,
I'm sorry, this library isn't for you. But if you:
- need a advanced, cutting-edge library to code your autonomous, and
- are willing to fix bugs by yourself (though rare), and
- are willing to create your own algorithms (if you do, feel free to open a pr),
then, this framework will be helpful.
---
# Current State of Development
Anteaus is currently in the early stages of development. We are working on
implementing the core features and improving the documentation. We are also
looking for contributors to help us with the development process. If you are
interested in contributing, please check out our
[CONTRIBUTING.md](./CONTRIBUTING.md) file.
> [!WARNING]
> Anateus is lacking testers! More information can be found in
> [CONTRIBUTING.md](./CONTRIBUTING.md).
# Use of AI
It is often impossible to completely negate the use of AI in our modern
world. However, I have greatly limited the use of AI in this repo.
Currently, more than 90% of source code is written by humans only. AI
has only been used to write doc comments.