erysdren/QCVM

A bite-sized QuakeC virtual machine written in C.

Resources

• State-of-the-art QuakeC compiler.
• FTEQCC reference manual.
• Kaitai Struct definitions file for the QuakeC "progs" format.
• QuakeC highlighting for VS Code by VictorF.
• QuakeC highlighting for VS Code by joshuaskelly.
• InsideQC tutorials.
• QuakeC tutorials at quakewiki.org.
• QuakeC Reference Manual.

Usage

• USAGE.md

Contact

• Discord
• Email

Todo

• Dump user-added builtin functions to properly formatted QC file.
• Add support for HexenC and FTEQCC's extended opcodes.
• Add support for the QTest progs format.
• Bindings for other languages.
• Add formatted string return function.
• Split up qcvm_utils.c into seperate files for easier browsing and modification.
• Keep USAGE.MD updated.
• Add support to automatically compile QuakeC by calling FTEQCC.
• Convert exports to an allocated pointer, for easier conversion to Pascal.
• Add more examples and a robust framework for inter-module communication.
• Shove the whole thing in one header, STB style.

Feedback

• Hacker News (February 6th, 2023)

License

MIT License

Copyright (c) 2023 erysdren (it/she)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.