Skip to main content

A neat little thing... with nightly updates

Project description

miniform Logo

Miniform

Version
GitHub Stars License
Build

What?

miniform is a game development framework designed to help developers create more with less hassle. It provides a structured foundation for handling Worlds, objects, UI, input, and rendering, so you can focus on making games instead of reinventing the wheel.

Why?

  • Save Time – No need to build a game structure from scratch.
  • Better Organization – Worlds, assets, and objects are neatly managed.
  • Pygame, but Better – All the flexibility of Pygame, with added convenience.

Content?

  • Modularity – Manage your game with a clean and modular API.
  • World & Object Management – Easily define and swap worlds.
  • Custom UI System – Interface-scripting made simple.
  • Asset Loading – Load sprites and animations efficiently.
  • Input Handling – Keyboard and mouse events with built-in support.
  • Partitioning Systems – Efficient object management for game worlds of any size.

Download?

Install miniform via pip:

pip install miniform

Getting Started?

After youv'e installed miniform go ahead and create a script named main.py somwhere and paste in the following code:

import miniform

class MyGame(miniform.app.MiniApp):
    def __init__(self) -> None:
        super().__init__(
            title = "My Game",
            window_size = [800, 600],
        )

    def init(self) -> None: pass
    def exit(self) -> None: pass

    def update_hook(self, dt: float) -> None: pass
    def render_hook(self) -> None: pass

if __name__ == "__main__":
    MyGame().run()

| NOTE: The methods init(), exit() must be defined for any instance of MiniApp; a NotImplementedError is raised otherwise.

Above is the minimal code needed to get a simple MiniApp up and running. From here you can explore the MiniWorld and the other classes provided in miniform.core.resource and miniform.core.resource.interface.

Contributions?

Want to help improve miniform? Feel free to contribute by submitting issues, suggesting features, or making pull requests!

License

miniform is open-source under the MIT License.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

miniform-0.1.0.tar.gz (37.4 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

miniform-0.1.0-py3-none-any.whl (44.9 kB view details)

Uploaded Python 3

File details

Details for the file miniform-0.1.0.tar.gz.

File metadata

  • Download URL: miniform-0.1.0.tar.gz
  • Upload date:
  • Size: 37.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for miniform-0.1.0.tar.gz
Algorithm Hash digest
SHA256 6f95e7dcd3dc92f56d8f3bb7dd4bcbc5a2308a1325a36ad9b553cd31128bbf8e
MD5 38210bcb85e48fdae9ae8a4b147de2bb
BLAKE2b-256 6e185a2163ee8f56d17bc566668f02abed29b7f4bf0bddec8678b5438264a6f0

See more details on using hashes here.

File details

Details for the file miniform-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: miniform-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 44.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.1

File hashes

Hashes for miniform-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 8f343da449c4137d3f65f8ad8d39471c5aca073b31ce2b0f2a6cedbfa565de65
MD5 d32aecb9d3f9ecc18796f02cb64d9d1b
BLAKE2b-256 08210b7202f563491070ffd0e87bbbee3a47371af1276958236e3af29bff7516

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page