🧼
Soap - 3.5.1
  • Getting Started
    • What is Soap?
    • Why use Soap?
    • Where to get Soap?
  • Soap Core Assets
    • Scriptable Variable
      • Properties
      • Debugging
      • Variable Reference
      • Runtime Variables
      • FAQ
    • Bindings
    • Scriptable List
      • Properties
      • Callbacks
      • FAQ
    • Scriptable Event
      • Properties
      • Debugging
      • FAQ
    • Event Listener
      • Properties
      • Dynamic Binding
      • FAQ
    • Scriptable Enum
      • Creating new Enum Values
      • Adding Data
    • Scriptable SubAssets
      • Creating/Deleting SubAssets
      • Accessing SubAssets
      • FAQ
    • Scriptable Save
      • Properties
      • FAQ
    • Scriptable Dictionary
      • Properties
      • Callbacks
      • Custom Dictionary Creation
      • FAQ
    • Runtime Injectors
  • Useful Tips
    • Creating Soap ScriptableObjects
      • Soap Asset Creator
      • From Create Shortcut
      • Default Unity Create Menu
    • Using Tags
      • AutoTag Attribute
    • Finding References
    • Editor Fast Play Mode
    • Addressables
      • Solutions
  • Custom Windows
    • Soap Wizard
      • Shortcuts
    • Soap Window
      • Settings
    • Soap Type Creator
    • Soap Asset Creator
  • Quality
    • How to extend Soap?
    • Performance
    • Integration with other assets
    • Games using Soap
    • Suggestions
  • Scene Documentation
    • 1_ScriptableVariables
      • Direct Access
      • OnValueChanged Event
      • Variable Reference
      • Solving Dependencies
      • Saving Variable Values
      • Save Exercise
      • Menu Context Option
    • 2_Bindings
      • BindText/TextMeshPro
      • BindFillingImage
      • BindSlider
      • BindToggle
      • BindGraphicColor
      • BindRendererColor
      • BindComparisonToUnityEvent
      • BindInputField
    • 3_ScriptableLists
      • Adding & Removing Elements
      • Callbacks
      • Auto Clearing
      • Iteration
    • 4_ScriptableEvents
      • Firing Events from code
      • Event Listeners
      • Registering to events from code
      • Firing events from the editor
      • Debugging
    • 5_ScriptableSaves
      • Save Data
      • Useful Methods
      • Save/Load Modes
      • Save Reader
      • Save Manager
      • Save Version
    • 6_ScriptableEnums
      • Scene Setup
      • How does it work?
      • Additional Data
      • Exercise
    • 7_ScriptableSubAssets
      • Scene Setup
      • Direct Reference
      • Indirect Reference
    • 8_RuntimeVariables
      • Manual Injection
      • Flexibility
      • Automatic Injection
    • 9_ScriptableDictionaries
      • Scene Set up
      • Adding & Removing Elements
      • Callbacks
      • Custom Inspector
Powered by GitBook
On this page
  1. Getting Started

What is Soap?

NextWhy use Soap?

Last updated 3 months ago

First of all, thank you for purchasing Soap 😊. Soap was made to simplify game development. It aims to be easy to understand and to use, making it useful to both junior and senior game developers.

Soap leverages the power of ScriptableObjects which are native objects from the Unity Engine, to create a set of tools that enables you to build your game in a simple, modular and reusable manner.

ScriptableObjects are assets that can contain code. They can be referenced by other assets and are accessible at runtime and authoring time. ScriptableObjects are commonly used only for data storage, however they can do much more. Soap builds on top of them to exploit their full potential.

If you want to know more about this idea, I strongly suggest .

Soap was created mostly while developing casual games. Because of the nature of these games, Soap focuses on speed and simplicity. Nevertheless, Soap is great at forcing you to decouple your code (avoiding dependencies) and helping you to create modular and reusable systems. Therefore, it can be used in any type of games, simple or complex, small or big.

The package contains a small set of example scenes to quickly show how to use this framework. Each scene has its own specific documentation. On top of this, there are 6 step-by-step tutorial videos to help you to create a Roguelike game with Soap:

For any questions or suggestions please ask on !

the talk of Ryan Hipple
https://www.youtube.com/@obviousgame/
Discord