8000 GitHub - ToniDevStuff/pyxora: A simple game engine made with Python and pygame-ce
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

ToniDevStuff/pyxora

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

pyxora

A simple game engine made with Python and pygame-ce

pyxora is a lightweight abstraction over libraries like pygame-ce and others. It's designed to serve as a simple, open-source game engine for building 2D games.

Note: The project is still in early development. It is not recommended for complex project/games at this stage.


Getting Started

📥 Installation

There is no official build or package on PyPI yet. To use pyxora, you must install it from the source.

  1. Install Python 3.11+

  2. Download the source files from the Releases page

  3. Open your terminal at the source directory

  4. Run:

    python -m pip install -e .

🎮 New Project

There is no project manager yet.
To create a new project using pyxora, it is recommended to check the syntax and structure used in the example files.

📚 Documentation

The documentation is built using pdoc.
It provides an overview of the engine modules and how they work.

It is recommended to read the documentation at least once to understand the engine’s structure and usage.
📄 View Documentation

🧪 Examples

Check the examples folder for some examples with a syntax showcase. Currently, only a basic test example is included:

python -m pyxora.examples.test

❓ FAQ

🧐 Who Is It For?

pyxora is ideal for small-scale projects that don’t require heavy processing.
Perfect for:

  • Learning and experimentation
  • Prototyping
  • Game jams
  • Any small 2D game

❓ Why Python?

Because it's fun and easy to learn/use.

👨‍💻 Should I Use It?

If you find pyxora interesting or useful in any way, feel free to use it!
It's open-source and designed to be easy to explore and experiment with.

🚧 Cross-Platform

The engine is available for use on Windows and Linux, with build support (not yet) for these platforms and Web.
In the future, there may be support for Android and Mac.

📦 Will It Be On PyPI?

It will be available when it becomes more usable.
Currently, the only way to use pyxora is by installing it from the source.

🖥️ Will It Have a GUI?

It’s planned, but not available yet. (The main focus is building the core engine.)
The engine is designed to focus on writing code rather than using a GUI.

The GUI will serve more as visual assistance.

🙋‍♂️ Can I Contribute?

Absolutely! Contributions are welcome.
You can:

  • Suggest improvements
  • Report bugs
  • Submit pull requests
  • Fix typos or write examples

pyxora started as a personal project for my own games.
And afterwards, i decide to make it open-source.

All changes are managed by the original author.
Need something different? Feel free to fork the project and make it your own.

If you have any questions or need something more specific, you can contact the author.


✅ TODO

  • Refactor all local drafts
  • Add more basic features
  • Improve engine structure
  • Create Icon
  • Publish to PyPI
  • more...

📝 License

This project is licensed under the MIT License.
See the LICENSE.txt file for full license text.

About

A simple game engine made with Python and pygame-ce

Topics

Resources

License

Stars

Watchers

Forks

Languages

0