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.1.tar.gz (38.7 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.1-py3-none-any.whl (46.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: miniform-0.1.1.tar.gz
  • Upload date:
  • Size: 38.7 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.1.tar.gz
Algorithm Hash digest
SHA256 c8f0f9561babb65a65befb651f20bcb0c8af1b5f83a09639524bb6944de6aabe
MD5 caf6e6f9f008274795e4cb28598f3141
BLAKE2b-256 5d6077cb2ec03343c115e6d062a6192e360394301db522762ec57d866f67a340

See more details on using hashes here.

File details

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

File metadata

  • Download URL: miniform-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 46.2 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 e52602644f8f2710b855cee116c0adb86ad2323f226f562d0592206b040ee292
MD5 6b1d9eb2a0e033e69a3e68eae9f1ccf5
BLAKE2b-256 0ada525d881233f1aaf23eb4f459e8d0211233c0f68ba6a183467f9c2c33f5e7

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