Skip to content
quakecstudioPublic

About

QuakeC Studio: a modern IDE for QuakeC, the scripting language of id Software's Quake

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

4 stars

Watchers

1 watching

Forks

Latest commit

 

History

517 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

QuakeC Studio

A native, cross-platform IDE for QuakeC, the scripting language of id Software's original Quake, written in Rust. It has Zed's editor feel and Roblox Studio's play loop: edit code, press Play, and see the change in the running game in about a second. It ships its own QuakeC compiler (no outside toolchain), a built-in agent that edits, compiles and tests through the same commands as the UI (also exposed over MCP), and a map editor with its own map compiler.

The v1 play loop: the editor beside the game, docked in its own window

Concept mockup of the approved design, not a screenshot.

Status

Phases 0 to 7 are built: the QuakeC VM and formats, the compiler (checked against FTEQCC and id's qcc on the rerelease and public mods), the language server, the quakec-ide command line, the code editor, the live preview, the built-in agent, signed packages for every platform, and a map editor with entity and brush editing, textured and lit views, and our own map compilers with coloured light, region compile and a background full compile, checked against id's tools and ericw-tools. The MVP release, Phase 4's gate, waits on its sign-off. Work is tracked as GitHub issues generated from plan/, on the project board, and built by agents one phase at a time.

Every phase gate is closed. Post-MVP work is scheduled into a phase by an ADR before it starts.

Read first

Document What it covers
User guide The user guide, on the website: getting started, opening a mod, the play loop, debugging, the agent, MCP, the map editor, troubleshooting; its source is public/docs/ in quakecstudio/site
docs/roadmap.md The overall plan: decisions so far, layers, the phases and their gates, where we are, how to work an issue
docs/design/design-doc.md What we are building and why
docs/architecture.md A higher-level map of the subsystems: how the IDE and the engine fit together, the process model, and the edit-compile-preview play loop
docs/design/README.md The approved mockups and the design language
plan/README.md How the design becomes requirements, issues, phases and gates
docs/conventions.md Rust conventions (based on vouch)
docs/testing.md The testing bar: the per-layer readiness reviews of Phases 1 and 2, and the gate review each later phase has

Building

With rustup installed (the toolchain is pinned in rust-toolchain.toml):

cargo build --locked
cargo test --locked

CONTRIBUTING.md lists every check a change must pass. Report security problems as SECURITY.md describes.

License

GPL-3.0-or-later (LICENSE, ADR-0002). Code ported from id Software's Quake source, which id released under GPL-2.0-or-later, keeps id's copyright notice. Quake's game data is not included and never will be; you need your own copy of Quake.

QuakeC Studio is an independent project and is not affiliated with or endorsed by id Software, ZeniMax Media or Bethesda.

About

QuakeC Studio: a modern IDE for QuakeC, the scripting language of id Software's Quake

Topics

Resources

Code of conduct

Contributing

Security policy

Stars

4 stars

Watchers

1 watching

Forks

Releases

Sponsor this project

Packages

Used by

Contributors

Languages