edbeeching / godot_rl_agents

An Open Source package that allows video game creators, AI researchers and hobbyists the opportunity to learn complex behaviors for their Non Player Characters or agents
MIT License
909 stars 64 forks source link

Symbolic links on windows #26

Closed yaelatletl closed 1 year ago

yaelatletl commented 1 year ago

The repo is perfectly usable on Windows, but the symbolic links are not added by default and are confusing for most users. These cause other problems as well when using visual git clients such as GitKraken, which breaks after a few commits.

A solution could be changing these symbolic links to static directories, at the cost of manually updating every example. Another solution would be including commands for adding these links in the installation docs. (Must be run on a PowerShell with Administrator access)

Remove-Item -Path ".\envs\example_envs\BulletHell\addons\godot_rl_agents"
New-Item -ItemType SymbolicLink -Value ".\plugin\addons\godot_rl_agents" -Path ".\envs\example_envs\BulletHell\addons\godot_rl_agents"
Remove-Item -Path ".\envs\example_envs\BallChase\addons\godot_rl_agents"
New-Item -ItemType SymbolicLink -Value ".\plugin\addons\godot_rl_agents" -Path ".\envs\example_envs\BallChase\addons\godot_rl_agents"
Remove-Item -Path ".\envs\example_envs\FlyBy\addons\godot_rl_agents"
New-Item -ItemType SymbolicLink -Value ".\plugin\addons\godot_rl_agents" -Path ".\envs\example_envs\FlyBy\addons\godot_rl_agents"
Remove-Item -Path ".\envs\example_envs\GridWorld\addons\godot_rl_agents"
New-Item -ItemType SymbolicLink -Value ".\plugin\addons\godot_rl_agents" -Path ".\envs\example_envs\GridWorld\addons\godot_rl_agents"
Remove-Item -Path ".\envs\example_envs\JumperHard\addons\godot_rl_agents"
New-Item -ItemType SymbolicLink -Value ".\plugin\addons\godot_rl_agents" -Path ".\envs\example_envs\JumperHard\addons\godot_rl_agents"
Remove-Item -Path ".\envs\example_envs\SpaceShooter\addons\godot_rl_agents"
New-Item -ItemType SymbolicLink -Value ".\plugin\addons\godot_rl_agents" -Path ".\envs\example_envs\SpaceShooter\addons\godot_rl_agents"
Remove-Item -Path ".\envs\example_envs\VirtualCamera\addons\godot_rl_agents"
New-Item -ItemType SymbolicLink -Value ".\plugin\addons\godot_rl_agents" -Path ".\envs\example_envs\VirtualCamera\addons\godot_rl_agents"
edbeeching commented 1 year ago

Thanks for the comment, I have made this change when I moved the examples to: https://github.com/edbeeching/godot_rl_agents_examples Let me know of any other issues!