v4.0.0

Introducing Animal-AI v4.0.0!

NOTE: We are moving away from Animal-AI v3.1.4.experimental. This is the foundational build towards a stable v5.0.0 Animal-AI build.

What's New?

i. New valenced objects: DecoyGoal, DecoyGoalBounce (see docs here). However, in short, these new objects have no reward value and have a grey colour (only size can be changed), which behave as a regular valenced object, such as GoodGoal.

ii. New UI elements/data presentation: Arena Index and Total Objects (see screenshot below). The purpose of this new UI is to inform the user (play mode or training) the current arena index (starts at 1, which means arena indexed at 0 in the yaml file, this equates to arena index 1 in the UI) and the total number of the arenas defined (i.e. arena 1 out of 5). In addition, the purpose of the total objects UI element is significant for the current arena, meaning it is respective of how many objects are spawned in the current arena index, and not a combined integer for the whole yaml file.

iii. A few (perhaps not so notable changes) are made in the type of text used to present the UI information, such as reward value and health. The old, legacy logic has been removed and a new, modern and more advanced text component is now used for all texts displayed in the UI. This has provided an extra 4FPS on average (impressive for the simple change I made in my opinion). In conclusion, all text elements are now sharper and have a new, fresh look in terms of colour and backgrounds.

iv. In a more technical regard, general script optimisation was implemented, particularly on the scripts TrainingArena.cs and PlayerControls.cs. These scripts are now more readable and efficient.

v. Minor changes: the colour of the health bar has been changed from BLUE to GREEN (100% health). The colour spectrum is GREEN -> YELLOW (50% health) -> RED (0% health). The valanced objects RIPENGOAL and DECAYGOAL used to have purple colour in the logic (transition values directly altered the colour of the object colour, with purple implemented at some stage) which now has been removed. There is only GREY -> YELLOW for RIPENGOAL and YELLOW -> GREY for DECAYGOAL.

For a complete look, see CHANGELOG.md.

Getting Started:

Check our Installation Guide (here) and/or our Launching Animal-AI Guide (here) for a more detailed look.

But in brief:

• Download Animal-AI OS build for your system from below
• Extract files anywhere you'd like on your system (we use Winrar to package application contents)
• Run .exe/.app file (depending on your system) in the extracted folder of Animal-AI

---

N.B: If you are using Linux, you may need to make the .exe file executable: Simply run this command in your terminal: chmod +x env/AnimalAI.x86_64. If you are using MacOS, you may also need to run this command: chmod -R 777 [applicationName].app in your MacOS terminal to unlock permissions for running the application. Edit: Please also make sure when you extract the folder, you move the files inside the sub-directory to its parent folder.

What's Changed

• [MAJOR] PR - Overhaul Repository Structure by @alhasacademy96 in #45

Full Changelog: v3.1.4...v4.0.0

Screenshots:

AnimalAI - v3.1.4.exp

Introducing AAI v3.1.4.exp!

Various major bug fixes and improvements to overall project is the theme of this release (see timeline at homepage for details).
Note that this release is intended to be accessible to reviewers for our publication of Animal-AI 3 and a stable version will be released soon.

Steps:

• Download AAI-3 OS build for your system from below
• Extract files anywhere you'd like on your system (we use Winrar to package application contents)
• Run .exe/.app file (depending on your system) in the extracted folder of AAI-3

---

N.B: If you are using Linux, you may need to make the .exe file executable: Simply run this command in your terminal: chmod +x env/AnimalAI.x86_64. If you are using MacOS, you may also need to run this command: chmod -R 777 [applicationName].app in your MacOS terminal to unlock permissions for running the application. Edit: Please also make sure when you extract the folder, you move the files inside the sub-directory to its parent folder.

What's Changed

• Update configFile.md by @Heredone in #38
• Update configFile.md by @Heredone in #40
• installationGuide.md changed by @Heredone in #43
• Corrected some grammar and re-worded. by @Heredone in #41
• Added initial description for pillar button outlined. by @Heredone in #42

New Contributors

• @Heredone made their first contribution in #38

Full Changelog: v3.1.3...v3.1.4

AnimalAI - v3.1.3

Introducing AAI v3.1.3!

Various major bug fixes and improvements to overall project is the theme of this release (see timeline at homepage for details).

Steps:

1. Download AAI-3 OS build for your system from below
2. Extract files anywhere you'd like on your system (we use Winrar to package application contents)
3. Run .exe/.app file (depending on your system) in the extracted folder of AAI-3
4. Enjoy!

---

