AI4U tool AI4U is a agent framework for modeling virtual reality and game environment. This repo we keep the reference implementation for Godot Game Engine.
The Godot version of the AI4U get advantage of the Godot architecture and facilitate agent specification by means of an agent abstraction. In Godot, AI4U provides a alternative approach to modeling Non-Player Characters (NPC). Although, developers can apply this tool in others situations, for example, the modeling environment for artificial intelligence experiments.
Agent abstraction defines an agent living in a environment and interacting with this environment by means of sensors and actuators. So, NPC specification is a kind of agent specification. Agent's components are: sensors, actuators, events, reward functions and brain. Sensors and actuators are the interface between agents and environments. A sensor provides data to an agent's brain, while actuators send actions from agent to environment. A brain is a script that proccessing sensors' data e made a decision (selects an action by time).
There are two components required to run AI4U in a new project: Python scripts and C# scripts.
To install the stable version of AI4U, run the command:
pip install ai4uNext, download the latest AI4U release here. Unzip this file and place it in the main directory of your Godot project.
The Python component of AI4U can be installed using a local pip package. To install it, navigate to the directory pyplugin/ai4upy/ai4u and run the command:
pip install -e .This command fetches the latest modifications from the AI4U repository.
Clone the repository and copy the directory addons/ai4u to your project.
- Godot 4.2.2 Mono Version.
- Python 3.12.
- Micrsoft.ML.OnnxRuntime.
- Gynasium.
- Tested in Windows 11 and Ubuntu 24.04.
The minimum recommended hardware for AI4U is a computer with at least a GeForce 1050ti (4GB VRAM), 8GB of RAM, and at least 20GB of SSD storage. Naturally, the memory requirement can increase significantly if complex inputs are used in the agent's sensors (such as images) and if algorithms like Soft-Actor-Critic (SAC) and DQN are employed. For truly interesting use cases, such as using SAC with an image sensor, a computer with at least 24GB of RAM and a high-end GPU is necessary. For games, we recommend modest sensor configurations, such as moderate use of RayCasting.
Here we will include AI4U demo projects that you can use for experimentation.
I love developing this project; particularly, I take pleasure in it. Due to health issues, I have reduced development here. However, I had an idea for developing a game using AI4U tools. If you want to bet on this idea, I'll make an effort to continue developing AI4U in the context of this new idea. Then, I'll update AI4U as I progress. If you want to support the project, use the QR CODE above to donate any amount. Thank you.
AI4U is currently maintained by Gilzamir Gomes (gilzamir_gomes@uvanet.br), Creto A. Vidal (cvidal@dc.ufc.br), Joaquim B. Cavalcante-Neto (joaquimb@dc.ufc.br) and Yuri Nogueira (yuri@dc.ufc.br).
Important Note: We do not do technical support, nor consulting and don't answer personal questions per email. How To Contribute To any interested in making the AI4U better, there is still some documentation that needs to be done. If you want to contribute, please read CONTRIBUTING.md guide first.
Acknowledgments AI4U was created in the CRab (Computer Graphics, Virtual Reality and Animations) Labs at UFC (Universidade Federal do Ceará).