rmc-mingleton-godot

A plugin for the Godot Game Engine. Where singletons go to mingle! Create and access singletons of any base type.

MIT License

Stars
2
Committers
1

RMC Mingleton - (Godot Engine Plugin)

Where singletons go to mingle! Create and access singletons of any base type.

Rivello Multimedia Consulting offers this design pattern for the Godot Engine.

Create your projects with confidence, performance, and scalability.

Highlights

  • Does NOT require any autoload, interface, nor baseclass.
  • Compatible with nodes, resources, and classes.
  • Compatible with GDScript, C#, and C++

Table of Contents

  1. Getting Started
  2. Examples
  3. Theory
  4. Resources
  5. Credits

Getting Started

  1. Download this repo (*.zip or *.git)
  2. Save repo as [RepoName]
  3. Download DOTNET version of the Godot Engine
  4. Create/open a Godot Project
  5. Complete the Prerequisites steps from Godot C# Basics
  6. Create/open folder [ProjectName]/addons/
  7. Install any dependencies
    • Optional: gdUnit4 - Add if you want to run RMC's included unit tests. Project compiles with or without this plugin
    • Required: rmc-core-godot - Project requires this core functionality
  8. Copy folder from [RepoName]/addons/[PluginName] to [ProjectName]/addons/[PluginName]
  9. Create the C# Solution via Godot Menu → Project → Tools → C# → Create C# Solution
  10. Build the C# Solution via (🔨) Icon in upper right of editor (or Control-B)
  11. Activate the plugin via Godot Menu → Project → Project Settings → Plugins → [PluginName] → Enabled
  12. Enjoy!

Examples

Example01_Mingleton

Sample Subclass Mingleton API

Theory

The Singleton is a creational design pattern that lets you ensure that a class has only one instance, while providing a global access point to this instance.

Resources

  • Samuel Asher Rivello's Godot Portfolio - Articles, Repos, & Tips
  • Samuel Asher Rivello's Godot Template - Ideal starting point for new projects
  • Samuel Asher Rivello's Unity Article — Project Structure Best Practices - Ideal setup
  • Samuel Asher Rivello's Unity Article — C# Coding Standards - Naming, conventions, more!

Credits

Creator

  • Samuel Asher Rivello
  • Over 25 years XP with game development (2024)
  • Over 11 years XP with Unity (2024)

Contact

  • Twitter - @srivello
  • Git - Github.com/SamuelAsherRivello
  • Resume & Portfolio - SamuelAsherRivello.com
  • LinkedIn - Linkedin.com/in/SamuelAsherRivello <--- Say Hello! :)

License

  • Provided as-is under MIT License
  • Copyright © 2024 Rivello Multimedia Consulting, LLC