repository·main·Indexed 12 days ago
https://github.com/kitao/pyxelA retro game engine for Python designed for creating pixel-art-style games. Pyxel uses simplified specifications inspired by retro consoles, including a fixed 16-color palette and support for up to 4 simultaneous sound channels. Version 2.9.9 includes comprehensive APIs for audio playback (pyxel.play, pyxel.playm), input handling (btn, btnp, btnr), graphics constants, and optimized math and noise functions.
Pyxel is a retro game engine for Python designed for creating pixel-art-style games. It uses simple specifications inspired by retro gaming consoles to limit scope and ease development, such as:
Pyxel is open source under the MIT License.
The Pyxel Editor consists of four specialized editors that can be switched using buttons at the top of the screen:
Pyxel maintains high standards for code documentation and comments.
Commenting Guidelines:
i += 1 # increment i.// Constructors) without a trailing period. For multi-sentence comments, punctuate every sentence.///, Python docstrings, JSDoc) are prohibited everywhere except in python/pyxel/__init__.pyi. The .pyi docstrings are automatically regenerated via scripts/generate_pyi_docstrings and should not be hand-edited.Prose Documentation:
「Web 版 Pyxel」).In Pyxel, certain operations are identified as 'hot paths' where performance is critical. Developers must eliminate avoidable costs in these areas.
Identified Hot Paths:
Optimization Rules:
Vec::new, format!, Box::new), avoidable copies, type conversions, or missed SIMD/inlining opportunities.for loops) over micro-optimizations.Pyxel follows strict naming and consistency rules to maintain a unified API across different languages (Rust, Python, Web).
Key Naming Principles:
pyxel-core must match its name in the Python .pyi stub). If variants are needed, use suffixes (e.g., gen_bgm_mml) rather than renaming.Canvas.drawCanvas())..pyi stub, the .pyi is authoritative.crates/pyxel-binding/src/*_wrapper.rs: These files intentionally mirror the Python API (using snake_case and Pyxel-historical names like blt or cls) rather than following Rust conventions.python/pyxel/examples/): May use local names to improve readability for learners.Pyxel separates logic and rendering into two distinct functions:
update: Called every frame to handle game logic.draw: Responsible for rendering. This function may be skipped if the processing time exceeds the allowable limit.This design ensures that even if rendering load or OS interrupts increase, the game logic (via update) remains consistent, enabling smoother animation.
The manifest.tsv file tracks the dependency graph of the audit artifacts. The graph is acyclic and follows these specific edges:
target_files.tsv and current-diff.patch are roots.freeze.json depends on both roots.criteria.tsv and policy_coverage.tsv depend on freeze.json.scope.tsv depends on target_files.tsv, criteria.tsv, and policy_coverage.tsv.relations.tsv, hot_paths.tsv, and commands.tsv depend on criteria.tsv and scope.tsv (and current-diff.patch for change-driven inventories).applicability.tsv depends on criteria.tsv, scope.tsv, relations.tsv, hot_paths.tsv, and commands.tsv.checks.tsv depends on applicability.tsv and commands.tsv.coverage_balance.tsv depends on criteria.tsv, applicability.tsv, and checks.tsv.findings.tsv depends on checks.tsv and coverage_balance.tsv.Evidence provided in an audit is only considered substantive if it meets the following criteria:
no issue, checked, or matches policy.Important Distinction: Search output, inventories, formatter success, test success, finding counts, and reviewer summaries are considered probes or command evidence, not findings. A finding must identify the current source or artifact row, criterion, actionable defect, and relevant peer or dependency evidence.
A .pyxres file is a ZIP archive containing a single TOML file named pyxel_resource.toml. This file stores all game assets: images, tilemaps, sounds, and music.
File Structure:
example.pyxres (ZIP archive)
└── pyxel_resource.tomlAn optional palette file (.pyxpal) can be placed in the same directory to define a custom color palette.
The Coding Policy Audit Procedure is an execution protocol used to prove that docs/coding-policy.md has been checked completely and evenly. It is not a set of standards itself, but a method to verify compliance with the standards defined in the policy.
Key Principles:
update function is called every frame. However, the draw function may be skipped if the processing time exceeds the allowed limit. This design helps mitigate the impact of rendering load and OS interrupts, ensuring smoother animations.kitao.pyxel-vscode.