ScapeCore.Templates.CSharp 1.0.1

ScapeCore Game Engine

ScapeCore is your go-to free and open-source game engine riding on the MonoGame wave. It's like the Swiss Army knife for game devs – lightweight, modular, and just chill. In the future I'm planning on building a GUI Editor also, but for now on I'm mainly focusing on the Core, Backend and API.

Features

• Modular Design: Fully modular core, you are able to select and import the submodules you want to compile for your project. Any user could build his own submodules too, and import them on any future project.
• Event-Driven: Utilize events for flexible game loop customization.
• Entity System: Built-in entity component system through GameObjects and MonoBehaviours, easily extend functionality through a component-based architecture. Create your own Behaviours or Components.
• Serialize Like a Pro: Saving and loading game states got you stressed? Chill out with our Serialization Manager. It supports Protocol Buffers and even throws in optional GZip compression – slick and fast.
• Resource Wizardry: The Resource Manager is like a magician, juggling resources in a thread-safe show. Load, distribute, and track dependencies effortlessly. Keep your game running smooth and snappy.
• Scene Management: Easily add MonoBehaviours or GameObjects to a scene environment, and efficiently organize and transition between game scenes for a seamless player experience.
• ⚠️2D Physics Engine⚠️: This one is WIP, any contributions would be much apreciated.

Quick Start

1 Installation Methods

1. Using the installer

This installer uses bash, so it's a prerequisite having a compatible terminal available in your system, if you are working on Windows you may have some problems with this step. For that reason I recommend you to use WSL2 for a seamless integration with the OS. You can use the default WSL kernel provided by Microsoft or compile your own custom kernel.

The first step is to download the installer. For this purpose we can use one of the following methods.

• Download the installer using wget: wget https://raw.githubusercontent.com/Papishushi/ScapeCore/master/scapecore-installer
• Download the installer manually:
  1. Navigate to scapecore-installer.
  2. Inside the file display, click on Download Raw File.

Once you have the installer on your PC, you must move it to the directory where you want to locate ScapeCore installation. You can do this by using a command like mv or by moving the file manually using your file system.

Once you have found a directory for the installation, you can run your terminal and make sure to type the following commands:

sudo apt update
sudo apt upgrade

Make sure that you have at least python3.12 by running the following command:

python --version

If that's not the case use these commands, and press 'Y' when prompted:

sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt install python3.12

Also make sure that you have dotnet installed by running the command dotnet --version. If you dont have .NET SDK installed on your system you may want to take a look at dotnet-install.sh.

Once you are done, you are finally ready to use the installer, the syntax to use the installer is the following:

./scapecore-installer "module name" "another module name" ...

In this example only the basic ScapeCore is installed:

 ./scapecore-installer

For example, the following instruction would install basic ScapeCore if it is not already installed, as well as the submodules Tools and Serialization if they haven't been installed already:

 ./scapecore-installer Tools Serialization

2. Using the source code

The first step is to download the source code. For this purpose we can use one of the following methods.

• Download the source code using git:

  git clone https://github.com/Papishushi/ScapeCore.git
  

• Download the source code manually:

  1. Navigate to scapecore-installer.
  2. Inside the file display, click on Download Raw File.

Once you have a copy of the source code you can initialize the submodules by doing the following command:

git submodule update --init "submodule"

Where "submodule" is the name of the submodule you want to install. If you want to install all submodules just do not specify a submodule name.

If you have installed submodules you must manually modify the file ./Core/Core.projitems and append a new element under the <Compilation> tag for each .cs file on the submodule, using the following style: <Compile Include="$(MSBuildThisFileDirectory)Serialization/Serialization/Tools/StreamExtensions.cs" />

To end the installation process you must ensure that all dependencies are matched, you can use one of this methods to match dependencies:

• You can manually install all Dependencies using NuGet.

• You can also match project dependencies using the following dotnet command:

  dotnet restore ./Core/Core.csproj