Skip to main content

Terminal Game Maker

Project description

Workflow Status

Pylint
Lint with Isort
Safety Linting
SHA256 Generate and Update
Static Badge

C++ Linting isnt Github made, because I look for certain errors, and report back to here if it worked or not.
Clang Tidy doesn't know how it should work.

Installing

To install, run pip install pyTGM
You may need Python3-dev. You need Microsoft Visual Studio
When setting up Python, enable these:

  • Add Python to PATH
  • Customize installation > Development Tools

On macOS, you will need homebrew to install Python:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Then, run

brew install python

On Linux, your OS will change the command you need to run:
Debian/Ubuntu:

sudo apt-get update; sudo apt-get install -y python3-dev

Fedora:

sudo dnf install -y python3-devel

Arch linux:

sudo pacman -S python

Dont know what OS you have? Run this command:

bash -c 'if command -v apt-get >/dev/null; then sudo apt-get update && sudo apt-get install -y python3-dev; elif command -v dnf >/dev/null; then sudo dnf install -y python3-devel; elif command -v pacman >/dev/null; then sudo pacman -Sy python; elif command -v zypper >/dev/null; then sudo zypper install -y python3-devel; else echo "Unsupported package manager. Install Python dev headers manually."; exit 1; fi'

pyTGM (Python Terminal Game Maker)

pyTGM is a simplified alternative to Pygame, focusing on ASCII and ANSI based game development, contained completley within the terminal,
with utilities for encryption, markup, mouse input, and much more.

It is MOST reccomended, that you download the latest version!

Bugs and Features

To report a bug, go here
For feature request, go here

Contributing

All contributions are greatly appreciated.
To make a contribution, make a new branch here
Then, add (or remove), to improve the repo!
Once we know it's working and safe, somebody will merge the request!

Features

File Operations

file.fm_line(name)           # Modify a line of a file

Graphics and Text Styling

# Clear screen
graphics.cls()

# Color text (RGB)
graphics.color(0, 255, 0)  # Green text
graphics.RESET             # Reset color

# Markup
graphics.BOLD
graphics.ITALIC
graphics.UNDERLINE

# Placing the cursor at a pair of coordinates
graphics.pos()

Sound Support

Works across Windows, macOS, and Linux:

# Play audio file
psound('../sounds/mysound.mp3')

Local Server Support

# Starting a server and client (PORT, message)
LocalServer(1080, {'MarkTheMighty':((243,332), 57)})

An example of a returned value would be:

{'LordMinion777':((0,0), 100), 'Muyskerm':((245,334), 43)}

Terminal Input Detection

# Mouse Click Detection
terd.click()             # A return value of (-1, -1) means the click was invalid!

# Keyboard Press Detection
terd.geky(times)

Encryption

# Set the table
b64.Table.table = 'ABCDEF...XYZ...12...90...!@..._+'
b64.Table.generate('ABCDEF...XYZ...12...90...!@..._+', 32)  # (table: str, times: int)

# Encode and decode
b64.encode(text)
b64.decode(text)

When setting the table, it MUST include the characters that are being stored at the very least! Extra characters are suggested for security.

Links

License

pyTGM is licensed under Bspace, created by Tokyn Blast.

4.0.0 (December 17, 2024)

  • Removed file.readChar
  • Major fixes to all variable in main init
  • Did an overhaul on Licence and README.md
  • major change in file structure
  • Renamed getch to geky
  • Put getch inside class "terd"
  • Added a click detection function
  • Updated and fixed all
  • Added init.py for an entry point
  • Moved all and links to init.py
  • Made functions satic methods
  • Changed how random works
  • Updated LocalServer error message
  • Added a To_send variable to LocalServer
  • Removed autoplay from frequency
  • Fixed windows key detection
  • Removed board and random
  • Added security hashes
  • Added badges to README.md

4.0.1 (Decmeber 17, 2024)

  • Import fixes

4.0.2 (December 17, 2024)

  • Click removed temporarily
  • Updated build in version

4.0.4 (December 17, 2024)

  • Import fixes
  • Replaced 4.0.3, as it is the same

4.0.5 (Decmeber 17, 2024)

  • Added back click

4.0.6 (Decmeber 17, 2024)

  • Added windows implementation of click
  • Fixed pybind11 missing module for pylint
  • Added C++ linting

4.1.0 (December 18, 2024)

  • Added *.txt to manifest.in
  • Added C++ badge to github
  • Updated licence
  • Fixed click bugs for windows
  • Distributed .tar.gz, instead of a .whl
  • Removed sound.generate()
  • Changed sound.play() to psound()
  • Changed mod_line() to fm_line()
  • Placed dummy functions for removed functions, that serve warnings

4.1.1 (December 19, 2024)

  • Fixed README.md
  • Forced warnings to occur
  • Added clarity to warnings
  • Moved b64 to encrypt
  • Added sha256
  • Changed psound importing

4.1.2 (December th, 2024)

  • Changed some Python files to C++
  • Changed file_mod to Python
  • Bug fixes

Conversion to C++

This was done for both speed, and to help me learn C++, for future projects and updates. This change will occur to almost every file in pyTGM, slowly over time. Some may stay the same for a while, untill my skill base for C++ is large enough, to change everything to C++

file_mod Conversion to Python

This happened, because as a C++ file, it was returning errors, that I wasn't capable of decoding, with my little knowledge of C++

psound

psound is now a C++ function. It now determines the OS, and decides which command to run. Rather than using a dependency, it uses something that each OS comes with for C++

Extra notes

v4.1.2 has the shortest change list... of ACTUAL updates. Some previous versions were an attempt to fix an import error, because I accidentally released an untested version. Now, I test the versions before release. And, the user base for pyTGM has been growing. Currently, at the time of release, there are 41 known users. The biggest bug I know of so far is that terd.click() detects all over the screen, rather than just characters inside the terminal. pyTGM is shaping up to be of some pretty good quality.

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

pytgm-4.1.2.tar.gz (17.3 kB view details)

Uploaded Source

File details

Details for the file pytgm-4.1.2.tar.gz.

File metadata

  • Download URL: pytgm-4.1.2.tar.gz
  • Upload date:
  • Size: 17.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.13.1

File hashes

Hashes for pytgm-4.1.2.tar.gz
Algorithm Hash digest
SHA256 f27f4172ab374e420fe6a02975ed531a0825d3abca504f9058b659fcb1bef2b0
MD5 d14685ceb4cadbba200df66d761a4dcf
BLAKE2b-256 99c40dd07fefea7a240cf769e7a176de3ce4ca35859bccbbb141f6626a3becac

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