FerrisScript Documentation

FerrisScript Documentation

A Rust-inspired scripting language for the Godot game engine πŸ¦€βœ¨

FerrisScript brings Rust’s syntax clarity and safety concepts to Godot game development, providing a familiar experience for Rust developers while offering excellent error messages and tooling support.


πŸ“– Error Codes

Comprehensive reference for all compiler errors with examples and fixes.

Browse Error Codes β†’

πŸ—οΈ Architecture

Learn about FerrisScript's compiler architecture and design decisions.

View Architecture β†’

❓ FAQ

Frequently asked questions about FerrisScript usage and features.

Read FAQ β†’

πŸ‘¨β€πŸ’» Development

Contributing guide and development workflow documentation.

Development Guide β†’

πŸ“š Documentation Sections

Error Documentation

FerrisScript provides comprehensive error documentation with:

β†’ Browse All Error Codes

Planning & Roadmap

Current development planning for v0.0.3:

Development Resources


🎯 Version Status

Current Version: v0.0.2
In Development: v0.0.3 (Error System Enhancements)

v0.0.3 Progress

View detailed roadmap β†’


πŸ” Quick Error Code Lookup

Common error codes by category:

Lexical Errors (E001-E099)

Syntax Errors (E100-E199)

Type Errors (E200-E299)

Runtime Errors (E400-E499)

β†’ View All Error Codes


πŸ› οΈ Getting Started

Installation

# Clone the repository
git clone https://github.com/dev-parkins/FerrisScript.git
cd FerrisScript

# Build the project
cargo build --release

# Run tests
cargo test --workspace

Quick Example

// hello.ferris
fn _ready() {
    print("Hello from FerrisScript!");
}

Error Messages

FerrisScript provides helpful error messages with source context:

error[E201]: Undefined variable
  --> example.ferris:5:10
   |
 5 |     let x = velocty;
   |             ^^^^^^^ not found in this scope
   |
help: did you mean 'velocity'?
   = note: see https://github.com/dev-parkins/FerrisScript/blob/main/docs/ERROR_CODES.md#e201-undefined-variable for more information

🀝 Contributing

We welcome contributions! Check out:


πŸ“„ License

FerrisScript is distributed under the MIT License.



Last updated: October 14, 2025