John Alanbrook
708a112449
Some checks failed
Build and Deploy / build-macos (push) Failing after 9s
Build and Deploy / build-windows (CLANG64) (push) Has been cancelled
Build and Deploy / package-dist (push) Has been cancelled
Build and Deploy / deploy-itch (push) Has been cancelled
Build and Deploy / deploy-gitea (push) Has been cancelled
Build and Deploy / build-linux (push) Has been cancelled
28 lines
1.4 KiB
Markdown
28 lines
1.4 KiB
Markdown
# AGENTS.md
|
|
|
|
## Project Overview
|
|
This is a game engine developed using a QuickJS fork as its scripting language. It is an actor based system, based on Douglas Crockford's Misty. It is a Meson compiled project with a number of dependencies.
|
|
|
|
## File Structure
|
|
- `source/`: Contains the C source code
|
|
- `scripts/`: Contains script code that is loaded on executable start, and modules
|
|
- `shaders/`: Contains shaders that ship with the engine (for shader based backends)
|
|
- `benchmarks/`: Benchmark programs for testing speed
|
|
- `tests/`: Unit tests
|
|
- `examples/`: Contains full game examples
|
|
|
|
## Coding Practices
|
|
- Use K&R style C
|
|
- Use as little whitespace as possible
|
|
- Javascript style prefers objects and prototypical inheritence over ES6 classes, liberal use of closures, and var everywhere
|
|
|
|
## Instructions
|
|
- When generating code, adhere to the coding practices outlined above.
|
|
- When adding new features, ensure they align with the project's goals.
|
|
- When fixing bugs, review the code carefully before making changes.
|
|
- When writing unit tests, cover all important scenarios.
|
|
|
|
## Compiling, running, and testing
|
|
- To compile the code, run "make", which generates a prosperon executable in build_dbg/, and copy it into the root folder
|
|
- Run a test by giving it as its command: so ./prosperon tests/overling.js would run the test overling.js, ./prosperon tests/nota.js runs the nota benchmark
|