"If Psych was so good, why wasn’t there a Psych 2?"

---

Table of Contents

• Downloads
• Overview
• Key Differences from Psych
• Current Limitations
• Contributing
• Community
• Credits
• License

---

Downloads

• Official tagged releases are not available yet.
• For stability, wait for tagged releases.
• For testing or experimenting, use the GitHub Actions builds above.

See the Getting Started Guide for setup instructions.

• Look at Our Unique Lua API documentation for scripting reference.

For players: press Ctrl + Shift + M to open the Mods menu.

---

Overview

ALE Psych is a fork of Psych Engine 0.7.3, created to replace ALE Engine, fix long-standing issues, and add new features.

The goal is simple: give developers the tools to build complete mods without touching the source code, while keeping the comfort and flexibility that Psych Engine provided.

---

Key Differences from Psych

• Scripted menus and submenus (Lua and HScript).
• Support for custom classes.
• Support for 3D Objects.
• Configurable data.json for engine/game properties.
• JSON-based options and credits.
• Integration with RuleScript for advanced HScript features.
• Reorganized source structure, especially Lua.
• Memory cleanup on menu changes.
• Redesigned song loading (charts, scripts, audio).
• CoolUtil.save replaces FlxG.save to avoid conflicts between mods.
• Access the Game Console with F2.

---

Current Limitations

Click to expand

• Editors are unstable and may crash. Use Psych 0.7.3 for editor work.
• Some performance issues may still exist.
• Documentation is incomplete.
• Certain HScript/Lua functions are missing.
• Transitions, pause menu, game over, and default songs are not fully customizable.
• Original week backgrounds are still in source; planned rewrite in HScript.
• Options menu rewrite and note color customization are pending.
• More Lua functions and extensible classes are planned.

---

Contributing

We welcome contributions:

• Report issues and request features via Issues.
• Submit pull requests that follow the existing coding style.
• Test changes on at least one desktop platform.
• Document new features in the Wiki.

---

Community

• Chat with developers and modders on Discord.
• Share feedback and ideas in GitHub Discussions.
• Follow updates and contribute to the project.

---

Credits

• AlejoGDOfficial — Director and Lead Programmer
• Kriptel — RuleScript integration
• ManuArtz — Art
• Malloy — Rewrote README + Made Wiki
• Psych Engine Team — Original base project
• And all contributors

---

License

ALE Psych is released under the Apache License 2.0.
See LICENSE for details.