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

See the Master Roadmap for current version status and what’s planned next.

Development Resources


🎯 Version Status

Current Version: v0.0.5 (“Stabilization & Engine Modernization”)
Godot: 4.2+ (tested against 4.7) · gdext: 0.5.4 · Rust: 1.94+ (Edition 2024)

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: July 21, 2026