N.B: If you are using Linux, you may need to make the .exe file executable: Simply run this command in your terminal: chmod +x env/AnimalAI.x86_64. If you are using MacOS, you may also need to run this command: chmod -R 777 [applicationName].app in your MacOS terminal to unlock permissions for running the application. Edit: Please also make sure when you extract the folder, you move the files inside the sub-directory to its parent folder.

---

Full Changelog: 3.1.2...v3.1.3, #36 #33 #8 #7
Kinds-of-Intelligence-CFI/animal-ai-unity/pull/22

AnimalAI - v3.1.2.exp

Introducing AAI v3.1.2.exp[erimental].

This build is in experimental status so not everything might work or corrected (regarding the changes detailed below:).

• Fixed the Spawner Tree "clock" discrepancy,
• Introducing the final version of End-of-Episode Notification feature, with a brand new look (with sound effects added).
  • Increased the time to start next episode after showing the notification from 2seconds to 5seconds.
  • Fixed a bug where there would be multiple GIFs playing in the background when health reaches 0.
• Modified Spawner Pillar Button to make it more robust to handling missing rewards, weights and probability values.
  • Also added functionality to spawn rewards randomly individually for each axis.
  • Also added functionality to define each reward a max number of times to spawn (-1 meaning spawn infinitely)
• [New Feature] Camera and Reset buttons now toggled on/off by specifying in the yaml file.
  • LIMITATION: Currently, the first person perspective camera is not being toggled, only birds eye and 3rd person perspectives.
• Cleaned relevant scripts to the above additions/modifications for improved code readability and functionality.

Steps:

1. Download AAI-3 OS build for your system from below
2. Extract files anywhere you'd like on your system (we use Winrar to package application contents)
3. Run .exe/.app file (depending on your system) in the extracted folder of AAI-3
4. Enjoy!

---

N.B: If you are using Linux, you may need to make the .exe file executable: Simply run this command in your terminal: chmod +x env/AnimalAI.x86_64. If you are using MacOS, you may also need to run this command: chmod -R 777 [applicationName].app in your MacOS terminal to unlock permissions for running the application. Edit: Please also make sure when you extract the folder, you move the files inside the sub-directory to its parent folder.

What's Changed

• Adapt environment to allow changes to timescale and framerates for more control by @kozzy97 in #28
• Improved raycastparser.py by @alhasacademy96 in #29

Full Changelog: v3.1.0...3.1.2

AnimalAI - v3.1.1

Added new feature - Interactive Button for Rewards + various bug fixes and improvements.
#12

Steps:

1. Download AAI-3 OS build for your system from below
2. Extract files anywhere you'd like on your system (we use Winrar to package application contents)
3. Run .exe/.app file (depending on your system) in the extracted folder of AAI-3
4. Enjoy!

Update to v3.1.1**: Hotfix for an unnoticed error (related to Spawner_InteractiveButton), plus introduced End-of-Episode Notification feature (draft, incomplete but workable).

N.B: If you are using Linux, you may need to make the .exe file executable: Simply run this command in your terminal: chmod +x env/AnimalAI.x86_64. If you are using MacOS, you may also need to run this command: chmod -R 777 [applicationName].app in your MacOS terminal to unlock permissions for running the application. Edit: Please also make sure when you extract the folder, you move the files inside the sub-directory to its parent folder.

What's Changed

• more-detailed by @alhasacademy96 in #17
• Agent Directory and Random Walkers by @kozzy97 in #18
• Add random action and random walker agents by @kozzy97 in #21
• Fix the building off eggs by fixing the repo structure by @wschella in #23

New Contributors

• @kozzy97 made their first contribution in #18
• @wschella made their first contribution in #23

Full Changelog: v3.0.2...v3.1.0

AnimalAI - v3.0.2

(If you would still like to use an older version of AAI-3, please follow the instructions on the GitHub page, as this release is the current and latest version of AAI-3)

Upgraded version of AnimalAI 3, with updated Mlagents and Unity Engine. #15

Steps:

1. Download AAI-3 OS build for your system
2. Extract files anywhere you'd like on your system (we use Winrar to package application contents)
3. Run .exe/.app file (depending on your system) in the extracted folder of AAI-3
4. Enjoy!

---

N.B: If you are using Linux, you may need to make the .exe file executable: Simply run this command in your terminal: chmod +x env/AnimalAI.x86_64. If you are using MacOS, you may also need to run this command: chmod -R 777 [applicationName].app in your MacOS terminal to unlock permissions for running the application. Edit: Please also make when you extract the folder, you move the files inside the sub-directory to its parent folder.

Readme.txt

What's Changed

• updated mlagents to 2.3.0-exp by @alhasacademy96 in #15

New Contributors

• @alhasacademy96 made their first contribution in #15

Full Changelog: v2.2...v3.0.2