README.md

Avocado2D

PROJECT CANCELLED

Avocado2D is a type of gameengine for MonoGame.

This project is work in progress.

Roadmap:

• Entity-Component-System (WIP)
• SceneManager
• Collider (WIP)
• Collision-Detection (WIP)
• InputManager (WIP)
• SoundHandling
• Network
• TileMap
• Simple UI-System

Basics

Create a Scene

// AvocadoGame.cs
var myScene = new Scene("MyScene", this);
SceneManager.AddScene(myScene);

// draws the scene
SceneManager.SetActiveScene("MyScene");

You can also inherit from the scene-class.

public class MainMenu : Scene
{
  // do your stuff in the scene.
}

Create a Entity

var player = new Entity("Player");

// add some components to the entity 
player.AddComponent<PlayerController>();
var healthComponent = player.AddComponent<HealthComponent>();
healthComponent.Health = 100;

// removes a component from the entity
player.RemoveComponent<HealthComponent>();

// assign the entity to the scene
myScene.EntityManager.Add(player);

// get an entity from the scene
var player = myScene.EntityManager.Get("Player"); // by name
var enemy = myScene.EntityManager.Get(1); // by id -> it's faster

Create a custom component

A simple data-holding component (no logic)

public class MyFancyComponent : Component
{
    public int FancyValue { get; set; }
}

A behavior (logic) component:

public class MyFancyComponent : Behavior
{
    public int FancyValue { get; set; }
    
    // modify an other component
    public override OnInitialize()
    {
        var otherComponent = Entity.GetComponent<OtherComponent>();
        otherComponent.MovementSpeed = 20f;
    }
    
    public override void Update(GameTime gameTime)
    {
        FancyValue++;
    }
}

A drawable component (e.g. for gui stuff):

public class MyFancyButtonComponent : Drawable
{
    public override OnInitialize()
    {
        // ... 
    }
    
    public override void Draw(SpriteBatch spriteBatch)
    {
        // draw you stuff
    }
}

Which components are already implemented?

• Sprite
• Collider (WIP)
• AudioSource
• GUI-Stuff (Button, Canvas, etc)
• AnimatedSprite
• ...