Getting Started

The strength of your server shapes the future of your game. Build it with purpose, and watch your vision come to life.

Setting up Altruist is simple and modular. You can install the core framework and extend it with game-specific packages based on your needs.

Note: Altruist is in its early development phase, meaning support for different game genres is still evolving. The goal is to provide broad support across various game types, with the flexibility to combine multiple genres to fit your specific game design.

Install Altruist

To get started, install the core Altruist package in your .NET project.

1
Step 1: Add Altruist to Your Project

Install the Altruist framework using the .NET CLI:

dotnet add package Altruist
2
Step 2: Add Gaming Support (Optional)

If you're building a game server, install the Altruist.Gaming package:

dotnet add package Altruist.Gaming

Note:

This package provides the essential building blocks for game development, allowing full customization to suit your needs.

If you're happy with the core features or community-driven extensions, continue reading to explore options tailored to specific game genres.

3
Step 3: Choose Your Game Genre

Altruist aims to support multiple game genres. You can install the relevant package for your project, and even combine multiple genres for hybrid gameplay experiences.

For RPG-based games:

dotnet add package Altruist.Gaming.RPG

For shooting-based games (like FPS):

dotnet add package Altruist.Gaming.Shooter

Note:

Combining Genres: You can mix multiple genre packages to create hybrid game experiences. For example, combining Altruist.Gaming.RPG and Altruist.Gaming.Shooter allows for an RPG with FPS mechanics.

To read more about the starter packs follow the Plug And Play section

Now you are ready to start your journey with your Altruist-powered game server. Read the Quick Start Guide, to see how to setup a simple server.