Skip to content
This repository has been archived by the owner on Aug 20, 2022. It is now read-only.

Latest commit

 

History

History
90 lines (69 loc) · 4.42 KB

README.md

File metadata and controls

90 lines (69 loc) · 4.42 KB

Constellation-Engine

GitHub Repo stars GitHub watchers

GitHub top language Lines of code GitHub repo size

GitHub issues GitHub pull requests GitHub

GitHub release (latest by date) GitHub all releases

About Constellation-Engine

An extraordinarily performant game engine

The entire game engine's features will be able to run on an AMD A6-3420M APU, an 11 year old APU from AMD made for entry level laptops.

Compiling

On all supported Operating Systems (OS'), the first step is to download this repository

Linux

Open the folder in which Constellation Engine is on your system in your terminal and run the following commands depending on your distro

If you get a message containing "Y/n :" type in Y and hit enter.

Debian

On Debian, if this is your first compile of Constellation Engine run make debiandeps to install dependencies and make linux to compile :)

Arch

On Arch, the installation process is different based off if you're using Wayland or X11. To find out which one you're on, run echo $WAYLAND_DISPLAY. If it outputs nothing, you're on X11. If it outputs something like wayland-0 then you're on Wayland.

Wayland

On Wayland, if this is your first compile of Constellation Engine run make archwaylanddeps to install dependencies and make linux to compile :)

X11

On X11, if this is your first compile of Constellation Engine run make archx11deps to install dependencies and make linux to compile :)

macOS

Open the folder in which Constellation Engine is on your system in your terminal.

With brew

If you have brew installed, and this is your first compile of Constellation Engine, run make mac to compile. Enjoy :)

Without brew

If this is your first compile of Constellation Engine and you don't have brew installed, run make macdeps to install dependencies and make mac to compile. Enjoy :)

Windows

Visual studio

On Windows with Visual Studio, first install Visual Studio 2022 (if you haven't already), then download this repository, download the thirdparty tools needed to build on windows from the ConstellationGamesOrg github profile and make sure your folder structure looks like so:

  Programming Folder
    |
    |-> Constellation Engine
    |   |
    |   |-> (The project files)
    |
    |-> Thirdparty
    |   |
    |   |-> (The thirdparty files)

Then go into Constellation Engine and open ConstellationEngine.sln in Visual Studio 2022. :)

Command Prompt

On Windows without Visual Studio, first download g++ (if you haven't already), download this repository, download the thirdparty tools repository from the ConstellationGamesOrg github profile's "thirdparty" repository and make sure your folder structure looks like so:

  Programming Folder
    |
    |-> Constellation Engine
    |   |
    |   |-> (The project files)
    |
    |-> Thirdparty
    |   |
    |   |-> (The thirdparty files)

Now, open up the command prompt and type make windows. This will automatically compile + run the engine. Note: If you're wondering where the executable is, it's called ConstellationEngine.exe and lies in the root of the Constellation-Engine folder.

Bug Reporting

You can report bugs in the issues tab in the github repository.

Contributing

If you want to contribute, you can create a pull request so we can consider your contribution.

Please add your name and/or Github username to AUTHORS.md in your pull request.

Changelog

Please see CHANGELOG.md.