Initial commit

.gitignore

@@ -0,0 +1,176 @@
+# ---> Python
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/latest/usage/project/#working-with-version-control
+.pdm.toml
+.pdm-python
+.pdm-build/
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+

README.md

@@ -0,0 +1,19 @@
+# BaseGame
+
+A template that all games should be based on.
+
+The idea is this will make it easier to integrate with [The Pain Jam Launcher](https://git.personal.imadumbass.dog/PainJam/PainJamLauncher).
+
+I have no idea how templates work so we just kinda balling with this one, team.
+
+## Usage
+
+This template contains the following files:
+
+`__init__.py`: Your actual game code.
+
+`__main__.py`: The standalone launcher. This should not be changed as this file is not ran when using an external launcher.
+
+`game.toml`: Stores information about your game
+
+For more information about how to use each of these files, check the documentation within each file.

__init__.py

@@ -0,0 +1,39 @@
+import logging
+import pygame
+#import NoPELib
+#import PDOLib
+
+class Game:
+    def __init__(self, surface, size):
+        """
+        Ran when the game starts.
+
+        Args:
+            surface (pygame.Surface): The surface you draw to.
+            size (list[int, int]): The size of the surface.
+        """
+
+        pygame.init()
+        self.surface = surface
+        self.size = size
+
+    def onEvent(self, event):
+        """
+        Ran when an event is fired.
+
+        Args:
+            event (pygame.Event): The event that was fired
+        """
+        pass
+    
+    def draw(self):
+        """
+        Ran once per frame, put your drawing code in here
+        """
+        pass
+
+    def close(self):
+        """
+        Ran when the game closes
+        """
+        pass

__main__.py

@@ -0,0 +1,58 @@
+# Import the game code
+import __init__
+
+import argparse
+import tomllib
+import pathlib
+import pygame
+import os
+
+# Store the current working directory
+# This is used to revert the cd change
+originalCWD = os.getcwd()
+
+# Get the path of the game
+basePath = pathlib.Path(__file__).parent.resolve()
+
+# Set the current working directory
+# to the base path of the game
+os.chdir(basePath)
+
+# Load the game.toml data
+with open('game.toml', 'r') as f:
+    gameData = tomllib.loads(f.read())
+
+# Parse command line arguments
+parser = argparse.ArgumentParser(prog=gameData['name'])
+parser.add_argument('-sw', '--width', type=int, default=1280)
+parser.add_argument('-sh', '--height', type=int, default=720)
+parser.add_argument('-f', '--fullscreen', action='store_true')
+args = parser.parse_args()
+
+# Initialise screen
+flags = 0
+if args.fullscreen: flags |= pygame.FULLSCREEN
+screen = pygame.display.set_mode((args.width, args.height), flags)
+pygame.display.set_caption(gameData['name'])
+
+# Initialise game
+game = __init__.Game(screen, screen.size)
+
+# Set to False when the game should exit
+run = True
+
+while run:
+    # Event loop
+    for event in pygame.event.get():
+        if event.type == pygame.QUIT:
+            run = False
+        
+        game.onEvent(event)
+    
+    # Draw loop
+    game.draw()
+
+# Clean up
+os.chdir(originalCWD)
+game.close()
+pygame.quit()

game.toml

@@ -0,0 +1,8 @@
+# The ID used for logging
+# TODO: Filter things like '\', '{}', '\n' etc.-
+id = "changeMe"
+# The name used for setting the windows
+# title, and for displaying in the launcher
+name = "Change me"
+# The description displayed by the launcher
+description = "Write something about this game.\nNew lines are supported."

requirements.txt

@@ -0,0 +1,3 @@
+#../NoPELib/
+#../PDOLib/
+pygame-ce