Skip to content
RedEgs edited this page Feb 6, 2024 · 10 revisions

PyRedEngine

PyRedEngine is a small and performant engine made with pygame used for getting small games up and running quickly with little coding experience, useful for prototyping menu's or simple game mechanics for larger systems like unity or unreal games.

Don't take this project too seriously as this was intended for use with all my mini pygame projects.

Installation

  1. Install the engine from PyPi/PiP. (Make sure its the right version).
    pip install pyredengine
  1. Locate to the directory where you would like to setup the project. It will create a new folder based of off the template repo. If the command fails either you have typed it wrong, the installation has failed or you don't have git installed.

Alternatively, you can clone the template repository, Here

    pyredengine-newproject
  1. Open config.json and configure settings any settings for the project, such as the window name and resolution. Settings such as the window res can be controlled from in-game but mainly through janky or unorthodox methods, although i'll cover how to do that elsewhere.
{
    "app": {
        "settings": {
            "resolution": "1280x720",
            "v-sync": 0,
            "max-fps": 60,
            "window-title-name": "Template Window",
            "window-icon-path": "",
            "start-scene": "example_scene"
        }
    }
}
  1. Now that you have installed the example template, you should launch the game from the bat file and you should see, a solid blue window like this. If you do not see a bluescreen and you see a red or a black screen, either reinstall the package, git pull from the template repo, manually clone the repo or reinstall the whole project all together.

image

Clone this wiki locally