This folder contains documentation for anyone wanting to contribute to Vyxal.

To get started with the tools Vyxal needs (which aren't a lot), see the guide on Getting Started. Once you're done getting set up, you probably want to read the Markdown files on how the interpreter works in approximately this order:

1. High level overview of lexing/tokenizing
2. High level overview of parsing
3. High level overview of Interpreter
4. Element implementation
5. Modifier implementation
6. Writing tests

If any part of the documentation is lacking (either the Markdown files here or doc comments in the source code), please let us know (through an issue or in chat) so we can improve it.

We use the Mill build tool. See Building.md for more information.

If you don't know Scala but do know another language, here are some helpful guides:

• Scala for Python devs
• Scala for Java devs
• Scala for JavaScript devs