Skip to main content

A window and UI library based on tkinter.

Project description

InGame 🎮

InGame is a lightweight Python library designed to simplify making amazing UIs within a basic GUI window using tkinter. It enables developers to easily register and trigger events based on key presses with clean, decorator-based syntax.


✨ Features

  • ✅ Decorator-based event binding
  • ✅ Enum-based key recognition (A–Z, arrows, Enter, Escape, etc.)
  • ✅ Clean and extensible architecture
  • ✅ Simple GUI rendering using tkinter

🚀 Getting Started

🔧 Installation

Use pip install ingame to install the project.


🧠 Usage Example

from ingame.core import InGame, Screen, EventType
from ingame.objects import Text, Button, Input

app = InGame()

@app.event(type=EventType.Key.A)
def handle_a():
    print("Key A pressed!")

@app.event(type=EventType.Key.ESCAPE)
def handle_escape():
    print("Escape pressed!")
    screen.quit()

screen = Screen(app, title="My InGame App", width=600, height=400)

screen.set_resize(True, True)

hello_text = Text(screen, text="Hello!")
Button(screen, text="Click me", command=hello_text.destroy)

ht_input = Input(screen, packargs={"pady": 10})

def ht_click() -> None:
    print(ht_input.get())

Button(screen, text="Print input value", command=ht_click, packargs={"pady": 10})



screen.show()

🎮 Supported Keys

Supported via EventType.Key, including:

  • A–Z
  • Arrow keys: UP, DOWN, LEFT, RIGHT
  • ENTER, ESCAPE, BACKSPACE

📦 Components

InGame

Handles registering and triggering events:

  • @event(type: EventType.Key): Registers a function for a specific key event.
  • trigger_event(type): Manually triggers an event.

Screen

Simple tkinter window with key event binding:

  • show(): Opens the window and starts listening for key presses.
  • quit(): Closes the window.

⚠️ Exceptions

  • InGameException: Raised for invalid usage such as missing event type or unregistered keys.

🛠️ Development Notes

Written in Python 3.10+ Uses tkinter, Enum, and inspect.


📄 License

MIT License


❤️ Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you’d like to change.


👤 Author

Made with ❤️ by Natuworkguy

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

ingame-0.3.9.tar.gz (6.3 kB view details)

Uploaded Source

Built Distribution

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

ingame-0.3.9-py3-none-any.whl (6.2 kB view details)

Uploaded Python 3

File details

Details for the file ingame-0.3.9.tar.gz.

File metadata

  • Download URL: ingame-0.3.9.tar.gz
  • Upload date:
  • Size: 6.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ingame-0.3.9.tar.gz
Algorithm Hash digest
SHA256 7bf9c967cf76eef9adbea5f9f53fef3822299034f1b1dd37979ae573a9a0cbf4
MD5 7100e667cd0bb5de99bc6581b508b66e
BLAKE2b-256 2d3a08c3d68739f974d2a8e4fef244acc61cab13cded0054be117fb0a631bab9

See more details on using hashes here.

File details

Details for the file ingame-0.3.9-py3-none-any.whl.

File metadata

  • Download URL: ingame-0.3.9-py3-none-any.whl
  • Upload date:
  • Size: 6.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for ingame-0.3.9-py3-none-any.whl
Algorithm Hash digest
SHA256 30db78b079b418813738b436e839517782ff2311588e944f4ed173a67f3004c6
MD5 6366bdf5336e81dcffccc4d8e380bbce
BLAKE2b-256 970df01ace77802e6421d500189ba85635631072780b86b33672c49d7c7706d6

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