Skip to main content

An Offical CLI library for VertexEngine.

Project description

VertexEngine-CLI

VertexEngine CLI adds CLI support to VertexEngine. Commands: python -m vertex init game - provides a game template python -m vertex build [path] - build an exe with 2 flags: --onefile, --windowed

How to install Pyinstaller

Step 1. Type in: pip install pyinstaller

Step 2. Wait a few min, don't worry if it takes 1 hr or more, it will finish

Step 3. How to use pyinstaller type: python -m PyInstaller --onefile *.py

There are flags: --noconsole > disables the console when you run the app --onefile > compress all of the code into one file --icon > the *.ico file after you type it will be set as the app icon.

How to install VertexEngine/Vertex:

Step 1: Type in pip install VertexEngine-CLI

Step 2: Wait a few min, don't worry if it takes 1 hr or more, it will finish

Step 3: Where to start? Read the documentations. Also copy the following template:

from VertexEngine.engine import GameEngine from VertexEngine import VertexScreen from VertexEngine.audio import AudioManager from VertexEngine.scenes import Scene import pygame import sys from PyQt6.QtGui import QIcon from PyQt6.QtWidgets import QApplication

class Main(Scene): def init(self, engine): super().init(engine) self.width = engine.width self.height = engine.height

def update(self):
    pass

def draw(self, surface):
    VertexScreen.Draw.rect(VertexScreen.Draw, surface, (0, 255, 0), (-570, 350, 5000, 500))

if name == 'main': app = QApplication(sys.argv) # <- create app engine = GameEngine(fps=60, width=1920, height=1080, title="Screen.com/totally-not-virus") # <- initialize a1080p window at 60 FPS

engine.setWindowTitle('Screen.com/totally-not-virus') # <- name the app
engine.setWindowIcon(QIcon('snake.ico')) # <- icon
engine.show() # <- show window

main_scene = Main(engine) # <- intialize the scene
engine.scene_manager.add_scene('main', main_scene) # <- name scene
engine.scene_manager.switch_to('main') # <- switch to the main scene pls

app.exec()

The following template creates a window with a green rectangle (the ground.)

Pygame or PyQt6 systems are compatible with Vertex so you can use pygame collision system or PyQt6's UI system in VertexEngine.

Help

The documentation is in the following link: Project Documentation for help.

Dependencies

Vertex obviously has heavy dependencies since it's a game engine, the following requirements are:

Dependency Version
PyQt6 >=6.7
Pygame >=2.0
Python >=3.10

About Me ❔

I Am a solo developer in Diliman, Quezon City that makes things for fun :) 77 Rd 1, 53 Rd 3 Bg-Asa QC Email: FinalFacility0828@gmail.com

📄 License

VertexEngine/Vertex is Managed by the MIT License. This license allows others to tweak the code. However, I would like my name be in the credits if you choose this as your starting ground for your next library.

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

vertexengine_cli-1.0.1.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

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

vertexengine_cli-1.0.1-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file vertexengine_cli-1.0.1.tar.gz.

File metadata

  • Download URL: vertexengine_cli-1.0.1.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.13.9

File hashes

Hashes for vertexengine_cli-1.0.1.tar.gz
Algorithm Hash digest
SHA256 2f987a04756eaaaf0104092b1cc7480cad40f81bfaf1c2bafbb0d1d4fccc8dbf
MD5 3100629ecdf2ce4ba222ddd9376344cd
BLAKE2b-256 9bc4f58adba02d112e0cb8888bd03aa6cac11f69b949d2029db18613f43865bf

See more details on using hashes here.

File details

Details for the file vertexengine_cli-1.0.1-py3-none-any.whl.

File metadata

File hashes

Hashes for vertexengine_cli-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4e515b5986328507b5d350c14ca89dc010ded346747de551ab16c8c44e23f18c
MD5 4e948689b11d005a01e5dc1e6f786b05
BLAKE2b-256 c0769fada9985ff4c3efd3b0dd42bfe24abdbada1b248115a34a19f83a72b9b8

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