Skip to content

Commit

Permalink
More docs, Google verification added, setup-requirement cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
NiklasDerEchte committed Nov 30, 2024
1 parent b4eb6fb commit fa01a9a
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 2 deletions.
8 changes: 8 additions & 0 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@
# For the full list of built-in configuration values, see the documentation:
# https://www.sphinx-doc.org/en/master/usage/configuration.html

html_title = "GameCore"
html_short_title = "GameCore"

html_meta = {
"google-site-verification": "I2IxJ6FXf5yD7T1OcSDMVSXwIqEZ0Aj2rHD70owkVGU"
}


# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information

Expand Down
15 changes: 15 additions & 0 deletions docs/getting-started/basics.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
Basics
======

Game engines are structured to provide a framework for creating and managing the various components of a game, such as rendering, physics, input, and scripting. The core idea is to streamline development by offering reusable systems and tools.

Start and Update Methods
^^^^^^^^^^^^^^^^^^^^^^^^

* ``Start Method``: Used for initialization logic. It runs once when an object is first created or activated in the game.
* ``Update Method``: Used for per-frame logic. It runs repeatedly, usually once per frame, and handles dynamic behaviors like movement or input processing.

Prefabs
^^^^^^^

Prefabs are preconfigured templates for game objects. They allow developers to create reusable objects with predefined properties, behaviors, and hierarchies, making it easier to replicate consistent objects throughout the game.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ Examples

getting-started/requirements
getting-started/external-tools
getting-started/basics
getting-started/how-to-use

.. toctree::
Expand Down
6 changes: 5 additions & 1 deletion requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,8 @@ pygame
perlin-noise
bridson
numpy
pytmx
pytmx

# <setup-skip> for docs
sphinx
sphinx-rtd-theme
9 changes: 8 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,14 @@

def parse_requirements(filename):
with open(filename, "r") as file:
return [line.strip() for line in file if line.strip() and not line.startswith("#")]
requirements = []
for line in file:
if line.strip() and not line.startswith("#"):
requirements.append(line.strip())
else:
if line.strip() and "<setup-skip>" in line.strip():
return requirements
return requirements

setup(
name="GameCore",
Expand Down

0 comments on commit fa01a9a

Please sign in to comment.