Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gilcoder/AI4U
AI4U is a plugin that allows you use the Godot Game Engine to specify agents with reinforcement learning. Non-Player Characters (NPCs) of games can be designed using ready-made components.
https://github.com/gilcoder/AI4U
artificial-intelligence games reinforcement-learning-environments virtual-reality
Last synced: 4 months ago
JSON representation
AI4U is a plugin that allows you use the Godot Game Engine to specify agents with reinforcement learning. Non-Player Characters (NPCs) of games can be designed using ready-made components.
- Host: GitHub
- URL: https://github.com/gilcoder/AI4U
- Owner: gilzamir18
- Created: 2019-08-26T00:52:19.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-05-27T03:39:03.000Z (7 months ago)
- Last Synced: 2024-05-29T00:15:00.364Z (7 months ago)
- Topics: artificial-intelligence, games, reinforcement-learning-environments, virtual-reality
- Language: C#
- Homepage:
- Size: 543 MB
- Stars: 61
- Watchers: 8
- Forks: 12
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- vr-resources - AI4U provides an easy way to connect python code with Unity games. This way, you can use the entire available Python machine learning culture to experiment machine learning algorithms and artificial intelligence with Unity
README
# AI4U - Artificial Inteligence For You
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).
# AI4U Components
There are two components required to run AI4U in a new project: Python scripts and C# scripts.
## Install Stable Python Scripts
To install the stable version of AI4U, run the command:
```bash
pip install ai4u
```
## Install Stable C# Scripts
Next, download the latest AI4U release [here](https://raw.githubusercontent.com/gilzamir18/AI4U/main/packages/ai4u.zip). Unzip this file and place it in the main directory of your Godot project.
## Install the Latest Python Scripts
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:
```bash
pip install -e .
```
This command fetches the latest modifications from the AI4U repository.
## Install the Latest C# Scripts
Clone the repository and copy the directory `addons/ai4u` to your project.
# Tutorials
* [Introduction](doc/introduction.md)
* [Don't Break the Game](doc/dontbreakthegame.md)
* [Events](doc/events.md)
* [AI4U and Stable-Baselines3](doc/stable_baselines3guide.md)
* [Using ONNX](doc/introductionwithonnxmodels.md)
* [Why Python?](doc/whypython.md)
# Requirements
* 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.
# Demo Projects
[Here](https://github.com/gilzamir18/ai4u_demo_projects) we will include AI4U demo projects that you can use for experimentation.
# Try AI4USharp
An experimental version of AI4U that don't depend of the Python is available [here](https://github.com/gilzamir18/AI4USharp).
# Maintainers
AI4U is currently maintained by Gilzamir Gomes ([email protected]), Creto A. Vidal ([email protected]), Joaquim B. Cavalcante-Neto ([email protected]) and Yuri Nogueira ([email protected]).
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á).